javax.xml.ws.wsaddressing.W3CEndpointReference Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
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 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 static JAXBContext w3cjc = getW3CJaxbContext();
static final String NS = "http://www.w3.org/2005/08/addressing";
// default constructor forbidden ...
private W3CEndpointReference() {
}
/**
* 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 null 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}
*/
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 attributes;
@XmlAnyElement
List elements;
@XmlType(name="address", namespace=W3CEndpointReference.NS)
private static class Address {
protected Address() {}
@XmlValue
String uri;
@XmlAnyAttribute
Map attributes;
}
@XmlType(name="elements", namespace=W3CEndpointReference.NS)
private static class Elements {
protected Elements() {}
@XmlAnyElement
List elements;
@XmlAnyAttribute
Map attributes;
}
}