All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class oracle.soap.server.ServiceDeploymentDescriptor

java.lang.Object
   |
   +----oracle.soap.server.ServiceDeploymentDescriptor

public final class ServiceDeploymentDescriptor

extends Object

implements Serializable

ServiceDeploymentDescriptor defines the deployment information for a SOAP service, independent of its provider type. The class supports any number of named provider options, which allows the descriptor to be easily extended (without code changes) for new types of providers.

m_faultListener

m_id

m_methods

m_providerId

m_providerOptions

m_providerType

m_scope

m_serviceType

m_sqlMap

m_typeMappings

SCOPE_APPLICATION

SCOPE_REQUEST

SCOPE_SESSION

SERVICE_TYPE_MESSAGE

SERVICE_TYPE_RPC

ServiceDeploymentDescriptor()

Construct a new service descriptor.

buildFaultRouter()

Get the fault router.

buildSOAPMappingRegistry(ServiceDeploymentDescriptor)

Utility to generate an XML serialization registry from all the type mappings registered into a deployment descriptor.

buildSqlClassMap(ServiceDeploymentDescriptor)

Utility to generate a map from SQL type to Java Class using the type mapping information from the deployment descriptor.

fromXML(Element)

Populate the ServiceDeploymentDescriptor with information from the given document, which is the XML representation of the descriptor.

getDefaultSMRClass()

Get the default SOAP mapping registry class.

getFaultListener()

Get the fault listener list.

getId()

Get the service id.

getMethods()

Get the list of methods that are provided by this service.

getProviderId()

Get the provider id for this service.

getProviderOptions()

Get the provider-specific options.

getProviderType()

Get the provider type.

getScope()

Get the scope.

getServiceType()

Get the service type.

getSqlMap()

Get the SQL type to Java type map.

getTypeMappings()

Get the XML-Java type mappings, which define how to deserialize XML into Java and serialize Java into XML.

isMethodValid(String)

Determine if the given method is valid for this service.

setDefaultSMRClass(String)

Set the default SOAP mapping registry class.

setFaultListener(String[])

Set the fault listener list.

setId(String)

Set the service id, which must be a valid URI.

setMethods(String[])

Set the list of methods that are provided by this service.

setProviderId(String)

Set the id of the provider for this service.

setProviderOptions(Hashtable)

Set the provider-specific options.

setProviderType(String)

Set the provider type.

setScope(int)

Set the execution scope.

setServiceType(int)

Set the service type.

setSqlMap(Hashtable)

Set the map that maps from SQL type to Java type.

setTypeMappings(TypeMapping[])

Set the XML-Java type mappings, which define how to deserialize XML into Java and serialize Java into XML.

toString()

Get a printable representation of this descriptor.

toXML(Writer)

Write out the service deployment descriptor as XML.

 public static final int SERVICE_TYPE_RPC

 public static final int SERVICE_TYPE_MESSAGE

 public static final int SCOPE_REQUEST

 public static final int SCOPE_SESSION

 public static final int SCOPE_APPLICATION

 protected String m_id

 protected int m_serviceType

 protected String m_providerType

 protected String m_providerId

 protected int m_scope

 protected String m_methods[]

 protected Hashtable m_providerOptions

 protected TypeMapping m_typeMappings[]

 protected Hashtable m_sqlMap

 protected String m_faultListener[]

 public ServiceDeploymentDescriptor()

Construct a new service descriptor.

 public void setId(String id)

Set the service id, which must be a valid URI.

Parameters:

id - The service URI.

 public String getId()

Get the service id.

Returns:

The service id, which is a URI.

 public void setProviderId(String providerId)

Set the id of the provider for this service.

Parameters:

providerId - The provider's id for this service.

 public String getProviderId()

Get the provider id for this service.

Returns:

The provider id.

 public void setMethods(String methods[])

Set the list of methods that are provided by this service.

Parameters:

methods - The list of provided methods.

 public String[] getMethods()

