org.apache.axis2.osgi.core

Interface SOAPProvider

public interface SOAPProvider

SOAPProvider is an interface for generic SOAP functionality. Use this interface to register SOAPProvider services with the OSGi runtime using the BundleContext.registerService() methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROVIDER_MAJOR_VERSION The major version of the SOAPProvider implementation.
static String	PROVIDER_MINOR_VERSION The minor version of the SOAPProvider implementation.
static String	PROVIDER_NAME The name of the SOAPProvider implementation.

Method Summary

Modifier and Type	Method and Description
void	deployService(String srvName, Class srvClass, Object srvObject, String handlerChain) Deploys an Object as a WebService using the implementation's default binding type.
void	deployService(String srvName, String bindingType, Class srvClass, Object srvObject, String handlerChain) Deploys an Object as a WebService using a specified binding type The service is deployed into the provider's default application context.
void	deployService(WebApp webApp, String srvName, Class srvClass, Object srvObject, String handlerChain) Deploys an Object as a WebService using the provider's default binding type.
void	deployService(WebApp webApp, String srvName, String bindingType, Class srvClass, Object srvObject, String handlerChain) Deploys an Object as a WebService using a specified binding type The service is deployed into the specified WebApp context
Object	getProviderDeployer()
Object	getProviderDeployer(WebApp webApp)
Object	getProviderEngine()
String	getProviderName() Getter method for the implementation's provider name.
String	getProviderVersion() Getter method for the implementation's version.
WebApp	getWebApp(org.osgi.framework.Bundle bundle, String contextPath, boolean create) Gets a web application from the provider for the given context path, using the provided bundle as the location for the engine's configuration information
WebApp	getWebApp(String contextPath, boolean create) Gets a web application from the provider for the given context path.
void	undeployService(String srvName, Class srvClass)
void	undeployService(WebApp webApp, String srvName, Class srvClass)

Field Detail

PROVIDER_NAME

static final String PROVIDER_NAME

The name of the SOAPProvider implementation. Use this as the key when constructing the service's properties for registration with the OSGi runtime.

See Also:

Constant Field Values

PROVIDER_MAJOR_VERSION

static final String PROVIDER_MAJOR_VERSION

The major version of the SOAPProvider implementation. Use this as the key when constructing the service's properties for registration with the OSGi runtime.

See Also:

Constant Field Values

PROVIDER_MINOR_VERSION

static final String PROVIDER_MINOR_VERSION

The minor version of the SOAPProvider implementation. Use this as the key when constructing the service's properties for registration with the OSGi runtime.

See Also:

Constant Field Values

Method Detail

getProviderName

String getProviderName()

Getter method for the implementation's provider name. This name should be the same as the one used during the registration of the SOAPProvider service

Returns:

the Provider Name

getProviderVersion

String getProviderVersion()

Getter method for the implementation's version. This name should be constructed from the major and minor versions used during registration of the SOAPProvider service.

Returns:

the Provider Version

getProviderEngine

Object getProviderEngine()

getProviderDeployer

Object getProviderDeployer()

getProviderDeployer

Object getProviderDeployer(WebApp webApp)

deployService

void deployService(String srvName,
                   Class srvClass,
                   Object srvObject,
                   String handlerChain)
            throws Exception

Deploys an Object as a WebService using the implementation's default binding type. The service is deployed into the provider's default application context.

Parameters:

srvName - the display name of the service

srvClass - the class or interface that should be exposed. Specifying an interface allows only the desired methods of the service object to be published.

srvObject - the actual implementation

Throws:

Exception

deployService

void deployService(String srvName,
                   String bindingType,
                   Class srvClass,
                   Object srvObject,
                   String handlerChain)
            throws Exception

Deploys an Object as a WebService using a specified binding type The service is deployed into the provider's default application context.

Parameters:

srvName - the display name of the service

bindingType - the name of the desired binding type

srvClass - the class or interface that should be exposed. Specifying an interface allows only the desired methods of the service object to be published.

srvObject - the actual implementation

Throws:

Exception

deployService

void deployService(WebApp webApp,
                   String srvName,
                   Class srvClass,
                   Object srvObject,
                   String handlerChain)
            throws Exception

Deploys an Object as a WebService using the provider's default binding type. The service is deployed into the specified WebApp context

Parameters:

webApp - the target web application context

srvName - the display name of the service

srvClass - the class or interface that should be exposed. Specifying an interface allows only the desired methods of the service object to be published.

srvObject - the actual implementation

Throws:

Exception

deployService

void deployService(WebApp webApp,
                   String srvName,
                   String bindingType,
                   Class srvClass,
                   Object srvObject,
                   String handlerChain)
            throws Exception

Deploys an Object as a WebService using a specified binding type The service is deployed into the specified WebApp context

Parameters:

webApp - the target web application context

srvName - the display name of the service

bindingType - the name of the desired binding type

srvClass - the class or interface that should be exposed. Specifying an interface allows only the desired methods of the service object to be published.

srvObject - the actual implementation

Throws:

Exception

undeployService

void undeployService(String srvName,
                     Class srvClass)
              throws Exception

Throws:

Exception

undeployService

void undeployService(WebApp webApp,
                     String srvName,
                     Class srvClass)
              throws Exception

Throws:

Exception

getWebApp

WebApp getWebApp(String contextPath,
                 boolean create)
          throws Exception

Gets a web application from the provider for the given context path.

Parameters:

contextPath - the context path of the desired WebApp

create - if true, create the WebApp if it does not exits.

Returns:

return the WebApp

Throws:

Exception

getWebApp

WebApp getWebApp(org.osgi.framework.Bundle bundle,
                 String contextPath,
                 boolean create)
          throws Exception

Gets a web application from the provider for the given context path, using the provided bundle as the location for the engine's configuration information

Parameters:

contextPath - the context path of the desired WebApp

create - if true, create the WebApp if it does not exits.

Returns:

return the WebApp

Throws:

Exception