|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EndpointReference
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:
The EndpointReference interface extends AttributedType, this is because the complexType can have attributes set on its XML element as an extensibility mechanism.
Method Summary | |
---|---|
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 |
---|
AttributedURI getAddress()
void setAddress(AttributedURI address)
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.java.lang.String getReferenceParameter(javax.xml.namespace.QName referenceParameterName)
referenceParameterName
- The QName identifying the reference parameter whose value is to
be returned.
void setReferenceParameter(javax.xml.namespace.QName name, javax.xml.soap.SOAPElement value) throws com.ibm.websphere.wsaddressing.ReferenceParameterCreationException
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.
com.ibm.websphere.wsaddressing.ReferenceParameterCreationException
javax.xml.soap.SOAPElement getSOAPElementReferenceParameter(javax.xml.namespace.QName referenceParameterName)
referenceParameterName
- The QName identifying the reference paramter whose value is to
be returned
Metadata getMetadata()
void setMetadata(Metadata metadata)
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.javax.xml.soap.SOAPElement getSOAPElement(javax.xml.soap.SOAPElement rootNode) throws javax.xml.soap.SOAPException
rootNode
- The SOAPElement into which the resulting SOAPElement should be
placed.
javax.xml.soap.SOAPException
- if a SOAPException is thrown during the
serialization of the EndpointReference to SOAP.void setNamespace(java.lang.String namespace) throws NamespaceNotSupportedException
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.
namespace
- A String identifying the namespace of this
object.
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.java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
java.lang.String getNamespace()
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |