com.ibm.wsspi.wsaddressing

Interface EndpointReference

All Superinterfaces:

AttributedType, java.lang.Cloneable, com.ibm.websphere.wsaddressing.EndpointReference, java.io.Serializable

public interface EndpointReference
extends com.ibm.websphere.wsaddressing.EndpointReference, AttributedType

This interface represents the XML complexType "wsa:EndpointReferenceType" of the WS-Addressing specification XML schema. Endpoint references convey the information needed to reference a Web service endpoint.

This interface extends the API interface to enable programmers to:

• Update and reason about the contents of an EndpointReference's properties (as defined by the WS-Addressing specification)
• Change the namespace of the EndpointReference. (The namespace of the EndpointReference will be used to determine the namespace of the outgoing message when the EndpointReference is used as the target for a message.)

The EndpointReference interface extends AttributedType, this is because the complexType can have attributes set on its XML element as an extensibility mechanism.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a clone of this EndpointReference.
AttributedURI	getAddress() Returns the [address] property of the EndpointReference as an AttributedURI.
Metadata	getMetadata() Returns an object representing the [metadata] property of the EndpointReference
java.lang.String	getNamespace() Returns the namespace in use by this object.
java.lang.String	getReferenceParameter(javax.xml.namespace.QName referenceParameterName) Returns a String ReferenceParameter from the [reference parameters] set.
javax.xml.soap.SOAPElement	getSOAPElement(javax.xml.soap.SOAPElement rootNode) This method serializes the EndpointReference into its SOAPElement representation.
javax.xml.soap.SOAPElement	getSOAPElementReferenceParameter(javax.xml.namespace.QName referenceParameterName) Returns a SOAPElement ReferenceParameter from the [reference parameters] set.
void	setAddress(AttributedURI address) Sets the [address] property of the EndpointReference as an AttributedURI.
void	setMetadata(Metadata metadata) Sets the [metadata] property of the EndpointReference.
void	setNamespace(java.lang.String namespace) Sets the namespace for this object.
void	setReferenceParameter(javax.xml.namespace.QName name, javax.xml.soap.SOAPElement value) Sets a reference parameter to a SOAPElement value.

Methods inherited from interface com.ibm.websphere.wsaddressing.EndpointReference

setReferenceParameter

Methods inherited from interface com.ibm.wsspi.wsaddressing.AttributedType

addAttribute, getAttributeNames, getAttributeValue

Method Detail

getAddress

AttributedURI getAddress()

Returns the [address] property of the EndpointReference as an AttributedURI.

Returns:

AttributedURI The [address] property of the EndpointReference.

setAddress

void setAddress(AttributedURI address)

Sets the [address] property of the EndpointReference as an AttributedURI.

Parameters:

address - The [address] property of the EndpointReference as an AttributedURI. As this is a REQUIRED field in the WS-Addressing specification, if null is passed into this method, then the [address] will be set to the anonymous URI.

getReferenceParameter

java.lang.String getReferenceParameter(javax.xml.namespace.QName referenceParameterName)

Returns a String ReferenceParameter from the [reference parameters] set.

Parameters:

referenceParameterName - The QName identifying the reference parameter whose value is to be returned.

Returns:

The corresponding String value of the reference parameter with the passed QName. Null if no reference parameter of that name exists or if the value of the reference parameter is not a simple string. If more than one reference parameter exists for this name, behavior is undefined.

setReferenceParameter

void setReferenceParameter(javax.xml.namespace.QName name,
                         javax.xml.soap.SOAPElement value)
                           throws com.ibm.websphere.wsaddressing.ReferenceParameterCreationException

Sets a reference parameter to a SOAPElement value. If a reference parameter with the specified name already exists, this will be overridden.

Parameters:

name - The name of this reference parameter.

value - The value of this reference parameter. If this is null, any reference parameter with the given QName will be unset.

Throws:

com.ibm.websphere.wsaddressing.ReferenceParameterCreationException

getSOAPElementReferenceParameter

javax.xml.soap.SOAPElement getSOAPElementReferenceParameter(javax.xml.namespace.QName referenceParameterName)

Returns a SOAPElement ReferenceParameter from the [reference parameters] set.

Parameters:

referenceParameterName - The QName identifying the reference paramter whose value is to be returned

Returns:

The corresponding SOAPElement value of the reference parameter with the passed QName. Null if no reference parameter of that name exists. If more than one reference parameter exists for this name, behavior is undefined.

getMetadata

Metadata getMetadata()

Returns an object representing the [metadata] property of the EndpointReference

Returns:

The [metadata] associated with this EndpointReference. Null if no metadata exists for this EndpointReference.

setMetadata

void setMetadata(Metadata metadata)

Sets the [metadata] property of the EndpointReference.

Parameters:

metadata - The metadata to be associated with this EndpointReference. This will override any [metadata] previously associated with thie EndpointReference. If this is null, any [metadata] associated with this EndpointReference is removed.

getSOAPElement

javax.xml.soap.SOAPElement getSOAPElement(javax.xml.soap.SOAPElement rootNode)
                                          throws javax.xml.soap.SOAPException

This method serializes the EndpointReference into its SOAPElement representation.

Parameters:

rootNode - The SOAPElement into which the resulting SOAPElement should be placed.

Returns:

The serialized EndpointReference as a SOAPElement.

Throws:

javax.xml.soap.SOAPException - if a SOAPException is thrown during the serialization of the EndpointReference to SOAP.

setNamespace

void setNamespace(java.lang.String namespace)
                  throws NamespaceNotSupportedException

Sets the namespace for this object.

By default the namespace of an EndpointReference will be the String defined by the following constant: com.ibm.wsspi.wsaddressing.WSAConstants.WSADDRESSING_NAMESPACE.

The namespace will differ from the default if the object has been deserialized from a SOAPElement of a different namespace or if the namespace has been explicitly overridden by the setNamespace method.

The set of namespaces supported are defined in com.ibm.wsspi.wsaddressing.WSAConstants.

Parameters:

namespace - A String identifying the namespace of this object.

Throws:

NamespaceNotSupportedException - if the namespace passed is not one of those supported by this implementation. Supported namespaces are in the com.ibm.wsspi.wsaddressing.WSAConstants file.

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone of this EndpointReference.

Returns:

A clone of this EndpointReference instance.

Throws:

java.lang.CloneNotSupportedException

getNamespace

java.lang.String getNamespace()

Returns the namespace in use by this object.

Returns:

The namespace String of this EndpointReference.