EngineConfiguration

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.axis
Interface EngineConfiguration

All Known Subinterfaces:: WSDDEngineConfiguration (src)

All Known Implementing Classes:: FileProvider (src) , NullProvider (src) , SimpleProvider (src) , WSDDDeployment (src)

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 (src) engine)` Configure this AxisEngine using whatever data source we have.
`java.util.Iterator`	`getDeployedServices()` Get an enumeration of the services deployed to this engine, these are represented as ServiceDesc objects
`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
`TypeMappingRegistry (src)`	`getTypeMappingRegistry()` Retrieve the TypeMappingRegistry for this engine
`void`	`writeEngineConfig(AxisEngine (src) 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 (src)

Method Detail

configureEngine

public void configureEngine(AxisEngine (src)  engine)
                     throws ConfigurationException (src)

Configure this AxisEngine using whatever data source we have.

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)

Read the configuration from an engine, and store it somehow.

Parameters:: engine - the AxisEngine from which to read state.
Throws:: ConfigurationException (src) - if there was a problem

getHandler

public Handler (src)  getHandler(QName (src)  qname)
                   throws ConfigurationException (src)

retrieve an instance of the named handler

Parameters:: qname - XXX
Returns:: XXX
Throws:: ConfigurationException (src) - XXX

getService

public SOAPService (src)  getService(QName (src)  qname)
                       throws ConfigurationException (src)

retrieve an instance of the named service

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

Parameters:: namespace - a namespace URI
Returns:: an instance of the appropriate Service, or null
Throws:: ConfigurationException (src)

getTransport

public Handler (src)  getTransport(QName (src)  qname)
                     throws ConfigurationException (src)

retrieve an instance of the named transport

Parameters:: qname - XXX
Returns:: XXX
Throws:: ConfigurationException (src) - XXX

getTypeMappingRegistry

public TypeMappingRegistry (src)  getTypeMappingRegistry()
                                           throws ConfigurationException (src)

Retrieve the TypeMappingRegistry for this engine

Throws:: ConfigurationException (src)

getGlobalRequest

public Handler (src)  getGlobalRequest()
                         throws ConfigurationException (src)

Returns a global request handler.

Throws:: ConfigurationException (src)

getGlobalResponse

public Handler (src)  getGlobalResponse()
                          throws ConfigurationException (src)

Returns a global response handler.

Throws:: ConfigurationException (src)

getGlobalOptions

public java.util.Hashtable getGlobalOptions()
                                     throws ConfigurationException (src)

Returns the global configuration options.

Throws:: ConfigurationException (src)

getDeployedServices

public java.util.Iterator getDeployedServices()
                                       throws ConfigurationException (src)

Get an enumeration of the services deployed to this engine, these are represented as ServiceDesc objects

Returns:: something to iterate with
Throws:: ConfigurationException (src)
See Also:: ServiceDesc (src)