oracle.soap.server
Interface ServiceManager

All Known Implementing Classes:

ServiceManagerImpl

public interface ServiceManager

Service Manager defines the interface to manage services. The service manager is used by the SOAP engine to deploy services, undeploy services, and access service deployment information. The service manager may cache deployment information and is responsible to maintain the cache.

The HTTP server provides security for the service manager. The service manager can be configured with a URL that requests must be made to in order for the request to be accepted. If a SOAP request for the service manager is made to any other URL, the request will be rejected. This URL should be an alias to the SOAP servlet, and HTTP security can be set to control which users can post to the URL.

Method Summary

void	deploy(ServiceDeploymentDescriptor sd) Deploy the given service.
void	destroy() Cleanup the service manager.
java.lang.String	getDefaultConfigManagerClassname() Get the class name of the default configuration manager.
java.lang.String	getRequiredRequestURI() Get the URI that service manager requests must be made to in order to be accepted.
void	init(java.util.Properties options, ProviderManager providerManager, javax.servlet.ServletContext context, ConfigManager configManager) Initialize the service manager.
java.lang.String[]	list() Get a list of service ids for all services that have been deployed, regardless of the provider.
ServiceDeploymentDescriptor	query(java.lang.String serviceId) Get the deployment descriptor for the given service.
ServiceDeploymentDescriptor	undeploy(java.lang.String serviceId) Undeploy the given service, and return its descriptor.
java.lang.String	version() Returns the current soap version

Method Detail

getDefaultConfigManagerClassname

public java.lang.String getDefaultConfigManagerClassname()

Get the class name of the default configuration manager.

Returns:

The default configuration manager fully qualified class name.

init

public void init(java.util.Properties options,
                 ProviderManager providerManager,
                 javax.servlet.ServletContext context,
                 ConfigManager configManager)
          throws SOAPException

Initialize the service manager. The implementation should be able to handle a null value for the provider manager.

Parameters:

options - The options required to setup access to the service deployment information.

providerManager - The provider manager that is managing provider deployment information for the SOAP server, or null if the provider manager is not supplied. The service manager may want to use the provider manager to confirm the existence of the provider when a new service is deployed.

context - The servlet context.

configManager - The configuration manager for this service manager.

Throws:

SOAPException - Unable to access the service deployment information.

destroy

public void destroy()
             throws SOAPException

Cleanup the service manager.

Throws:

SOAPException - Unable to cleanup the service manager.

getRequiredRequestURI

public java.lang.String getRequiredRequestURI()

Get the URI that service manager requests must be made to in order to be accepted. Requests made to any other URI must be rejected.

Returns:

The request URI for service manager requests, or null if any URI can be used.

undeploy

public ServiceDeploymentDescriptor undeploy(java.lang.String serviceId)
                                     throws SOAPException

Undeploy the given service, and return its descriptor.

Parameters:

serviceId - The URI of the service to undeploy.

Returns:

The descriptor containing the deployment information for the service that has been undeployed.

Throws:

SOAPException - If the service is not found or failed to undeploy.

deploy

public void deploy(ServiceDeploymentDescriptor sd)
            throws SOAPException

Deploy the given service.

Parameters:

sd - The service descriptor for the service to deploy.

Throws:

SOAPException - If unable to deploy.

query

public ServiceDeploymentDescriptor query(java.lang.String serviceId)
                                  throws SOAPException

Get the deployment descriptor for the given service.

Parameters:

serviceId - The unique URI of the service.

Returns:

The descriptor containing the deployment information for the given service.

Throws:

SOAPException - If the service is not found.

list

public java.lang.String[] list()
                        throws SOAPException

Get a list of service ids for all services that have been deployed, regardless of the provider.

Returns:

An array of deployed service ids.

Throws:

SOAPException - Unable to list service ids.

version

public java.lang.String version()
                         throws SOAPException

Returns the current soap version

Returns:

A soap version string.

Throws:

SOAPException - Unable to obtain version