EndpointDescription (Apache Axis2 - Metadata 1.6.1-wso2v103 API)

All Known Implementing Classes:

EndpointDescriptionImpl
```
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

Fields
Modifier and Type	Field and Description
`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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addRequiredBinding(WSDLValidatorElement element)` Adds the QName to a list of binding types that are required to be supported by the endpoint as defined in the WSDL.
`AxisService`	`getAxisService()`
`java.lang.String`	`getBindingType()` Returns the binding type FOR A SERVER.
`java.lang.String`	`getClientBindingID()` Return the binding type FOR A CLIENT.
`DescriptionBuilderComposite`	`getDescriptionBuilderComposite()` Return the DescriptionBuilderComposite, if any, used to build this service description.
`java.lang.String`	`getEndpointAddress()`
`EndpointInterfaceDescription`	`getEndpointInterfaceDescription()`
`HandlerChainsType`	`getHandlerChain()` Return the handler chain configuration information as a HandlerChainsType object.
`HandlerChainsType`	`getHandlerChain(java.lang.Object serviceDelegateKey)` Return the handler chain configuration information as a HandlerChainsType object.
`int`	`getMTOMThreshold()` If MTOM is enabled, returns the threshold value.
`java.lang.String`	`getName()`
`javax.xml.ws.handler.PortInfo`	`getPortInfo()` Returns the JAX-WS handler PortInfo object for this endpoint.
`javax.xml.namespace.QName`	`getPortQName()`
`java.lang.Object`	`getProperty(java.lang.String key)` Return the Object that corresponds to the property key supplied.
`java.util.Set<WSDLValidatorElement>`	`getRequiredBindings()` Returns a list of all known bindings that should be supported based on the information in the WSDL.
`ServiceClient`	`getServiceClient()`
`ServiceDescription`	`getServiceDescription()`
`javax.xml.ws.Service.Mode`	`getServiceMode()`
`javax.xml.namespace.QName`	`getServiceQName()`
`java.lang.String`	`getTargetNamespace()`
`boolean`	`isEndpointBased()`
`boolean`	`isMTOMEnabled()` Signals whether or not MTOM has been turned on for the endpoint based on the annotation configuration.
`boolean`	`isProviderBased()`
`boolean`	`respectBinding()` Returns true if the contents of the `<wsdl:binding>` must be strictly respected by the runtime.
`void`	`setClientBindingID(java.lang.String clientBindingID)` Set the binding type FOR A CLIENT.
`void`	`setEndpointAddress(java.lang.String endpointAddress)`
`void`	`setHandlerChain(HandlerChainsType handlerChain)`
`void`	`setProperty(java.lang.String key, java.lang.Object value)` Store the property by the key specified.
`void`	`setRespectBinding(boolean respect)` Indicate whether or not strict binding support should be used.

- 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
```
javax.xml.ws.handler.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(java.lang.Object serviceDelegateKey)
```
    Return the handler chain configuration information as a HandlerChainsType object. If the key is non-null then it is used to look for handler chain configuration information in the sparse metadata. The order in which the configuration information is resolved is: 1) Look in sparse composite if the key is not null 2) Look in the composite 3) Look for a HandlerChain annotation and read in the file it specifies
    
    Parameters:
    
    serviceDelegateKey - May be null. If non-null, used to look for service-delegate specific sparse composite information.
    
    Returns:
    
    A HandlerChainsType object or null
  - getHandlerChain
```
HandlerChainsType getHandlerChain()
```
    Return the handler chain configuration information as a HandlerChainsType object. This is the same as calling getHandlerChain(null).
    
    See Also:
    
    getHandlerChain(Object)
  - 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
```
javax.xml.namespace.QName getPortQName()
```
  - getServiceQName
```
javax.xml.namespace.QName getServiceQName()
```
  - getServiceMode
```
javax.xml.ws.Service.Mode getServiceMode()
```
  - isMTOMEnabled
```
boolean isMTOMEnabled()
```
    Signals whether or not MTOM has been turned on for the endpoint based on the annotation configuration. Both the @MTOM and @BindingType are inspected. The @MTOM annotation is inspected first. If the @MTOM annotation is not present, then the @BindingType is inspected.
    
    Returns:
    
    a boolean value
  - getMTOMThreshold
```
int getMTOMThreshold()
```
    If MTOM is enabled, returns the threshold value.
    
    Returns:
    
    -1 if MTOM is not enabled, a positive integer value if one was configured.
  - respectBinding
```
boolean respectBinding()
```
    Returns true if the contents of the <wsdl:binding> must be strictly respected by the runtime.
    
    Returns:
    
    a boolean value
  - setRespectBinding
```
void setRespectBinding(boolean respect)
```
    Indicate whether or not strict binding support should be used.
  - addRequiredBinding
```
boolean addRequiredBinding(WSDLValidatorElement element)
```
    Adds the QName to a list of binding types that are required to be supported by the endpoint as defined in the WSDL.
    
    Parameters:
    
    name -
    
    Returns:
  - getRequiredBindings
```
java.util.Set<WSDLValidatorElement> getRequiredBindings()
```
    Returns a list of all known bindings that should be supported based on the information in the WSDL.
    
    Returns:
  - getDescriptionBuilderComposite
```
DescriptionBuilderComposite getDescriptionBuilderComposite()
```
    Return the DescriptionBuilderComposite, if any, used to build this service description.
    
    Returns:
  - getProperty
```
java.lang.Object getProperty(java.lang.String key)
```
    Return the Object that corresponds to the property key supplied.
  - setProperty
```
void setProperty(java.lang.String key,
                 java.lang.Object value)
```
    Store the property by the key specified.

Interface EndpointDescription

Field Summary

Method Summary

Field Detail

AXIS_SERVICE_PARAMETER

DEFAULT_CLIENT_BINDING_ID

HANDLER_PARAMETER_QNAMES

Method Detail

getAxisService

getServiceClient

getServiceDescription

getEndpointInterfaceDescription

getPortInfo

isProviderBased

isEndpointBased

getName

getTargetNamespace

getBindingType

setHandlerChain

getHandlerChain

getHandlerChain

setClientBindingID

getClientBindingID

setEndpointAddress

getEndpointAddress

getPortQName

getServiceQName

getServiceMode

isMTOMEnabled

getMTOMThreshold

respectBinding

setRespectBinding

addRequiredBinding

getRequiredBindings

getDescriptionBuilderComposite

getProperty

setProperty