org.apache.axis.message.addressing
Class EndpointReference

java.lang.Object
  org.apache.axis.message.addressing.EndpointReferenceType
      org.apache.axis.message.addressing.EndpointReference

All Implemented Interfaces:

java.io.Serializable, org.apache.axis.encoding.AnyContentType, AddressingHeaderItem

Direct Known Subclasses:

FaultTo, From, Recipient, ReplyTo

public class EndpointReference
extends EndpointReferenceType
implements AddressingHeaderItem

Java content class for EndpointReference element declaration.

The following schema fragment specifies the expected content contained within this java content object. (defined at http://schemas.xmlsoap.org/ws/2004/08/addressing line 45)

 <element
   xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
   name="EndpointReference"
   type="wsa:EndpointReferenceType"/>
 

Version:

$Revision: 13 $

Author:

Davanum Srinivas, Rodrigo Ruiz

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.axis.message.addressing.EndpointReferenceType

metaData

Constructor Summary

EndpointReference(Address address)
Creates a new EndpointReference instance.

EndpointReference(org.w3c.dom.Element element)
Constructor EndpointReference.

EndpointReference(EndpointReferenceType endpoint)
Creates a new EndpointReference instance.

EndpointReference(javax.xml.soap.SOAPElement element)
Creates a new EndpointReference instance.

EndpointReference(java.lang.String endpoint)
Creates a new EndpointReference instance.

EndpointReference(org.apache.axis.types.URI uri)
Creates a new EndpointReference instance.

Method Summary

void	addMetadata(org.apache.axis.message.MessageElement data) Insert a new metadata item.
void	addReferenceParameter(org.apache.axis.message.MessageElement param) Insert a new reference parameter.
void	addReferenceProperty(org.apache.axis.message.MessageElement prop) Insert a new reference property.
org.w3c.dom.Element	toDOM(org.w3c.dom.Document doc) Method toDOM.
org.w3c.dom.Element	toDOM(org.w3c.dom.Document doc, java.lang.String elementName) Method toDOM.
javax.xml.soap.SOAPHeaderElement	toSOAPHeaderElement(AddressingVersion version, javax.xml.soap.SOAPEnvelope env, java.lang.String actorURI) Gets a SOAP Header Element from this instance.
protected javax.xml.soap.SOAPHeaderElement	toSOAPHeaderElement(AddressingVersion version, javax.xml.soap.SOAPEnvelope env, java.lang.String actorURI, java.lang.String name) Translates this instance into a SOAPHeaderElement.
javax.xml.soap.SOAPHeaderElement	toSOAPHeaderElement(javax.xml.soap.SOAPEnvelope env, java.lang.String actorURI) Gets a SOAP Header Element from this instance.

Methods inherited from class org.apache.axis.message.addressing.EndpointReferenceType

get_any, getAddress, getDeserializer, getMetadata, getParameters, getPortType, getProperties, getSerializer, getServiceName, getTypeDesc, set_any, setAddress, setMetadata, setParameters, setPortType, setProperties, setServiceName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EndpointReference

public EndpointReference(Address address)

Creates a new EndpointReference instance.

Parameters:

address - Remote address

EndpointReference

public EndpointReference(org.w3c.dom.Element element)
                  throws org.apache.axis.types.URI.MalformedURIException

Constructor EndpointReference.

Parameters:

element - Source element

Throws:

org.apache.axis.types.URI.MalformedURIException - If an error occurs

EndpointReference

public EndpointReference(EndpointReferenceType endpoint)

Creates a new EndpointReference instance.

Parameters:

endpoint - Remote end-point

EndpointReference

public EndpointReference(javax.xml.soap.SOAPElement element)
                  throws org.apache.axis.types.URI.MalformedURIException

Creates a new EndpointReference instance.

Parameters:

element - SOAP element node

Throws:

org.apache.axis.types.URI.MalformedURIException - If an error occurs

EndpointReference

public EndpointReference(java.lang.String endpoint)
                  throws org.apache.axis.types.URI.MalformedURIException

Creates a new EndpointReference instance.

Parameters:

endpoint - Target end-point

Throws:

URI.MalformedURIException - If the specified URI is not valid

EndpointReference

public EndpointReference(org.apache.axis.types.URI uri)

Creates a new EndpointReference instance.

Parameters:

uri - Remote address URI

Method Detail

addMetadata

public void addMetadata(org.apache.axis.message.MessageElement data)

Insert a new metadata item.

Parameters:

data - XML rep. of metadata (MessageElement)

addReferenceParameter

public void addReferenceParameter(org.apache.axis.message.MessageElement param)

Insert a new reference parameter.

Parameters:

param - XML rep of referenceParameter (MessageElement)

addReferenceProperty

public void addReferenceProperty(org.apache.axis.message.MessageElement prop)

Insert a new reference property.

Parameters:

prop - XML rep of referenceParameter (MessageElement)

toDOM

public org.w3c.dom.Element toDOM(org.w3c.dom.Document doc)

Method toDOM.

Parameters:

doc - Document to use for Node creation

Returns:

DOM Element

toDOM

public org.w3c.dom.Element toDOM(org.w3c.dom.Document doc,
                                 java.lang.String elementName)

Method toDOM. This will create a DOM element in the supplied document containing the XML-ized EPR. A namespace declaration for WSA will be added to this element, using either the default namespace (if the passed elementName isn't prefixed) or a prefixed namespace (if it is of the form "foo:bar").

Parameters:

doc - Document to use as Node factory

elementName - Element name

Returns:

DOM element

toSOAPHeaderElement

public javax.xml.soap.SOAPHeaderElement toSOAPHeaderElement(AddressingVersion version,
                                                            javax.xml.soap.SOAPEnvelope env,
                                                            java.lang.String actorURI)
                                                     throws javax.xml.soap.SOAPException

Gets a SOAP Header Element from this instance.

Specified by:

toSOAPHeaderElement in interface AddressingHeaderItem

Parameters:

version - WS-Addressing version to use

env - SOAP envelope to append to

actorURI - Actor URI

Returns:

Header Element

Throws:

javax.xml.soap.SOAPException - If an error occurs

toSOAPHeaderElement

public javax.xml.soap.SOAPHeaderElement toSOAPHeaderElement(javax.xml.soap.SOAPEnvelope env,
                                                            java.lang.String actorURI)
                                                     throws javax.xml.soap.SOAPException

Gets a SOAP Header Element from this instance.

Specified by:

toSOAPHeaderElement in interface AddressingHeaderItem

Parameters:

env - SOAP envelope to append to

actorURI - Actor URI

Returns:

Header Element

Throws:

javax.xml.soap.SOAPException - If an error occurs

toSOAPHeaderElement

protected javax.xml.soap.SOAPHeaderElement toSOAPHeaderElement(AddressingVersion version,
                                                               javax.xml.soap.SOAPEnvelope env,
                                                               java.lang.String actorURI,
                                                               java.lang.String name)
                                                        throws javax.xml.soap.SOAPException

Translates this instance into a SOAPHeaderElement.

Parameters:

version - WS-Addressing version to use

env - SOAP Envelope to put the element into

actorURI - Actor URI

name - Element name

Returns:

Created element

Throws:

javax.xml.soap.SOAPException - If an error occurs