org.apache.soap.server
Class DeploymentDescriptor

java.lang.Object
  |
  +--org.apache.soap.server.DeploymentDescriptor

public class DeploymentDescriptor

extends java.lang.Object

implements java.io.Serializable

This class represents the deployment information about a SOAP service.

Author:

Sanjiva Weerawarana (sanjiva@watson.ibm.com), Matthew J. Duftler (duftler@us.ibm.com)

See Also:

Serialized Form

Field Summary

protected boolean	checkMustUnderstands
protected java.lang.String[]	faultListener
protected java.lang.String	id
protected boolean	isStatic
protected TypeMapping[]	mappings
protected java.lang.String[]	methods
protected java.util.Hashtable	props
static byte	PROVIDER_JAVA
static byte	PROVIDER_SCRIPT_FILE
static byte	PROVIDER_SCRIPT_STRING
static byte	PROVIDER_USER_DEFINED
protected java.lang.String	providerClass
protected byte	providerType
protected int	scope
static int	SCOPE_APPLICATION
static int	SCOPE_REQUEST
static int	SCOPE_SESSION
protected java.lang.String	scriptFilenameOrString
protected java.lang.String	scriptLanguage
static int	SERVICE_TYPE_MESSAGE
static int	SERVICE_TYPE_RPC
protected java.lang.String	serviceClass
protected int	serviceType

Constructor Summary

DeploymentDescriptor()
Constructor.

Method Summary

SOAPFaultRouter	buildFaultRouter(SOAPContext ctxt)
static SOAPMappingRegistry	buildSOAPMappingRegistry(DeploymentDescriptor dd, SOAPContext ctx) Utility to generate an XML serialization registry from all the type mappings registered into a deployment descriptor.
static DeploymentDescriptor	fromXML(org.w3c.dom.Element root) Build a deployment descriptor from a document corresponding to the deployment descriptor DTD.
static DeploymentDescriptor	fromXML(java.io.Reader rd)
boolean	getCheckMustUnderstands()
java.lang.String	getDefaultSMRClass()
java.lang.String[]	getFaultListener()
java.lang.String	getID()
boolean	getIsStatic()
TypeMapping[]	getMappings() Return the registered mappings.
java.lang.String[]	getMethods()
java.util.Hashtable	getProps()
java.lang.String	getProviderClass()
byte	getProviderType()
int	getScope()
java.lang.String	getScriptFilenameOrString()
java.lang.String	getScriptLanguage()
java.lang.String	getServiceClass()
int	getServiceType()
void	setCheckMustUnderstands(boolean doIt)
void	setDefaultSMRClass(java.lang.String _defaultSMRClass)
void	setFaultListener(java.lang.String[] _faultListener)
void	setID(java.lang.String id) ID of this service.
void	setIsStatic(boolean isStatic) For Java providers, is it static or not.
void	setMappings(TypeMapping[] mappings) Type mappings between XML types of certain encodings and Java types.
void	setMethods(java.lang.String[] methods) Methods provided by the service.
void	setProps(java.util.Hashtable props)
void	setProviderClass(java.lang.String providerClass) For Java providers, the class providing the service.
void	setProviderType(byte providerType) Type of provider.
void	setScope(int scope) Lifecyle of the object providing the service.
void	setScriptFilenameOrString(java.lang.String scriptFilenameOrString)
void	setScriptLanguage(java.lang.String scriptLanguage)
void	setServiceClass(java.lang.String serviceClass) Classname used to load provider/service
void	setServiceType(int serviceType) Type of the service: message or procedural service.
java.lang.String	toString() What do u think this does?
void	toXML(java.io.Writer pr) Write out the deployment descriptor according to the the deployment descriptor DTD.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SERVICE_TYPE_RPC

public static final int SERVICE_TYPE_RPC

SERVICE_TYPE_MESSAGE

public static final int SERVICE_TYPE_MESSAGE

SCOPE_REQUEST

public static final int SCOPE_REQUEST

SCOPE_SESSION

public static final int SCOPE_SESSION

SCOPE_APPLICATION

public static final int SCOPE_APPLICATION

PROVIDER_JAVA

public static final byte PROVIDER_JAVA

PROVIDER_SCRIPT_FILE

public static final byte PROVIDER_SCRIPT_FILE

