Package org.apache.axis2.jaxws.description.impl

Class EndpointDescriptionImpl

java.lang.Object

org.apache.axis2.jaxws.description.impl.EndpointDescriptionImpl

All Implemented Interfaces:

EndpointDescription, EndpointDescriptionJava, EndpointDescriptionWSDL

public class EndpointDescriptionImpl
extends Object
implements EndpointDescription, EndpointDescriptionJava, EndpointDescriptionWSDL

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BindingType_DEFAULT
static final jakarta.xml.ws.Service.Mode	ServiceMode_DEFAULT

Fields inherited from interface org.apache.axis2.jaxws.description.EndpointDescription

AXIS_SERVICE_PARAMETER, DEFAULT_CLIENT_BINDING_ID, HANDLER_PARAMETER_QNAMES

Fields inherited from interface org.apache.axis2.jaxws.description.EndpointDescriptionWSDL

HTTP_WSDL_BINDING, SOAP_11_ADDRESS_ELEMENT, SOAP_12_ADDRESS_ELEMENT, SOAP11_WSDL_BINDING, SOAP12_WSDL_BINDING

Method Summary

Modifier and Type	Method	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.
jakarta.xml.ws.BindingType	getAnnoBindingType()
String	getAnnoBindingTypeValue()
Annotation	getAnnoFeature(String id)
jakarta.jws.HandlerChain	getAnnoHandlerChainAnnotation(Object sparseCompositeKey)
jakarta.xml.ws.ServiceMode	getAnnoServiceMode()
jakarta.xml.ws.Service.Mode	getAnnoServiceModeValue()
jakarta.jws.WebService	getAnnoWebService()
String	getAnnoWebServiceEndpointInterface()
String	getAnnoWebServiceName()
String	getAnnoWebServicePortName()
jakarta.xml.ws.WebServiceProvider	getAnnoWebServiceProvider()
String	getAnnoWebServiceServiceName()
String	getAnnoWebServiceTargetNamespace()
String	getAnnoWebServiceWSDLLocation()
org.apache.axis2.description.AxisService	getAxisService()
String	getBindingType()	Returns the binding type FOR A SERVER.
String	getClientBindingID()	Return the binding type FOR A CLIENT.
DescriptionBuilderComposite	getDescriptionBuilderComposite()	Return the DescriptionBuilderComposite, if any, used to build this service description.
String	getEndpointAddress()
EndpointInterfaceDescription	getEndpointInterfaceDescription()
HandlerChainsType	getHandlerChain()	Return the handler chain configuration information as a HandlerChainsType object.
HandlerChainsType	getHandlerChain(Object sparseCompositeKey)	Returns a schema derived java class containing the the handler configuration information.
int	getMTOMThreshold()	If MTOM is enabled, returns the threshold value.
String	getName()
jakarta.xml.ws.handler.PortInfo	getPortInfo()	Returns the JAX-WS handler PortInfo object for this endpoint.
QName	getPortQName()
Object	getProperty(String key)	Return the Object that corresponds to the property key supplied.
Set<WSDLValidatorElement>	getRequiredBindings()	Returns a list of all known bindings that should be supported based on the information in the WSDL.
org.apache.axis2.client.ServiceClient	getServiceClient()
ServiceDescription	getServiceDescription()
ServiceDescriptionImpl	getServiceDescriptionImpl()
jakarta.xml.ws.Service.Mode	getServiceMode()
QName	getServiceQName()
String	getTargetNamespace()
javax.wsdl.Binding	getWSDLBinding()
String	getWSDLBindingType()	Returns the namespace for the specific wsdl:binding extensibility element.
javax.wsdl.Definition	getWSDLDefinition()
javax.wsdl.Port	getWSDLPort()
javax.wsdl.Service	getWSDLService()
String	getWSDLSOAPAddress()	Return the SOAP Address from the WSDL for this port.
boolean	isEndpointBased()
boolean	isMTOMEnabled()	Signals whether or not MTOM has been turned on for the endpoint based on the annotation configuration.
boolean	isProviderBased()
boolean	isWSDLFullySpecified()	Is the WSDL definition fully specified for the endpoint (WSDL 1.1 port) represented by this EndpointDescription.
boolean	respectBinding()	Returns true if the contents of the <wsdl:binding> must be strictly respected by the runtime.
void	setClientBindingID(String clientBindingID)	Set the binding type FOR A CLIENT.
void	setEndpointAddress(String endpointAddress)
void	setHandlerChain(HandlerChainsType handlerChain)
void	setProperty(String key, Object value)	Store the property by the key specified.
void	setRespectBinding(boolean r)	Indicate whether or not strict binding support should be used.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ServiceMode_DEFAULT

public static final jakarta.xml.ws.Service.Mode ServiceMode_DEFAULT

BindingType_DEFAULT

public static final String BindingType_DEFAULT

See Also:

• Constant Field Values

Method Details

getPortQName

public QName getPortQName()

Specified by:

getPortQName in interface EndpointDescription

getServiceQName

public QName getServiceQName()

Specified by:

getServiceQName in interface EndpointDescription

getServiceDescription

