IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.wsaddressing
Class EndpointReferenceManager

java.lang.Object
  extended by com.ibm.websphere.wsaddressing.EndpointReferenceManager
      extended by com.ibm.wsspi.wsaddressing.EndpointReferenceManager

public abstract class EndpointReferenceManager
extends com.ibm.websphere.wsaddressing.EndpointReferenceManager

This class exposes the EndpointReferenceManager interface available at the SPI level.


Field Summary
protected static EndpointReferenceManager _endpointReferenceManager
           
 
Constructor Summary
EndpointReferenceManager()
           
 
Method Summary
protected abstract  EndpointReference createConcreteEndpointReference(AttributedURI address)
           
protected abstract  EndpointReference createConcreteEndpointReference(javax.xml.soap.SOAPElement soapElement)
           
protected abstract  EndpointReference createConcreteEndpointReference(java.net.URI address)
           
static EndpointReference createEndpointReference(AttributedURI address)
          The createEndpointReference method creates an EndpointReference based on an AttributedURI.
static EndpointReference createEndpointReference(javax.xml.soap.SOAPElement soapElement)
          This method deserializes a SOAPELement into its Java representation.
static EndpointReference createEndpointReference(java.net.URI address)
          The createEndpointReference method creates an EndpointReference based on a URI.
protected abstract  java.net.URI getConcreteURIForEndpoint(javax.xml.namespace.QName serviceName, java.lang.String endpointName)
           
static javax.xml.soap.SOAPElement getSOAPElementReferenceParameterFromMessageContext(javax.xml.namespace.QName name)
           This method is intended for use by Web service applications requiring access to WS-Addressing [reference parameters] that appear on the inbound message.
static java.net.URI getURIForEndpoint(javax.xml.namespace.QName serviceName, java.lang.String endpointName)
           This method returns a endpoint URI based on the WSDL service name and endpoint (WSDL 1.1 port name) passed as parameters.
protected static EndpointReferenceManager getWsspiEPRManager()
           
 
Methods inherited from class com.ibm.websphere.wsaddressing.EndpointReferenceManager
createConcreteEndpointReference, createConcreteEndpointReference, createEndpointReference, createEndpointReference, getEPRManager, getReferenceParameterFromMessageContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_endpointReferenceManager

protected static final EndpointReferenceManager _endpointReferenceManager
Constructor Detail

EndpointReferenceManager

public EndpointReferenceManager()
Method Detail

createConcreteEndpointReference

protected abstract EndpointReference createConcreteEndpointReference(javax.xml.soap.SOAPElement soapElement)
                                                              throws com.ibm.websphere.wsaddressing.EndpointReferenceCreationException
Throws:
com.ibm.websphere.wsaddressing.EndpointReferenceCreationException

getWsspiEPRManager

protected static EndpointReferenceManager getWsspiEPRManager()

createEndpointReference

public static EndpointReference createEndpointReference(javax.xml.soap.SOAPElement soapElement)
                                                 throws com.ibm.websphere.wsaddressing.EndpointReferenceCreationException
This method deserializes a SOAPELement into its Java representation.

Parameters:
soapElement - The EndpointReference as a SOAPElement.
Returns:
EndpointReference The java representation of the EndpointReference.
Throws:
com.ibm.websphere.wsaddressing.EndpointReferenceCreationException - Thrown if it's not possible to create the EPR for this endpoint. For example, if the passed SOAPElement does not represent a valid EPR, this exception will be thrown.

getURIForEndpoint

public static java.net.URI getURIForEndpoint(javax.xml.namespace.QName serviceName,
                                             java.lang.String endpointName)
                                      throws URIGenerationException

This method returns a endpoint URI based on the WSDL service name and endpoint (WSDL 1.1 port name) passed as parameters.

In order for this method to generate the URI correctly, the local part of the WSDL service name passed as a parameter must be the same as the webservice-description-name in the webservice deployment descriptor webservices.xml. (If the webservices.xml file is generated by tools they will be the same.)

Parameters:
serviceName - The QName representing the service that the newly created EPR will represent
endpointName - The String representing the endpoint in the service that the newly created URI will represent. In WSDL 1.1, this equates to the port name.
Returns:
uri URI of the endpoint.
Throws:
URIGenerationException - thrown if there was a problem creating the URI. For example, if it is not possible to establish a unique URI for this endpoint, this exception will be thrown.

createEndpointReference

public static EndpointReference createEndpointReference(java.net.URI address)
                                                 throws com.ibm.websphere.wsaddressing.EndpointReferenceCreationException
The createEndpointReference method creates an EndpointReference based on a URI. The URI will be used as the [address] property of the EndpointReference.

Parameters:
address - in the form of a URI for the EndpointReference. If this parameter is null, the address will be set to the anonymous URI.
Returns:
EndpointReference for the URI passed as a parameter.
Throws:
com.ibm.websphere.wsaddressing.EndpointReferenceCreationException - Thrown if an error occurred during the EndpointReference's creation.

createEndpointReference

public static EndpointReference createEndpointReference(AttributedURI address)
                                                 throws com.ibm.websphere.wsaddressing.EndpointReferenceCreationException
The createEndpointReference method creates an EndpointReference based on an AttributedURI. The AttributedURI will be used as the [address] property of the EndpointReference.

Parameters:
address - in the form of an AttributedURI for the EndpointReference. If this parameter is null, the address will be set to the anonymous URI.
Returns:
EndpointReference for the AttributedURI passed as a parameter.
Throws:
com.ibm.websphere.wsaddressing.EndpointReferenceCreationException - Thrown if an error occurred during the EndpointReference's creation.

getSOAPElementReferenceParameterFromMessageContext

public static javax.xml.soap.SOAPElement getSOAPElementReferenceParameterFromMessageContext(javax.xml.namespace.QName name)
                                                                                     throws com.ibm.websphere.wsaddressing.ReferenceParameterCreationException

This method is intended for use by Web service applications requiring access to WS-Addressing [reference parameters] that appear on the inbound message. It returns a Reference Parameter identified by its QName.

Note that:

For access to [reference parameters] which have a String value, the com.ibm.websphere.wsaddressing.EndpointReferenceManager.getReferenceParameterFromMessageContext method can be used.

This method is intended for use at the Web service only. It is not available to the client.

Parameters:
name - The QName identifying the reference parameters to be returned
Returns:
The SOAPElement reference parameter value on the message context corresponding to the name passed as input. If no reference parameter exists with the specified name, null will be returned. If more than one reference parameter exists with the specified name then behavior is undefined.
Throws:
com.ibm.websphere.wsaddressing.ReferenceParameterCreationException - if there was a problem creating the reference parameter (for example, if there is no available SOAP Message Context).

createConcreteEndpointReference

protected abstract EndpointReference createConcreteEndpointReference(java.net.URI address)
                                                              throws com.ibm.websphere.wsaddressing.EndpointReferenceCreationException
Throws:
com.ibm.websphere.wsaddressing.EndpointReferenceCreationException

createConcreteEndpointReference

protected abstract EndpointReference createConcreteEndpointReference(AttributedURI address)
                                                              throws com.ibm.websphere.wsaddressing.EndpointReferenceCreationException
Throws:
com.ibm.websphere.wsaddressing.EndpointReferenceCreationException

getConcreteURIForEndpoint

protected abstract java.net.URI getConcreteURIForEndpoint(javax.xml.namespace.QName serviceName,
                                                          java.lang.String endpointName)
                                                   throws URIGenerationException
Throws:
URIGenerationException

IBM WebSphere Application ServerTM
Release 8