Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.axis
Interface EngineConfiguration  view EngineConfiguration download EngineConfiguration.java

All Known Subinterfaces:
WSDDEngineConfiguration

public interface EngineConfiguration

EngineConfiguration is an interface that the Message Flow subsystem provides so that engine configuration can be provided in a pluggable way. An instance of EngineConfiguration provides configuration for a particular engine instance.

Concrete implementations of this interface will obtain configuration information from some source (examples might be files, Strings, or databases) and are responsible for writing it into an AxisEngine, and writing an AxisEngine's state back out to whatever storage medium is in use.


Field Summary
static java.lang.String PROPERTY_NAME
          Property name used for setting an EngineConfiguration to be used in creating engines.
 
Method Summary
 void configureEngine(AxisEngine engine)
          Configure this AxisEngine using whatever data source we have.
 java.util.Iterator getDeployedServices()
          Get an enumeration of the services deployed to this engine.
 java.util.Hashtable getGlobalOptions()
          Returns the global configuration options.
 Handler getGlobalRequest()
          Returns a global request handler.
 Handler getGlobalResponse()
          Returns a global response handler.
 Handler getHandler(javax.xml.namespace.QName qname)
          Retrieve an instance of the named handler.
 java.util.List getRoles()
          Get a list of roles that this engine plays globally.
 org.apache.axis.handlers.soap.SOAPService getService(javax.xml.namespace.QName qname)
          Retrieve an instance of the named service.
 org.apache.axis.handlers.soap.SOAPService getServiceByNamespaceURI(java.lang.String namespace)
          Get a service which has been mapped to a particular namespace.
 Handler getTransport(javax.xml.namespace.QName qname)
          Retrieve an instance of the named transport.
 org.apache.axis.encoding.TypeMappingRegistry getTypeMappingRegistry()
          Retrieve the TypeMappingRegistry for this engine.
 void writeEngineConfig(AxisEngine engine)
          Read the configuration from an engine, and store it somehow.
 

Field Detail

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME
Property name used for setting an EngineConfiguration to be used in creating engines.

See Also:
Constant Field Values
Method Detail

configureEngine

public void configureEngine(AxisEngine engine)
                     throws ConfigurationException
Configure this AxisEngine using whatever data source we have.


writeEngineConfig

public void writeEngineConfig(AxisEngine engine)
                       throws ConfigurationException
Read the configuration from an engine, and store it somehow.


getHandler

public Handler getHandler(javax.xml.namespace.QName qname)
                   throws ConfigurationException
Retrieve an instance of the named handler.


getService

public org.apache.axis.handlers.soap.SOAPService getService(javax.xml.namespace.QName qname)
                                                     throws ConfigurationException
Retrieve an instance of the named service.


getServiceByNamespaceURI

public org.apache.axis.handlers.soap.SOAPService getServiceByNamespaceURI(java.lang.String namespace)
                                                                   throws ConfigurationException
Get a service which has been mapped to a particular namespace.


getTransport

public Handler getTransport(javax.xml.namespace.QName qname)
                     throws ConfigurationException
Retrieve an instance of the named transport.


getTypeMappingRegistry

public org.apache.axis.encoding.TypeMappingRegistry getTypeMappingRegistry()
                                                                    throws ConfigurationException
Retrieve the TypeMappingRegistry for this engine.


getGlobalRequest

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


getGlobalResponse

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


getGlobalOptions

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


getDeployedServices

public java.util.Iterator getDeployedServices()
                                       throws ConfigurationException
Get an enumeration of the services deployed to this engine. Each service is represented as ServiceDesc object.


getRoles

public java.util.List getRoles()
Get a list of roles that this engine plays globally. Services within the engine configuration may also add additional roles.