org.apache.axis2.transport.base
Class ProtocolEndpoint

java.lang.Object
  org.apache.axis2.transport.base.ProtocolEndpoint

Direct Known Subclasses:

AbstractPollTableEntry, DatagramEndpoint, JMSEndpoint

public abstract class ProtocolEndpoint
extends java.lang.Object

Describes a protocol specific endpoint. This might be a TCP/UDP port, a mail account, a JMS destination, etc. Typically, a protocol specific endpoint is mapped to a service.

Constructor Summary

ProtocolEndpoint()

Method Summary

org.apache.axis2.context.MessageContext	createMessageContext()
abstract org.apache.axis2.addressing.EndpointReference[]	getEndpointReferences(java.lang.String ip) Get the endpoint references for this protocol endpoint.
AbstractTransportListenerEx<?>	getListener()
org.apache.axis2.description.AxisService	getService()
java.lang.String	getServiceName()
abstract boolean	loadConfiguration(org.apache.axis2.description.ParameterInclude params) Configure the endpoint based on the provided parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolEndpoint

public ProtocolEndpoint()

Method Detail

getListener

public final AbstractTransportListenerEx<?> getListener()

getService

public final org.apache.axis2.description.AxisService getService()

getServiceName

public final java.lang.String getServiceName()

loadConfiguration

public abstract boolean loadConfiguration(org.apache.axis2.description.ParameterInclude params)
                                   throws org.apache.axis2.AxisFault

Configure the endpoint based on the provided parameters. If no relevant parameters are found, the implementation should return false. An exception should only be thrown if there is an error or inconsistency in the parameters.

Parameters:

params - The source of the parameters to construct the poll table entry. If the parameters are defined on a service, this will be an AxisService instance.

Returns:

true if the parameters contained the required configuration information and the endpoint has been configured, false if the no configuration for the endpoint is present in the parameters

Throws:

org.apache.axis2.AxisFault - if configuration information is present, but there is an error or inconsistency in the parameters

getEndpointReferences

public abstract org.apache.axis2.addressing.EndpointReference[] getEndpointReferences(java.lang.String ip)
                                                                               throws org.apache.axis2.AxisFault

Get the endpoint references for this protocol endpoint.

Parameters:

ip - The host name or IP address of the local host. The implementation should use this information instead of InetAddress.getLocalHost(). The value of this parameter may be null, in which case the implementation should use Utils.getIpAddress( org.apache.axis2.engine.AxisConfiguration).

Returns:

an array of endpoint references

Throws:

org.apache.axis2.AxisFault

See Also:

TransportListener.getEPRsForService(String, String)

createMessageContext

public org.apache.axis2.context.MessageContext createMessageContext()
                                                             throws org.apache.axis2.AxisFault

Throws:

org.apache.axis2.AxisFault