org.apache.axis2.jaxws.description
Interface ServiceDescription

public interface ServiceDescription

A ServiceDescription corresponds to a Service under which there can be a collection of enpdoints. In WSDL 1.1 terms, then, a ServiceDescription corresponds to a wsdl:Service under which there are one or more wsdl:Port entries. The ServiceDescription is the root of the metdata abstraction Description hierachy.

The Description hierachy is:

 ServiceDescription
     EndpointDescription[]
         EndpointInterfaceDescription
             OperationDescription[]
                 ParameterDescription[]
                 FaultDescription[]
 

 ServiceDescription details
 

     CORRESPONDS TO:
         On the Client: The JAX-WS Service class or generated subclass.
 

         On the Server: The Service implementation.  Note that there is a 1..1
         correspondence between a ServiceDescription and EndpointDescription
         on the server side.
 

     AXIS2 DELEGATE:      None
 

     CHILDREN:            1..n EndpointDescription
 

     ANNOTATIONS:
         None
 

     WSDL ELEMENTS:
         service
 

  

Method Summary

ConfigurationContext	getAxisConfigContext()
JAXWSCatalogManager	getCatalogManager()
EndpointDescription[]	getEndpointDescription(java.lang.Class seiClass) Return the EndpointDescriptions corresponding to the SEI class.
EndpointDescription	getEndpointDescription(QName portQName)
EndpointDescription	getEndpointDescription(QName portQName, java.lang.Object serviceDelegateKey)
java.util.Collection<EndpointDescription>	getEndpointDescriptions_AsCollection()
EndpointDescription[]	getEndpointDescriptions()
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.
java.util.List<java.lang.Class>	getHandlerChainClasses(PortInfo portinfo)
java.util.List<QName>	getPorts(java.lang.Object serviceDelegateKey) Returns a list of the ports for this serivce.
QName	getPreferredPort(java.lang.Object key)
ServiceClient	getServiceClient(QName portQName, java.lang.Object serviceDelegateKey)
QName	getServiceQName()
ServiceRuntimeDescription	getServiceRuntimeDesc(java.lang.String name)
boolean	isMTOMEnabled(java.lang.Object key) Answer if MTOM is enabled for the service represented by this Service Description.
boolean	isServerSide()
void	setHandlerChainClasses(PortInfo portinfo, java.util.List<java.lang.Class> handlerClasses)
void	setServiceRuntimeDesc(ServiceRuntimeDescription ord)

Method Detail

getEndpointDescriptions

EndpointDescription[] getEndpointDescriptions()

getEndpointDescriptions_AsCollection

java.util.Collection<EndpointDescription> getEndpointDescriptions_AsCollection()

getEndpointDescription

EndpointDescription getEndpointDescription(QName portQName)

getEndpointDescription

EndpointDescription getEndpointDescription(QName portQName,
                                           java.lang.Object serviceDelegateKey)

getEndpointDescription

EndpointDescription[] getEndpointDescription(java.lang.Class seiClass)

Return the EndpointDescriptions corresponding to the SEI class. Note that Dispatch endpoints will never be returned because they do not have an associated SEI.

Parameters:

seiClass -

Returns:

getAxisConfigContext

ConfigurationContext getAxisConfigContext()

getServiceClient

ServiceClient getServiceClient(QName portQName,
                               java.lang.Object serviceDelegateKey)

getServiceQName

QName getServiceQName()

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)

getPorts

java.util.List<QName> getPorts(java.lang.Object serviceDelegateKey)

Returns a list of the ports for this serivce. The ports returned are the - Ports declared ports for this Service. They can be delcared in the WSDL or via annotations. - Dynamic ports added to the service

Parameters:

serviceDelegateKey - This should always be non-null when called via ServiceDelegate and is used to help retrieve dynamic ports per client

Returns:

getServiceRuntimeDesc

ServiceRuntimeDescription getServiceRuntimeDesc(java.lang.String name)

setServiceRuntimeDesc

void setServiceRuntimeDesc(ServiceRuntimeDescription ord)

isServerSide

boolean isServerSide()

isMTOMEnabled

boolean isMTOMEnabled(java.lang.Object key)

Answer if MTOM is enabled for the service represented by this Service Description. This is currently only supported on the service-requester side; it is not supported on the service-provider side. If the key is non-null, it is used to look up an sparse metadata that may have been specified when the Service Description was created.

Parameters:

key - If non-null, used to look up any sparse metadata that may have been specified when the service was created.

Returns:

TRUE if mtom was enabled either in the sparse metadata or in the composite; FALSE othewise.

getPreferredPort

QName getPreferredPort(java.lang.Object key)

getCatalogManager

JAXWSCatalogManager getCatalogManager()

getHandlerChainClasses

java.util.List<java.lang.Class> getHandlerChainClasses(PortInfo portinfo)

setHandlerChainClasses

void setHandlerChainClasses(PortInfo portinfo,
                            java.util.List<java.lang.Class> handlerClasses)