/*
 * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.xml.ws.wsaddressing;


import org.w3c.dom.Element;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.annotation.XmlAnyAttribute;
import javax.xml.bind.annotation.XmlAnyElement;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.XmlValue;
import javax.xml.namespace.QName;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.ws.EndpointReference;
import javax.xml.ws.WebServiceException;
import java.util.List;
import java.util.Map;


This class represents a W3C Addressing EndpointReferece which is a remote reference to a web service endpoint that supports the W3C WS-Addressing 1.0 - Core Recommendation.

Developers should use this class in their SEIs if they want to pass/return endpoint references that represent the W3C WS-Addressing recommendation.

JAXB will use the JAXB annotations and bind this class to XML infoset that is consistent with that defined by WS-Addressing. See WS-Addressing for more information on WS-Addressing EndpointReferences.

Since:1.6, JAX-WS 2.1
/** * This class represents a W3C Addressing EndpointReferece which is * a remote reference to a web service endpoint that supports the * W3C WS-Addressing 1.0 - Core Recommendation. * <p> * Developers should use this class in their SEIs if they want to * pass/return endpoint references that represent the W3C WS-Addressing * recommendation. * <p> * JAXB will use the JAXB annotations and bind this class to XML infoset * that is consistent with that defined by WS-Addressing. See * <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/"> * WS-Addressing</a> * for more information on WS-Addressing EndpointReferences. * * @since 1.6, JAX-WS 2.1 */
// XmlRootElement allows this class to be marshalled on its own @XmlRootElement(name="EndpointReference",namespace=W3CEndpointReference.NS) @XmlType(name="EndpointReferenceType",namespace=W3CEndpointReference.NS) public final class W3CEndpointReference extends EndpointReference { private final JAXBContext w3cjc = getW3CJaxbContext(); // should be changed to package private, keeping original modifier to keep backwards compatibility
Addressing namespace.
/** * Addressing namespace. */
protected static final String NS = "http://www.w3.org/2005/08/addressing"; // default constructor forbidden ... // should be private, keeping original modifier to keep backwards compatibility
Default constructor.
/** * Default constructor. */
protected W3CEndpointReference() { }
Creates an EPR from infoset representation
Params:
  • source – A source object containing valid XmlInfoset instance consistent with the W3C WS-Addressing Core recommendation.
Throws:
/** * Creates an EPR from infoset representation * * @param source A source object containing valid XmlInfoset * instance consistent with the W3C WS-Addressing Core * recommendation. * * @throws WebServiceException * If the source does NOT contain a valid W3C WS-Addressing * EndpointReference. * @throws NullPointerException * If the {@code null} {@code source} value is given */
public W3CEndpointReference(Source source) { try { W3CEndpointReference epr = w3cjc.createUnmarshaller().unmarshal(source,W3CEndpointReference.class).getValue(); this.address = epr.address; this.metadata = epr.metadata; this.referenceParameters = epr.referenceParameters; this.elements = epr.elements; this.attributes = epr.attributes; } catch (JAXBException e) { throw new WebServiceException("Error unmarshalling W3CEndpointReference " ,e); } catch (ClassCastException e) { throw new WebServiceException("Source did not contain W3CEndpointReference", e); } }
{@inheritDoc}
/** * {@inheritDoc} */
@Override public void writeTo(Result result){ try { Marshaller marshaller = w3cjc.createMarshaller(); marshaller.marshal(this, result); } catch (JAXBException e) { throw new WebServiceException("Error marshalling W3CEndpointReference. ", e); } } private static JAXBContext getW3CJaxbContext() { try { return JAXBContext.newInstance(W3CEndpointReference.class); } catch (JAXBException e) { throw new WebServiceException("Error creating JAXBContext for W3CEndpointReference. ", e); } } // private but necessary properties for databinding @XmlElement(name="Address",namespace=NS) private Address address; @XmlElement(name="ReferenceParameters",namespace=NS) private Elements referenceParameters; @XmlElement(name="Metadata",namespace=NS) private Elements metadata; // attributes and elements are not private for performance reasons // (JAXB can bypass reflection) @XmlAnyAttribute Map<QName,String> attributes; @XmlAnyElement List<Element> elements; @XmlType(name="address", namespace=W3CEndpointReference.NS) private static class Address { protected Address() {} @XmlValue String uri; @XmlAnyAttribute Map<QName,String> attributes; } @XmlType(name="elements", namespace=W3CEndpointReference.NS) private static class Elements { protected Elements() {} @XmlAnyElement List<Element> elements; @XmlAnyAttribute Map<QName,String> attributes; } }