org.apache.axis2.jaxws.description
Interface EndpointDescription


public interface EndpointDescription

An EndpointDescription corresponds to a particular Service Implementation. It can correspond to either either a client to that impl or the actual service impl.

The EndpointDescription contains information that is relevant to both a Provider-based and SEI-based (aka Endpoint-based or Java-based) enpdoints. SEI-based endpoints (whether they have an explicit or implcit SEI) will have addtional metadata information in an EndpointInterfaceDescription class and sub-hierachy; Provider-based endpoitns do not have such a hierachy.

 EndpointDescription details
 

CORRESPONDS TO: The endpoint (both Client and Server)

AXIS2 DELEGATE: AxisService

CHILDREN: 0..1 EndpointInterfaceDescription

ANNOTATIONS: WebService [181] WebServiceProvider [224] ServicMode [224] BindingType [224]

WSDL ELEMENTS: port


Field Summary
static java.lang.String AXIS_SERVICE_PARAMETER
           
static java.lang.String DEFAULT_CLIENT_BINDING_ID
           
static java.lang.String HANDLER_PARAMETER_QNAMES
          Paramater set on AxisService which contains an ArrayList of SOAP header QNames of SOAPHandlers.
 
Method Summary
 AxisService getAxisService()
           
 java.lang.String getBindingType()
          Returns the binding type FOR A SERVER.
 java.lang.String getClientBindingID()
          Return the binding type FOR A CLIENT.
 java.lang.String getEndpointAddress()
           
 EndpointInterfaceDescription getEndpointInterfaceDescription()
           
 HandlerChainsType getHandlerChain()
           
 java.lang.String getName()
           
 PortInfo getPortInfo()
          Returns the JAX-WS handler PortInfo object for this endpoint.
 QName getPortQName()
           
 ServiceClient getServiceClient()
           
 ServiceDescription getServiceDescription()
           
 Service.Mode getServiceMode()
           
 QName getServiceQName()
           
 java.lang.String getTargetNamespace()
           
 boolean isEndpointBased()
           
 boolean isProviderBased()
           
 void setClientBindingID(java.lang.String clientBindingID)
          Set the binding type FOR A CLIENT.
 void setEndpointAddress(java.lang.String endpointAddress)
           
 void setHandlerChain(HandlerChainsType handlerChain)
           
 

Field Detail

AXIS_SERVICE_PARAMETER

static final java.lang.String AXIS_SERVICE_PARAMETER
See Also:
Constant Field Values

DEFAULT_CLIENT_BINDING_ID

static final java.lang.String DEFAULT_CLIENT_BINDING_ID
See Also:
Constant Field Values

HANDLER_PARAMETER_QNAMES

static final java.lang.String HANDLER_PARAMETER_QNAMES
Paramater set on AxisService which contains an ArrayList of SOAP header QNames of SOAPHandlers.

See Also:
Constant Field Values
Method Detail

getAxisService

AxisService getAxisService()

getServiceClient

ServiceClient getServiceClient()

getServiceDescription

ServiceDescription getServiceDescription()

getEndpointInterfaceDescription

EndpointInterfaceDescription getEndpointInterfaceDescription()

getPortInfo

PortInfo getPortInfo()
Returns the JAX-WS handler PortInfo object for this endpoint.

Returns:
PortInfo

isProviderBased

boolean isProviderBased()

isEndpointBased

boolean isEndpointBased()

getName

java.lang.String getName()

getTargetNamespace

java.lang.String getTargetNamespace()

getBindingType

java.lang.String getBindingType()
Returns the binding type FOR A SERVER. This is based on the BindingType annotation and/or the WSDL. This will return the default binding (SOAP11) if no annotation was specified on the server. This should NOT be called on the client since it will always return the default binding. Use getClientBindingID() on clients.

Returns:

setHandlerChain

void setHandlerChain(HandlerChainsType handlerChain)

getHandlerChain

HandlerChainsType getHandlerChain()

setClientBindingID

void setClientBindingID(java.lang.String clientBindingID)
Set the binding type FOR A CLIENT. The BindingType annotation is not valid on the client per the JAX-WS spec. The value can be set via addPort(...) for a Dispatch client or via TBD for a Proxy client.


getClientBindingID

java.lang.String getClientBindingID()
Return the binding type FOR A CLIENT. This will return the default client binding type if called on the server. Use getBindingType() on servers.

Returns:
String representing the client binding type
See Also:
setClientBindingID();

setEndpointAddress

void setEndpointAddress(java.lang.String endpointAddress)

getEndpointAddress

java.lang.String getEndpointAddress()

getPortQName

QName getPortQName()

getServiceQName

QName getServiceQName()

getServiceMode

Service.Mode getServiceMode()


Copyright © 2007 Apache Web Services Project. All Rights Reserved.