org.ow2.jonas.ws.jaxrpc
Interface IJAXRPCService

All Superinterfaces:

Service

public interface IJAXRPCService
extends Service

WebServices Service interface.

Author:

Guillaume Sauthier

Field Summary

static String	CLASSLOADER_CTX_PARAM classloader Context param.
static String	ISINEAR_CTX_PARAM isInEar Context Param.
static String	PARENT_OBJECTNAME_CTX_PARAM parentObjectName Context Param.
static String	UNPACK_DIRECTORY_CTX_PARAM Directory (as a File) where is unpacked the deployed archive.
static String	WARURL_CTX_PARAM warURL Context Param.

Method Summary

String	applyWSGen(org.ow2.util.ee.deploy.api.deployable.IDeployable<?> deployable) Apply WSGen on the given deployable.
Reference	buildServiceRef(IServiceRefDesc rd, ClassLoader loader) buildServiceRef from WS ref descriptor.
void	completeWSDeployment(Context ctx) Complete the WebServices Deployment (add informations in web environment).
void	deployWebServices(Context ctx) explore the context classloader to find Web service deployment descriptor (for endpoints) and service-ref element within standard deployment descriptor (for clients).
boolean	isAutoWsGenEngaged() Automatic WSGen is enabled ?
void	removeCache(ClassLoader cl) Remove the WebServices descriptors associated to the given ClassLoader.
void	undeployWebServices(Context ctx) Undeploy the WebServices : unpublish WSDL + unregister MBeans.

Methods inherited from interface org.ow2.jonas.service.Service

getName, init, isStarted, setName, start, stop

Field Detail

CLASSLOADER_CTX_PARAM

static final String CLASSLOADER_CTX_PARAM

classloader Context param.

See Also:

Constant Field Values

PARENT_OBJECTNAME_CTX_PARAM

static final String PARENT_OBJECTNAME_CTX_PARAM

parentObjectName Context Param.

See Also:

Constant Field Values

ISINEAR_CTX_PARAM

static final String ISINEAR_CTX_PARAM

isInEar Context Param.

See Also:

Constant Field Values

WARURL_CTX_PARAM

static final String WARURL_CTX_PARAM

warURL Context Param.

See Also:

Constant Field Values

UNPACK_DIRECTORY_CTX_PARAM

static final String UNPACK_DIRECTORY_CTX_PARAM

Directory (as a File) where is unpacked the deployed archive.

See Also:

Constant Field Values

Method Detail

deployWebServices

void deployWebServices(Context ctx)
                       throws WSException

explore the context classloader to find Web service deployment descriptor (for endpoints) and service-ref element within standard deployment descriptor (for clients). It registers each endpoints in WS engine publishing relative WSDLs, and it instanciates and binds in the registry each clients classes.

Parameters:

ctx - the context containing the configuration to deploy the wars.
This context contains the following parameters :
- jarUrls the list of the urls of the jars to deploy.
- warUrls the list of the urls of the wars to deploy.
- parentClassLoader the parent classLoader of the wars.
- earClassLoader the ear classLoader of the j2ee app.
- altDDs the optional URI of deployment descriptor.

Throws:

WSException - if an error occurs during the deployment.

removeCache

void removeCache(ClassLoader cl)

Remove the WebServices descriptors associated to the given ClassLoader.

Parameters:

cl - the key ClassLoader

completeWSDeployment

void completeWSDeployment(Context ctx)
                          throws WSException

Complete the WebServices Deployment (add informations in web environment).

Parameters:

ctx - Context containing the key ClassLoader

Throws:

WSException - When Endpoints URLs binding fails

buildServiceRef

Reference buildServiceRef(IServiceRefDesc rd,
                          ClassLoader loader)
                          throws NamingException

buildServiceRef from WS ref descriptor.

Parameters:

rd - WS ref descriptor

Throws:

NamingException

undeployWebServices

void undeployWebServices(Context ctx)
                         throws WSException

Undeploy the WebServices : unpublish WSDL + unregister MBeans.

Parameters:

ctx - Context containing undeployment informations

Throws:

WSException - When undeployment fails

isAutoWsGenEngaged

boolean isAutoWsGenEngaged()

Automatic WSGen is enabled ?

Returns:

true if automatic WSGen needs to be Called.

applyWSGen

String applyWSGen(org.ow2.util.ee.deploy.api.deployable.IDeployable<?> deployable)
                  throws WSException

Apply WSGen on the given deployable.

Parameters:

deployable - the deployable to use

Returns:

the modified file or the original file if WSGen has not been launched.

Throws:

WSException - If WSGen cannot be applied.