public ServiceDescription getServiceDescription()

Specified by:

getServiceDescription in interface EndpointDescription

getServiceDescriptionImpl

public ServiceDescriptionImpl getServiceDescriptionImpl()

getEndpointInterfaceDescription

public EndpointInterfaceDescription getEndpointInterfaceDescription()

Specified by:

getEndpointInterfaceDescription in interface EndpointDescription

getAxisService

public org.apache.axis2.description.AxisService getAxisService()

Specified by:

getAxisService in interface EndpointDescription

getServiceClient

public org.apache.axis2.client.ServiceClient getServiceClient()

Specified by:

getServiceClient in interface EndpointDescription

isWSDLFullySpecified

public boolean isWSDLFullySpecified()

Description copied from interface: EndpointDescriptionWSDL

Is the WSDL definition fully specified for the endpoint (WSDL 1.1 port) represented by this EndpointDescription. If the WSDL is Partial, that means the Endpoint could not be created with the infomation contained in the WSDL file, and annotations were used.

Specified by:

isWSDLFullySpecified in interface EndpointDescriptionWSDL

Returns:

true if the WSDL was fully specified; false if it was partial WSDL

isProviderBased

public boolean isProviderBased()

Specified by:

isProviderBased in interface EndpointDescription

isEndpointBased

public boolean isEndpointBased()

Specified by:

isEndpointBased in interface EndpointDescription

getAnnoWebServiceWSDLLocation

public String getAnnoWebServiceWSDLLocation()

Specified by:

getAnnoWebServiceWSDLLocation in interface EndpointDescriptionJava

getAnnoWebServiceServiceName

public String getAnnoWebServiceServiceName()

Specified by:

getAnnoWebServiceServiceName in interface EndpointDescriptionJava

getAnnoWebServicePortName

public String getAnnoWebServicePortName()

Specified by:

getAnnoWebServicePortName in interface EndpointDescriptionJava

getAnnoWebServiceTargetNamespace

public String getAnnoWebServiceTargetNamespace()

Specified by:

getAnnoWebServiceTargetNamespace in interface EndpointDescriptionJava

getAnnoWebServiceProvider

public jakarta.xml.ws.WebServiceProvider getAnnoWebServiceProvider()

Specified by:

getAnnoWebServiceProvider in interface EndpointDescriptionJava

getAnnoWebService

public jakarta.jws.WebService getAnnoWebService()

Specified by:

getAnnoWebService in interface EndpointDescriptionJava

getAnnoWebServiceEndpointInterface

public String getAnnoWebServiceEndpointInterface()

Specified by:

getAnnoWebServiceEndpointInterface in interface EndpointDescriptionJava

getAnnoWebServiceName

public String getAnnoWebServiceName()

Specified by:

getAnnoWebServiceName in interface EndpointDescriptionJava

getAnnoServiceMode

public jakarta.xml.ws.ServiceMode getAnnoServiceMode()

Specified by:

getAnnoServiceMode in interface EndpointDescriptionJava

getServiceMode

public jakarta.xml.ws.Service.Mode getServiceMode()

Specified by:

getServiceMode in interface EndpointDescription

getAnnoServiceModeValue

public jakarta.xml.ws.Service.Mode getAnnoServiceModeValue()

Specified by:

getAnnoServiceModeValue in interface EndpointDescriptionJava

getAnnoBindingType

public jakarta.xml.ws.BindingType getAnnoBindingType()

Specified by:

getAnnoBindingType in interface EndpointDescriptionJava

getBindingType

public String getBindingType()

Description copied from interface: EndpointDescription

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.

Specified by:

getBindingType in interface EndpointDescription

Returns:

getAnnoBindingTypeValue

public String getAnnoBindingTypeValue()

Specified by:

getAnnoBindingTypeValue in interface EndpointDescriptionJava

setHandlerChain

public void setHandlerChain(HandlerChainsType handlerChain)

Specified by:

setHandlerChain in interface EndpointDescription

getHandlerChain

public HandlerChainsType getHandlerChain()

Description copied from interface: EndpointDescription

Return the handler chain configuration information as a HandlerChainsType object. This is the same as calling getHandlerChain(null).

Specified by:

getHandlerChain in interface EndpointDescription

See Also:

• EndpointDescription.getHandlerChain(Object)

getHandlerChain

public HandlerChainsType getHandlerChain(Object sparseCompositeKey)

Returns a schema derived java class containing the the handler configuration information. That information, returned in the HandlerChainsType object, is looked for in the following places in this order: - Set on the sparseComposite for the given key - Set on the composite - Read in from the file specified on HandlerChain annotation

Specified by:

getHandlerChain in interface EndpointDescription

Parameters:

sparseCompositeKey - May be null. If non-null, used to look for service-delegate specific sparse composite information.

Returns:

HandlerChainsType This is the top-level element for the Handler configuration file

getAnnoHandlerChainAnnotation

public jakarta.jws.HandlerChain getAnnoHandlerChainAnnotation(Object sparseCompositeKey)

isMTOMEnabled

public boolean isMTOMEnabled()