PROVIDER_SCRIPT_STRING

public static final byte PROVIDER_SCRIPT_STRING

PROVIDER_USER_DEFINED

public static final byte PROVIDER_USER_DEFINED

id

protected java.lang.String id

serviceType

protected int serviceType

scope

protected int scope

providerType

protected byte providerType

providerClass

protected java.lang.String providerClass

serviceClass

protected java.lang.String serviceClass

props

protected java.util.Hashtable props

isStatic

protected boolean isStatic

scriptFilenameOrString

protected java.lang.String scriptFilenameOrString

scriptLanguage

protected java.lang.String scriptLanguage

methods

protected java.lang.String[] methods

mappings

protected TypeMapping[] mappings

faultListener

protected java.lang.String[] faultListener

checkMustUnderstands

protected boolean checkMustUnderstands

Constructor Detail

DeploymentDescriptor

public DeploymentDescriptor()

Constructor.

Parameters:

id - the name of the service. Should be of valid URI syntax.

Method Detail

setID

public void setID(java.lang.String id)

ID of this service.

getID

public java.lang.String getID()

getCheckMustUnderstands

public boolean getCheckMustUnderstands()

setCheckMustUnderstands

public void setCheckMustUnderstands(boolean doIt)

setServiceType

public void setServiceType(int serviceType)

Type of the service: message or procedural service. Defaults to being a procedural service. The difference is that if its procedural then the methods are invoked by decoding the children of the first body element as being parameters of the method call. If its message-oriented, then no decoding is done and the method is invoked giving the envelope as an argument.

getServiceType

public int getServiceType()

setScope

public void setScope(int scope)

Lifecyle of the object providing the service.

getScope

public int getScope()

setDefaultSMRClass

public void setDefaultSMRClass(java.lang.String _defaultSMRClass)

getDefaultSMRClass

public java.lang.String getDefaultSMRClass()

setMethods

public void setMethods(java.lang.String[] methods)

Methods provided by the service.

getMethods

public java.lang.String[] getMethods()

setProviderType

public void setProviderType(byte providerType)

Type of provider.

getProviderType

public byte getProviderType()

setServiceClass

public void setServiceClass(java.lang.String serviceClass)

Classname used to load provider/service

getServiceClass

public java.lang.String getServiceClass()

getProps

public java.util.Hashtable getProps()

setProps

public void setProps(java.util.Hashtable props)

setProviderClass

public void setProviderClass(java.lang.String providerClass)

For Java providers, the class providing the service.

getProviderClass

public java.lang.String getProviderClass()

setIsStatic

public void setIsStatic(boolean isStatic)

For Java providers, is it static or not.

getIsStatic

public boolean getIsStatic()

setScriptLanguage

public void setScriptLanguage(java.lang.String scriptLanguage)

getScriptLanguage

public java.lang.String getScriptLanguage()

setScriptFilenameOrString

public void setScriptFilenameOrString(java.lang.String scriptFilenameOrString)

getScriptFilenameOrString

public java.lang.String getScriptFilenameOrString()

setMappings

public void setMappings(TypeMapping[] mappings)

Type mappings between XML types of certain encodings and Java types.

Parameters:

map - the structure containing the mapping info

getMappings

public TypeMapping[] getMappings()

Return the registered mappings.

getFaultListener

public java.lang.String[] getFaultListener()

setFaultListener

public void setFaultListener(java.lang.String[] _faultListener)

buildFaultRouter

public SOAPFaultRouter buildFaultRouter(SOAPContext ctxt)

toXML

public void toXML(java.io.Writer pr)

Write out the deployment descriptor according to the the deployment descriptor DTD.

fromXML

public static DeploymentDescriptor fromXML(java.io.Reader rd)
                                    throws java.lang.IllegalArgumentException

fromXML

public static DeploymentDescriptor fromXML(org.w3c.dom.Element root)
                                    throws java.lang.IllegalArgumentException

Build a deployment descriptor from a document corresponding to the deployment descriptor DTD.

toString

public java.lang.String toString()

What do u think this does?

Overrides:

toString in class java.lang.Object

buildSOAPMappingRegistry

public static SOAPMappingRegistry buildSOAPMappingRegistry(DeploymentDescriptor dd,
                                                           SOAPContext ctx)

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