org.ow2.easybeans.api.bean.info
Interface IWebServiceInfo

public interface IWebServiceInfo

The IWebServiceInfo contains descriptions information about the web service exposure of an EJB. This information is available at runtime.

Author:

Guillaume Sauthier

Method Summary

String	getAuthMethod()
String	getContextRoot()
String	getEndpointAddress()
String	getEndpointInterface() The service-endpoint-interface element contains the fully-qualified name of the port component's Service Endpoint Interface.
org.ow2.util.ee.metadata.common.api.xml.struct.IHandlerChains	getHandlerChains() HandlerChain can be defined such that the handlers in the handlerchain operate,all ports of a service, on a specific port or on a list of protocol-bindings.
List<String>	getHttpMethods()
String	getPortComponentName() The port-component-name specifies a port component's name.
QName	getPortName() Defines the name space and local name part of the WSDL port QName.
String	getProtocolBinding() Used to specify the protocol binding used by the port-component.
String	getRealmName()
QName	getServiceName() Defines the name space and local name part of the WSDL service QName.
String	getTransportGuarantee()
String	getWsdlLocation()
String	getWsdlPublicationDirectory() This optional attribute is used to store where the user wants the WSDL of its endpoint published.
boolean	isMTOMEnabled() Used to enable or disable SOAP MTOM/XOP mechanism for an endpoint implementation.

Method Detail

getWsdlLocation

String getWsdlLocation()

Returns:

the WSDL location URL

getPortComponentName

String getPortComponentName()

The port-component-name specifies a port component's name. This name is assigned by the module producer to name the service implementation bean in the module's deployment descriptor. The name must be unique among the port component names defined in the same module. Mapped to @WebService.name (if not specified then its default value as specified in the JSR-181), only if it is unique in the module. If the above is not unique, then fully qualified name of the Bean class is used to guarantee uniqueness.

Returns:

Port component's unique name

getServiceName

QName getServiceName()

Defines the name space and local name part of the WSDL service QName. This is required to be specified for port components that are JAX-WS Provider implementations.

Returns:

wsdl:service QName

getPortName

QName getPortName()

Defines the name space and local name part of the WSDL port QName. This is not required to be specified for port components that are JAX-WS Provider implementations.

Returns:

wsdl:port QName

getEndpointInterface

String getEndpointInterface()

The service-endpoint-interface element contains the fully-qualified name of the port component's Service Endpoint Interface.
This may not be specified in case there is no Service Enpoint Interface as is the case with directly using an implementation class with the @WebService annotation.
When the port component is a ws.Provider implementation this is not specified.

Returns:

the FQN of the service endpoint interface

isMTOMEnabled

boolean isMTOMEnabled()

Used to enable or disable SOAP MTOM/XOP mechanism for an endpoint implementation.

Returns:

true if MTOM/XOP has to be enabled for this port-component

getProtocolBinding

String getProtocolBinding()

Used to specify the protocol binding used by the port-component. If this element is not specified, then the default binding is used (SOAP 1.1 over HTTP).
Unrecognized alias (starting with ## may be returned). Recognized aliases (##SOAP11_HTTP, ##SOAP11_HTTP_MTOM, ##SOAP12_HTTP, ##SOAP12_HTTP_MTOM, ##XML_HTTP) have been resolved.

Returns:

The URI representing the protocol binding to be used by this port-component

getHandlerChains

org.ow2.util.ee.metadata.common.api.xml.struct.IHandlerChains getHandlerChains()

HandlerChain can be defined such that the handlers in the handlerchain operate,all ports of a service, on a specific port or on a list of protocol-bindings. The choice of elements service-name-pattern, port-name-pattern and protocol-bindings are used to specify whether the handlers in handler-chain are for a service, port or protocol binding. If none of these choices are specified with the handler-chain element then the handlers specified in the handler-chain will be applied on everything.

Returns:

The parsed HandlerChains from descriptor (possibliy null).

getWsdlPublicationDirectory

String getWsdlPublicationDirectory()

This optional attribute is used to store where the user wants the WSDL of its endpoint published.

Returns:

an absolute path to a directory (may not exists)

getEndpointAddress

String getEndpointAddress()

Returns:

the endpoint address

getContextRoot

String getContextRoot()

Returns:

the user specified context-root to be created for this EJB endpoint.

getRealmName

String getRealmName()

Returns:

the user specified real name to be used for the secured web context.

getTransportGuarantee

String getTransportGuarantee()

Returns:

the user specified transport-guarantee to be used for the secured web context.

getAuthMethod

String getAuthMethod()

Returns:

the user specified auth-method to be used for the secured web context.

getHttpMethods

List<String> getHttpMethods()

Returns:

the user specified list of http-methods to be used for the secured web context.