org.jboss.axis.deployment.wsdd
Class WSDDDeployment

java.lang.Object
  extended byorg.jboss.axis.deployment.wsdd.WSDDConstants (src) 
      extended byorg.jboss.axis.deployment.wsdd.WSDDElement (src) 
          extended byorg.jboss.axis.deployment.wsdd.WSDDDeployment
All Implemented Interfaces:
EngineConfiguration (src) , WSDDEngineConfiguration (src) , WSDDTypeMappingContainer (src)
Direct Known Subclasses:
Deployment (src)

public class WSDDDeployment
extends WSDDElement (src)
implements WSDDTypeMappingContainer (src) , WSDDEngineConfiguration (src)

WSDD deployment element


Field Summary
 
Fields inherited from class org.jboss.axis.deployment.wsdd.WSDDConstants (src)
ATTR_ATTACHMENT_FORMAT, ATTR_CLASS, ATTR_CLASSNAME, ATTR_DESERIALIZER, ATTR_ENCSTYLE, ATTR_INHEADER, ATTR_LANG_SPEC_TYPE, ATTR_LOCKED, ATTR_MODE, ATTR_NAME, ATTR_ONEWAY, ATTR_OUTHEADER, ATTR_PIVOT, ATTR_PROVIDER, ATTR_QNAME, ATTR_RETHEADER, ATTR_RETQNAME, ATTR_RETTYPE, ATTR_SERIALIZER, ATTR_SOAPACTORNAME, ATTR_STREAMING, ATTR_STYLE, ATTR_TYPE, ATTR_USE, ATTR_VALUE, BEAN_DESERIALIZER_FACTORY, BEAN_SERIALIZER_FACTORY, ELEM_WSDD_BEANMAPPING, ELEM_WSDD_CHAIN, ELEM_WSDD_DEPLOY, ELEM_WSDD_DOC, ELEM_WSDD_ELEMENTMAPPING, ELEM_WSDD_ENDPOINTURL, ELEM_WSDD_FAULT, ELEM_WSDD_FAULTFLOW, ELEM_WSDD_GLOBAL, ELEM_WSDD_HANDLER, ELEM_WSDD_JAXRPC_CHAIN, ELEM_WSDD_JAXRPC_HANDLERINFO, ELEM_WSDD_JAXRPC_HEADER, ELEM_WSDD_JAXRPC_ROLE, ELEM_WSDD_NAMESPACE, ELEM_WSDD_OPERATION, ELEM_WSDD_PARAM, ELEM_WSDD_REQFLOW, ELEM_WSDD_RESPFLOW, ELEM_WSDD_SERVICE, ELEM_WSDD_TRANSPORT, ELEM_WSDD_TYPEMAPPING, ELEM_WSDD_UNDEPLOY, ELEM_WSDD_WSDLFILE, NS_PREFIX_WSDD, NS_PREFIX_WSDD_JAVA, PROVIDER_BSF, PROVIDER_COM, PROVIDER_CORBA, PROVIDER_EJB, PROVIDER_HANDLER, PROVIDER_MSG, PROVIDER_RMI, PROVIDER_RPC, QNAME_BEANMAPPING, QNAME_BSF_PROVIDER, QNAME_CHAIN, QNAME_COM_PROVIDER, QNAME_CORBA_PROVIDER, QNAME_DEPLOY, QNAME_DOC, QNAME_EJB_PROVIDER, QNAME_ELEMENTMAPPING, QNAME_ENDPOINTURL, QNAME_FAULT, QNAME_FAULTFLOW, QNAME_GLOBAL, QNAME_HANDLER, QNAME_HANDLER_PROVIDER, QNAME_JAVAMSG_PROVIDER, QNAME_JAVARPC_PROVIDER, QNAME_JAXRPC_HANDLERINFO, QNAME_JAXRPC_HANDLERINFOCHAIN, QNAME_JAXRPC_HEADER, QNAME_JAXRPC_ROLE, QNAME_NAMESPACE, QNAME_OPERATION, QNAME_PARAM, QNAME_REQFLOW, QNAME_RESPFLOW, QNAME_RMI_PROVIDER, QNAME_SERVICE, QNAME_TRANSPORT, QNAME_TYPEMAPPING, QNAME_UNDEPLOY, QNAME_WSDLFILE, URI_WSDD, URI_WSDD_HANDLER, URI_WSDD_JAVA, URI_WSDD_WSDD_BSF, URI_WSDD_WSDD_COM
 
Fields inherited from interface org.jboss.axis.EngineConfiguration (src)
PROPERTY_NAME
 
Constructor Summary
WSDDDeployment()
          Default constructor
WSDDDeployment(org.w3c.dom.Element e)
          Create an element in WSDD that wraps an extant DOM element
 
Method Summary
protected  void addHandler(WSDDHandler (src)  handler)
           
protected  void addService(WSDDService (src)  service)
           
