org.apache.axis2.jaxws.description

Interface EndpointInterfaceDescription

All Known Implementing Classes:

EndpointInterfaceDescriptionImpl

public interface EndpointInterfaceDescription

An EndpointInterfaceDescription corresponds to a particular SEI-based Service Implementation. It can correspond to either either a client to that impl or the actual service impl.

The EndpointInterfaceDescription contains information that is relevant only to an SEI-based (aka Endpoint-based or Java-based) enpdoint; Provider-based endpoint, which are not operation based and do not have an associated SEI, will not have an an EndpointInterfaceDescription class and sub-hierachy.

 EndpointInterfaceDescription details
 

     CORRESPONDS TO:      An SEI (on both Client and Server)
 

     AXIS2 DELEGATE:      none
 

     CHILDREN:            1..n OperationDescription
 

     ANNOTATIONS:
         SOAPBinding [181]
 

     WSDL ELEMENTS:
         portType
 

  

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JAXWS_NOWSDL_PROVIDER_OPERATION_NAME The name of a special operation added to EndpointInterfaceDescriptions for provider endpoints that do not specify WSDL, and therefore do not have specific WSDL operations created.

Method Summary

Modifier and Type	Method and Description
OperationDescription[]	getDispatchableOperation(javax.xml.namespace.QName operationQName) Returns all the dispatchable operations matching the operation QName.
OperationDescription[]	getDispatchableOperations()
EndpointDescription	getEndpointDescription()
OperationDescription	getOperation(java.lang.reflect.Method seiMethod)
OperationDescription[]	getOperation(javax.xml.namespace.QName operationQName) Returns all the operations matching the operation QName associated with this endpoint description.
OperationDescription	getOperation(java.lang.String operationName)
OperationDescription[]	getOperationForJavaMethod(java.lang.String javaMethodName)
OperationDescription[]	getOperations()
javax.xml.namespace.QName	getPortType()
java.lang.Class	getSEIClass()
javax.jws.soap.SOAPBinding.ParameterStyle	getSoapBindingParameterStyle()
javax.jws.soap.SOAPBinding.Style	getSoapBindingStyle()
javax.jws.soap.SOAPBinding.Use	getSoapBindingUse()
java.lang.String	getTargetNamespace()

Field Detail

JAXWS_NOWSDL_PROVIDER_OPERATION_NAME

static final java.lang.String JAXWS_NOWSDL_PROVIDER_OPERATION_NAME

The name of a special operation added to EndpointInterfaceDescriptions for provider endpoints that do not specify WSDL, and therefore do not have specific WSDL operations created. Note that this is currently only supported for HTTP bindings, not for SOAP bindings.

See Also:

Constant Field Values

Method Detail

getEndpointDescription

EndpointDescription getEndpointDescription()

getTargetNamespace

java.lang.String getTargetNamespace()

getOperation

OperationDescription getOperation(java.lang.reflect.Method seiMethod)

getOperation

OperationDescription[] getOperation(javax.xml.namespace.QName operationQName)

Returns all the operations matching the operation QName associated with this endpoint description. Note that if the SEI or service implementation (and thus the implicit SEI) contained JAX-WS client side async operations then they will also be returned. Use getDispatchableOperations() to return an array of operations that does not include the JAX-WS client side async operations.

Parameters:

operationQName -

Returns:

See Also:

getDispatchableOperation(QName operationQName)

getDispatchableOperation

OperationDescription[] getDispatchableOperation(javax.xml.namespace.QName operationQName)

Returns all the dispatchable operations matching the operation QName. A dispatchable operation is one that is NOT a JAX-WS client-side async method invocation and does NOT carry an @WebMethod(exclude=true) annotation. JAX-WS client-side async methods which have signatures of the following forms are filtered out of this list: javax.xml.ws.Response method(...) java.util.concurrent.Future method(..., javax.xml.ws.AsyncHandler)

These methods are filtered because a common use case is to use the same SEI on both the client and service implementation side, generating both the client and service implemntation code from that SEI. If that SEI happens to contain the client-side-only JAX-WS methods, they should be ingored on the service implemenation side. To return all the operations, use getOperation(QName).

Parameters:

operationQName -

Returns:

See Also:

getOperation(QName operationQName)

getDispatchableOperations

OperationDescription[] getDispatchableOperations()

getOperation

OperationDescription getOperation(java.lang.String operationName)

getOperations

OperationDescription[] getOperations()

getOperationForJavaMethod

OperationDescription[] getOperationForJavaMethod(java.lang.String javaMethodName)

getSEIClass

java.lang.Class getSEIClass()

getPortType

javax.xml.namespace.QName getPortType()

getSoapBindingParameterStyle

javax.jws.soap.SOAPBinding.ParameterStyle getSoapBindingParameterStyle()

getSoapBindingStyle

javax.jws.soap.SOAPBinding.Style getSoapBindingStyle()

getSoapBindingUse

javax.jws.soap.SOAPBinding.Use getSoapBindingUse()