Get the list of methods that are provided by this service.

Returns:

The list of provided methods.

 public void setScope(int scope)

Set the execution scope.

Parameters:

scope - The execution scope, which is one of the SCOPE_xxx constants.

 public int getScope()

Get the scope.

Returns:

The scope, which is one of the SCOPE_xxx constants.

 public void setServiceType(int serviceType)

Set the service type. DLD: exlain RPC vs one-way message.

Parameters:

serviceType - The service type, which is one of the SERVICE_TYPE_xxx constants.

 public int getServiceType()

Get the service type.

Returns:

The service type, which is one of the SERVICE_TYPE_xxx constants.

 public void setProviderType(String providerType)

Set the provider type.

Parameters:

providerType - The provider type, which can be any string. The provider type is used to validate the XML service descriptor (for the provider-specific options).

 public String getProviderType()

Get the provider type.

Returns:

The provider type.

 public void setProviderOptions(Hashtable providerOptions)

Set the provider-specific options.

Parameters:

providerOptions - The name-value pairs that represent the provider-specific options for this service.

 public Hashtable getProviderOptions()

Get the provider-specific options.

Returns:

The name-value pairs that represent the provider-specific options for this service.

 public void setFaultListener(String faultListener[])

Set the fault listener list.

Parameters:

faultListener - The list of class names that are fault listeners for this service.

 public String[] getFaultListener()

Get the fault listener list.

Returns:

The list of class names that are fault listeners for this service.

 public SOAPFaultRouter buildFaultRouter()

Get the fault router.

Returns:

The fault router that is built from the service's fault listeners.

 public void setTypeMappings(TypeMapping typeMappings[])

Set the XML-Java type mappings, which define how to deserialize XML into Java and serialize Java into XML.

Parameters:

typeMappings - The type mappings.

 public TypeMapping[] getTypeMappings()

Get the XML-Java type mappings, which define how to deserialize XML into Java and serialize Java into XML.

Returns:

The type mappings.

 public void setSqlMap(Hashtable sqlMap)

Set the map that maps from SQL type to Java type.

Parameters:

sqlMap - The SQL type to Java class map.

 public Hashtable getSqlMap()

Get the SQL type to Java type map.

Returns:

The SQL type to Java class map.

 public void setDefaultSMRClass(String defaultSMRClass)

Set the default SOAP mapping registry class.

Parameters:

defaultSMRClass - The default SOAP mapping registry class.

 public String getDefaultSMRClass()

Get the default SOAP mapping registry class.

Returns:

The default SOAP mapping registry class.

 public boolean isMethodValid(String methodName)

Determine if the given method is valid for this service.

Returns:

true if the method is valid for this service, else false.

 public static ServiceDeploymentDescriptor fromXML(Element root)

Populate the ServiceDeploymentDescriptor with information from the given document, which is the XML representation of the descriptor.

Parameters:

root - The root of the XML document that represents the service descriptor.

Returns:

The ServiceDeploymentDescriptor that contains the information from the document.

Throws: IllegalArgumentException

Invalid document.

 public void toXML(Writer pr)

Write out the service deployment descriptor as XML.

Parameters:

pr - The writer for the XML output.

 public String toString()

Get a printable representation of this descriptor.

Overrides:

toString in class Object

 public static SOAPMappingRegistry buildSOAPMappingRegistry(ServiceDeploymentDescriptor sdd)

Utility to generate an XML serialization registry from all the type mappings registered into a deployment descriptor.

Parameters:

dd - the deployment descriptor

Returns:

the xml serialization registry

 public static Hashtable buildSqlClassMap(ServiceDeploymentDescriptor sdd) throws SOAPException

Utility to generate a map from SQL type to Java Class using the type mapping information from the deployment descriptor.

Parameters:

sdd - The service deployment descriptor to use.

Returns:

The type to Class map.

Throws: SOAPException

Failed to generate map.

All Packages  Class Hierarchy  This Package  Previous  Next  Index