protected  void addTransport(WSDDTransport (src)  transport)
           
 void configureEngine(AxisEngine (src)  engine)
          Configure this AxisEngine using whatever data source we have.
 void deployHandler(WSDDHandler (src)  handler)
          Put a WSDDHandler into this deployment, replacing any other WSDDHandler which might already be present with the same QName.
 void deployService(WSDDService (src)  service)
          Put a WSDDService into this deployment, replacing any other WSDDService which might already be present with the same QName.
 void deployToRegistry(WSDDDeployment (src)  target)
           
 void deployTransport(WSDDTransport (src)  transport)
          Put a WSDDTransport into this deployment, replacing any other WSDDTransport which might already be present with the same QName.
 void deployTypeMapping(WSDDTypeMapping (src)  typeMapping)
           
 java.util.Iterator getDeployedServices()
          Get an enumeration of the services deployed to this engine
 WSDDDeployment (src) getDeployment()
           
protected  QName (src) getElementName()
          Return the element name of a particular subclass.
 AxisEngine (src) getEngine()
           
 WSDDGlobalConfiguration (src) getGlobalConfiguration()
          Get our global configuration
 java.util.Hashtable getGlobalOptions()
          Returns the global configuration options.
 Handler (src) getGlobalRequest()
          Returns a global request handler.
 Handler (src) getGlobalResponse()
          Returns a global response handler.
 Handler (src) getHandler(QName (src)  name)
          retrieve an instance of the named handler
 SOAPService (src) getService(QName (src)  name)
          retrieve an instance of the named service
 SOAPService (src) getServiceByNamespaceURI(java.lang.String namespace)
          Get a service which has been mapped to a particular namespace
 WSDDService (src) [] getServices()
          Return an array of the services in this deployment
 Handler (src) getTransport(QName (src)  name)
          retrieve an instance of the named transport
 TypeMapping (src) getTypeMapping(java.lang.String encodingStyle)
           
 TypeMappingRegistry (src) getTypeMappingRegistry()
          Retrieve the TypeMappingRegistry for this engine
 WSDDTypeMapping (src) [] getTypeMappings()
           
 WSDDService (src) getWSDDService(QName (src)  qname)
          Return the WSDD description for a given named service
 void registerNamespaceForService(java.lang.String namespace, WSDDService (src)  service)
          Register a particular namepsace which maps to a given WSDDService.
 void removeNamespaceMapping(java.lang.String namespace)
          Remove a namespace -> WSDDService mapping.
 void setGlobalConfiguration(WSDDGlobalConfiguration (src)  globalConfig)
           
 void undeployHandler(QName (src)  qname)
          Remove a named handler
 void undeployService(QName (src)  qname)
          Remove a named service
 void undeployTransport(QName (src)  qname)
          Remove a named transport
 void writeEngineConfig(AxisEngine (src)  engine)
          Read the configuration from an engine, and store it somehow.
 void writeToContext(SerializationContext (src)  context)
          Write this element out to a SerializationContext
 
Methods inherited from class org.jboss.axis.deployment.wsdd.WSDDElement (src)
getChildElement, getChildElements, getDocumentation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSDDDeployment

public WSDDDeployment()
Default constructor


WSDDDeployment

public WSDDDeployment(org.w3c.dom.Element e)
               throws WSDDException (src) 
Create an element in WSDD that wraps an extant DOM element

Parameters:
e - (Element) XXX
Throws:
WSDDException (src) - XXX
Method Detail

addHandler

protected void addHandler(WSDDHandler (src)  handler)

addService

protected void addService(WSDDService (src)  service)

addTransport

protected void addTransport(WSDDTransport (src)  transport)

deployHandler

public void deployHandler(WSDDHandler (src)  handler)
Put a WSDDHandler into this deployment, replacing any other WSDDHandler which might already be present with the same QName.

Parameters:
handler - a WSDDHandler to insert in this deployment

deployTransport

public void deployTransport(WSDDTransport (src)  transport)
Put a WSDDTransport into this deployment, replacing any other WSDDTransport which might already be present with the same QName.

Parameters:
transport - a WSDDTransport to insert in this deployment

deployService

public void deployService(WSDDService (src)  service)
Put a WSDDService into this deployment, replacing any other WSDDService which might already be present with the same QName.

Parameters:
service - a WSDDHandler to insert in this deployment

undeployHandler

public void undeployHandler(QName (src)  qname)
Remove a named handler

Parameters:
qname - the QName of the handler to remove

undeployService

public void undeployService(QName (src)  qname)
Remove a named service

Parameters:
qname - the QName of the service to remove

undeployTransport

public void undeployTransport(QName (src)  qname)
Remove a named transport

Parameters:
qname - the QName of the transport to remove

deployTypeMapping

public void deployTypeMapping(WSDDTypeMapping (src)  typeMapping)
                       throws WSDDException (src) 
Specified by:
deployTypeMapping in interface WSDDTypeMappingContainer (src)
Throws:
WSDDException (src)

getElementName

protected QName (src)  getElementName()
Description copied from class: WSDDElement (src)
Return the element name of a particular subclass.

Specified by:
getElementName in class WSDDElement (src)

deployToRegistry