Description copied from interface: EndpointDescription

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.

Specified by:

isMTOMEnabled in interface EndpointDescription

Returns:

a boolean value

respectBinding

public boolean respectBinding()

Description copied from interface: EndpointDescription

Returns true if the contents of the <wsdl:binding> must be strictly respected by the runtime.

Specified by:

respectBinding in interface EndpointDescription

Returns:

a boolean value

setRespectBinding

public void setRespectBinding(boolean r)

Description copied from interface: EndpointDescription

Indicate whether or not strict binding support should be used.

Specified by:

setRespectBinding in interface EndpointDescription

addRequiredBinding

public boolean addRequiredBinding(WSDLValidatorElement element)

Description copied from interface: EndpointDescription

Adds the QName to a list of binding types that are required to be supported by the endpoint as defined in the WSDL.

Specified by:

addRequiredBinding in interface EndpointDescription

Returns:

getRequiredBindings

public Set<WSDLValidatorElement> getRequiredBindings()

Description copied from interface: EndpointDescription

Returns a list of all known bindings that should be supported based on the information in the WSDL.

Specified by:

getRequiredBindings in interface EndpointDescription

Returns:

getMTOMThreshold

public int getMTOMThreshold()

Description copied from interface: EndpointDescription

If MTOM is enabled, returns the threshold value.

Specified by:

getMTOMThreshold in interface EndpointDescription

Returns:

-1 if MTOM is not enabled, a positive integer value if one was configured.

getAnnoFeature

public Annotation getAnnoFeature(String id)

Specified by:

getAnnoFeature in interface EndpointDescriptionJava

getWSDLDefinition

public javax.wsdl.Definition getWSDLDefinition()

Specified by:

getWSDLDefinition in interface EndpointDescriptionWSDL

getWSDLService

public javax.wsdl.Service getWSDLService()

Specified by:

getWSDLService in interface EndpointDescriptionWSDL

getWSDLPort

public javax.wsdl.Port getWSDLPort()

Specified by:

getWSDLPort in interface EndpointDescriptionWSDL

getWSDLBinding

public javax.wsdl.Binding getWSDLBinding()

Specified by:

getWSDLBinding in interface EndpointDescriptionWSDL

getWSDLBindingType

public String getWSDLBindingType()

Description copied from interface: EndpointDescriptionWSDL

Returns the namespace for the specific wsdl:binding extensibility element. Typically, this is the <soap:binding> element that defines either a SOAP 1.1 or a SOAP 1.2 binding. IMPORTANT NOTE: The value returned is converted from the WSDL Binding type (which is the namespace on the assocaited binding extensibility element) to the corresponding value for the SOAPBinding annotation. For example, the following SOAP12 WSDL ... xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" ... <wsdl:binding ...> <soap12:binding ...> Would return the value jakarta.xml.ws.soap.SOAPBinding.SOAP12HTTP_BINDING which is "http://www.w3.org/2003/05/soap/bindings/HTTP/"

Specified by:

getWSDLBindingType in interface EndpointDescriptionWSDL

Returns:

String constants defined in jakarta.xml.ws.soap.SOAPBinding

getName

public String getName()

Specified by:

getName in interface EndpointDescription

getTargetNamespace

public String getTargetNamespace()

Specified by:

getTargetNamespace in interface EndpointDescription

getPortInfo

public jakarta.xml.ws.handler.PortInfo getPortInfo()

Description copied from interface: EndpointDescription

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

Specified by:

getPortInfo in interface EndpointDescription

Returns:

PortInfo

setClientBindingID

public void setClientBindingID(String clientBindingID)

Description copied from interface: EndpointDescription

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.

Specified by:

setClientBindingID in interface EndpointDescription

getClientBindingID

public String getClientBindingID()

Description copied from interface: EndpointDescription

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

Specified by:

getClientBindingID in interface EndpointDescription

Returns:

String representing the client binding type

setEndpointAddress

public void setEndpointAddress(String endpointAddress)

Specified by:

setEndpointAddress in interface EndpointDescription

getEndpointAddress

public String getEndpointAddress()

Specified by:

getEndpointAddress in interface EndpointDescription

setProperty

public void setProperty(String key,
 Object value)

Description copied from interface: EndpointDescription

Store the property by the key specified.

Specified by:

setProperty in interface EndpointDescription

getProperty

public Object getProperty(String key)

Description copied from interface: EndpointDescription

Return the Object that corresponds to the property key supplied.

Specified by:

getProperty in interface EndpointDescription

getWSDLSOAPAddress

public String getWSDLSOAPAddress()

Return the SOAP Address from the WSDL for this port.

Specified by:

getWSDLSOAPAddress in interface EndpointDescriptionWSDL

Returns:

The SOAP Address from the WSDL for this port or null.

getDescriptionBuilderComposite

public DescriptionBuilderComposite getDescriptionBuilderComposite()

Description copied from interface: EndpointDescription

Return the DescriptionBuilderComposite, if any, used to build this service description.

Specified by:

getDescriptionBuilderComposite in interface EndpointDescription

Returns:

toString

public String toString()

Overrides:

toString in class Object