org.jboss.axis.configuration
Class SimpleProvider

java.lang.Object
  extended byorg.jboss.axis.configuration.SimpleProvider
All Implemented Interfaces:
EngineConfiguration (src)
Direct Known Subclasses:
BasicClientConfig (src) , BasicServerConfig (src)

public class SimpleProvider
extends java.lang.Object
implements EngineConfiguration (src)

A SimpleProvider is an EngineConfiguration which contains a simple HashMap-based registry of Handlers, Transports, and Services. This is for when you want to programatically deploy components which you create.

SimpleProvider may also optionally contain a reference to a "default" EngineConfiguration, which will be scanned for components not found in the internal registry. This is handy when you want to start with a base configuration (like the default WSDD) and then quickly add stuff without changing the WSDD document.


Field Summary
 
Fields inherited from interface org.jboss.axis.EngineConfiguration (src)
PROPERTY_NAME
 
Constructor Summary
SimpleProvider()
          Default constructor.
SimpleProvider(EngineConfiguration (src)  defaultConfiguration)
          Constructor which takes an EngineConfiguration which will be used as the default.
 
Method Summary
 void configureEngine(AxisEngine (src)  engine)
          Configure an AxisEngine.
 void deployService(QName (src)  qname, SOAPService (src)  service)
           
 void deployService(java.lang.String name, SOAPService (src)  service)
           
 void deployTransport(QName (src)  qname, Handler (src)  transport)
           
 void deployTransport(java.lang.String name, Handler (src)  transport)
           
 java.util.Iterator getDeployedServices()
          Get an enumeration of the services deployed to this engine
 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)  qname)
          retrieve an instance of the named handler
 SOAPService (src) getService(QName (src)  qname)
          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
 Handler (src) getTransport(QName (src)  qname)
          retrieve an instance of the named transport
 TypeMapping (src) getTypeMapping(java.lang.String encodingStyle)
           
 TypeMappingRegistry (src) getTypeMappingRegistry()
          Get our TypeMappingRegistry.
 void writeEngineConfig(AxisEngine (src)  engine)
          We don't write ourselves out, so this is a noop.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleProvider

public SimpleProvider()
Default constructor.


SimpleProvider

public SimpleProvider(EngineConfiguration (src)  defaultConfiguration)
Constructor which takes an EngineConfiguration which will be used as the default.

Method Detail

configureEngine

public void configureEngine(AxisEngine (src)  engine)
                     throws ConfigurationException (src) 
Configure an AxisEngine. Right now just calls the default configuration if there is one, since we don't do anything special.

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) 
We don't write ourselves out, so this is a noop.

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

getGlobalOptions

public java.util.Hashtable getGlobalOptions()
                                     throws ConfigurationException (src) 
Returns the global configuration options.

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

getGlobalResponse

public Handler (src)  getGlobalResponse()
                          throws ConfigurationException (src) 
Returns a global response handler.

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

getGlobalRequest

public Handler (src)  getGlobalRequest()
                         throws ConfigurationException (src) 
Returns a global request handler.

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

getTypeMappingRegistry

public TypeMappingRegistry (src)  getTypeMappingRegistry()
                                           throws ConfigurationException (src) 
Get our TypeMappingRegistry. Returns our specific one if we have one, otherwise the one from our defaultConfiguration. If we don't have one and also don't have a defaultConfiguration, we create one.

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

getTypeMapping

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

getTransport

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

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

getService

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

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

getServiceByNamespaceURI

public SOAPService (src)  getServiceByNamespaceURI(java.lang.String namespace)
                                     throws ConfigurationException (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)

getHandler

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

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

deployService

public void deployService(QName (src)  qname,
                          SOAPService (src)  service)

deployService

public void deployService(java.lang.String name,
                          SOAPService (src)  service)

deployTransport

public void deployTransport(QName (src)  qname,
                            Handler (src)  transport)

deployTransport

public void deployTransport(java.lang.String name,
                            Handler (src)  transport)

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)