public void deployToRegistry(WSDDDeployment (src)  target)
                      throws ConfigurationException (src) 
Throws:
ConfigurationException (src)

writeToContext

public void writeToContext(SerializationContext (src)  context)
                    throws java.io.IOException
Description copied from class: WSDDElement (src)
Write this element out to a SerializationContext

Specified by:
writeToContext in class WSDDElement (src)
Throws:
java.io.IOException

getGlobalConfiguration

public WSDDGlobalConfiguration (src)  getGlobalConfiguration()
Get our global configuration

Returns:
XXX

setGlobalConfiguration

public void setGlobalConfiguration(WSDDGlobalConfiguration (src)  globalConfig)

getTypeMappings

public WSDDTypeMapping (src) [] getTypeMappings()
Returns:
XXX

getServices

public WSDDService (src) [] getServices()
Return an array of the services in this deployment


getWSDDService

public WSDDService (src)  getWSDDService(QName (src)  qname)
Return the WSDD description for a given named service


getHandler

public Handler (src)  getHandler(QName (src)  name)
                   throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
retrieve an instance of the named handler

Specified by:
getHandler in interface EngineConfiguration (src)
Parameters:
name - XXX
Returns:
XXX
Throws:
ConfigurationException (src) - XXX

getTransport

public Handler (src)  getTransport(QName (src)  name)
                     throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
retrieve an instance of the named transport

Specified by:
getTransport in interface EngineConfiguration (src)
Parameters:
name - XXX
Returns:
XXX
Throws:
ConfigurationException (src) - XXX

getService

public SOAPService (src)  getService(QName (src)  name)
                       throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
retrieve an instance of the named service

Specified by:
getService in interface EngineConfiguration (src)
Parameters:
name - XXX
Returns:
XXX
Throws:
ConfigurationException (src) - XXX

getServiceByNamespaceURI

public SOAPService (src)  getServiceByNamespaceURI(java.lang.String namespace)
                                     throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
Get a service which has been mapped to a particular namespace

Specified by:
getServiceByNamespaceURI in interface EngineConfiguration (src)
Parameters:
namespace - a namespace URI
Returns:
an instance of the appropriate Service, or null
Throws:
ConfigurationException (src)

configureEngine

public void configureEngine(AxisEngine (src)  engine)
                     throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
Configure this AxisEngine using whatever data source we have.

Specified by:
configureEngine in interface EngineConfiguration (src)
Parameters:
engine - the AxisEngine we'll deploy state to
Throws:
ConfigurationException (src) - if there was a problem

writeEngineConfig

public void writeEngineConfig(AxisEngine (src)  engine)
                       throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
Read the configuration from an engine, and store it somehow.

Specified by:
writeEngineConfig in interface EngineConfiguration (src)
Parameters:
engine - the AxisEngine from which to read state.
Throws:
ConfigurationException (src) - if there was a problem

getTypeMapping

public TypeMapping (src)  getTypeMapping(java.lang.String encodingStyle)
                           throws ConfigurationException (src) 
Throws:
ConfigurationException (src)

getTypeMappingRegistry

public TypeMappingRegistry (src)  getTypeMappingRegistry()
                                           throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
Retrieve the TypeMappingRegistry for this engine

Specified by:
getTypeMappingRegistry in interface EngineConfiguration (src)
Throws:
ConfigurationException (src)

getGlobalRequest

public Handler (src)  getGlobalRequest()
                         throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
Returns a global request handler.

Specified by:
getGlobalRequest in interface EngineConfiguration (src)
Throws:
ConfigurationException (src)

getGlobalResponse

public Handler (src)  getGlobalResponse()
                          throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
Returns a global response handler.

Specified by:
getGlobalResponse in interface EngineConfiguration (src)
Throws:
ConfigurationException (src)

getGlobalOptions

public java.util.Hashtable getGlobalOptions()
                                     throws ConfigurationException (src) 
Description copied from interface: EngineConfiguration (src)
Returns the global configuration options.

Specified by:
getGlobalOptions in interface EngineConfiguration (src)
Throws:
ConfigurationException (src)

getDeployedServices

public java.util.Iterator getDeployedServices()
                                       throws ConfigurationException (src) 
Get an enumeration of the services deployed to this engine

Specified by:
getDeployedServices in interface EngineConfiguration (src)
Returns:
something to iterate with
Throws:
ConfigurationException (src)
See Also:
ServiceDesc (src)

registerNamespaceForService

public void registerNamespaceForService(java.lang.String namespace,
                                        WSDDService (src)  service)
Register a particular namepsace which maps to a given WSDDService. This will be used for namespace-based dispatching.

Parameters:
namespace - a namespace URI
service - the target WSDDService

removeNamespaceMapping

public void removeNamespaceMapping(java.lang.String namespace)
Remove a namespace -> WSDDService mapping.

Parameters:
namespace - the namespace URI to unmap

getEngine

public AxisEngine (src)  getEngine()

getDeployment

public WSDDDeployment (src)  getDeployment()
Specified by:
getDeployment in interface WSDDEngineConfiguration (src)