Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.axis
Class AxisEngine

java.lang.Object
  extended byorg.jboss.axis.handlers.BasicHandler (src) 
      extended byorg.jboss.axis.AxisEngine
All Implemented Interfaces:
Handler (src)
Direct Known Subclasses:
AxisClient (src) , AxisServer (src)
public abstract class AxisEngine
extends BasicHandler (src)

An AxisEngine is the base class for AxisClient and AxisServer. Handles common functionality like dealing with the handler/service registries and loading properties.

Field Summary
protected  boolean _hasSafePassword
          Has the user changed the password yet?
protected  EngineConfiguration (src) config
          Our go-to guy for configuration...
static java.lang.String DEFAULT_ATTACHMENT_IMPL
           
static java.lang.String ENV_ATTACHMENT_DIR
           
static java.lang.String ENV_SERVLET_CONTEXT
           
static java.lang.String ENV_SERVLET_REALPATH
           
static java.lang.String PROP_ATTACHMENT_CLEANUP
           
static java.lang.String PROP_ATTACHMENT_DIR
           
static java.lang.String PROP_ATTACHMENT_IMPLEMENTATION
           
static java.lang.String PROP_DEBUG_FILE
           
static java.lang.String PROP_DEBUG_LEVEL
           
static java.lang.String PROP_DEFAULT_CONFIG_CLASS
           
static java.lang.String PROP_DOMULTIREFS
           
static java.lang.String PROP_PASSWORD
           
static java.lang.String PROP_SEND_MINIMIZED_ELEMENTS
           
static java.lang.String PROP_SEND_XSI
           
static java.lang.String PROP_SOAP_ALLOWED_VERSION
           
static java.lang.String PROP_SOAP_VERSION
           
static java.lang.String PROP_SYNC_CONFIG
           
static java.lang.String PROP_TWOD_ARRAY_ENCODING
           
static java.lang.String PROP_XML_DECL
           
static java.lang.String PROP_XML_ENCODING
           
protected  boolean shouldSaveConfig
          Should we save the engine config each time we modify it?
 
Fields inherited from class org.jboss.axis.handlers.BasicHandler (src)
makeLockable, name, options
 
Constructor Summary
AxisEngine(EngineConfiguration (src)  config)
          Construct an AxisEngine using the specified engine configuration.
 
Method Summary
 void addActorURI(java.lang.String uri)
           
 void cleanup()
          cleanup routine removes application scoped objects There is a small risk of this being called more than once so the cleanup should be designed to resist that event
 java.util.ArrayList getActorURIs()
           
 Session (src) getApplicationSession()
          accessor only, for application session (could call it "engine session" instead, but named with reference to Apache SOAP's notion of "application scope")
 ClassCache (src) getClassCache()
           
abstract  AxisEngine (src) getClientEngine()
          ****************************************************************** Client engine access

An AxisEngine may define another specific AxisEngine to be used by newly created Clients.
 EngineConfiguration (src) getConfig()
           
static MessageContext (src) getCurrentMessageContext()
          Get the active message context.
 Handler (src) getGlobalRequest()
           
 Handler (src) getGlobalResponse()
           
 Handler (src) getHandler(java.lang.String name)
           
 SOAPService (src) getService(java.lang.String name)
           
 Handler (src) getTransport(java.lang.String name)
           
 TypeMappingRegistry (src) getTypeMappingRegistry()
           
 boolean hasSafePassword()
           
 void init()
          (re)initialize - What should really go in here???
static void normaliseOptions(Handler (src)  handler)
          Normalise the engine's options.
 void refreshGlobalOptions()
          (Re-)load the global options from the registry.
 void removeActorURI(java.lang.String uri)
           
 void saveConfiguration()
          Write out our engine configuration.
 void setAdminPassword(java.lang.String pw)
           
static void setCurrentMessageContext(MessageContext (src)  mc)
          Set the active message context.
 void setShouldSaveConfig(boolean shouldSaveConfig)
           
 
Methods inherited from class org.jboss.axis.handlers.BasicHandler (src)
canHandleBlock, generateWSDL, getDeploymentData, getName, getOption, getOptions, getUnderstoodHeaders, initHashtable, invoke, onFault, setName, setOption, setOptionDefault, setOptions, setOptionsLockable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROP_XML_DECL

public static final java.lang.String PROP_XML_DECL
See Also:
Constant Field Values (src)

PROP_DEBUG_LEVEL

public static final java.lang.String PROP_DEBUG_LEVEL
See Also:
Constant Field Values (src)

PROP_DEBUG_FILE

public static final java.lang.String PROP_DEBUG_FILE
See Also:
Constant Field Values (src)

PROP_DOMULTIREFS

public static final java.lang.String PROP_DOMULTIREFS
See Also:
Constant Field Values (src)

PROP_PASSWORD

public static final java.lang.String PROP_PASSWORD
See Also:
Constant Field Values (src)

PROP_SYNC_CONFIG

public static final java.lang.String PROP_SYNC_CONFIG
See Also:
Constant Field Values (src)

PROP_SEND_XSI

public static final java.lang.String PROP_SEND_XSI
See Also:
Constant Field Values (src)

PROP_ATTACHMENT_DIR

public static final java.lang.String PROP_ATTACHMENT_DIR
See Also:
Constant Field Values (src)

PROP_ATTACHMENT_IMPLEMENTATION

public static final java.lang.String PROP_ATTACHMENT_IMPLEMENTATION
See Also:
Constant Field Values (src)

PROP_ATTACHMENT_CLEANUP

public static final java.lang.String PROP_ATTACHMENT_CLEANUP
See Also:
Constant Field Values (src)

PROP_DEFAULT_CONFIG_CLASS

public static final java.lang.String PROP_DEFAULT_CONFIG_CLASS
See Also:
Constant Field Values (src)

PROP_SOAP_VERSION

public static final java.lang.String PROP_SOAP_VERSION
See Also:
Constant Field Values (src)

PROP_SOAP_ALLOWED_VERSION

public static final java.lang.String PROP_SOAP_ALLOWED_VERSION
See Also:
Constant Field Values (src)

PROP_TWOD_ARRAY_ENCODING

public static final java.lang.String PROP_TWOD_ARRAY_ENCODING
See Also:
Constant Field Values (src)

PROP_SEND_MINIMIZED_ELEMENTS

public static final java.lang.String PROP_SEND_MINIMIZED_ELEMENTS
See Also:
Constant Field Values (src)

PROP_XML_ENCODING

public static final java.lang.String PROP_XML_ENCODING
See Also:
Constant Field Values (src)

DEFAULT_ATTACHMENT_IMPL

public static final java.lang.String DEFAULT_ATTACHMENT_IMPL
See Also:
Constant Field Values (src)

ENV_ATTACHMENT_DIR

public static final java.lang.String ENV_ATTACHMENT_DIR
See Also:
Constant Field Values (src)

ENV_SERVLET_REALPATH

public static final java.lang.String ENV_SERVLET_REALPATH
See Also:
Constant Field Values (src)

ENV_SERVLET_CONTEXT

public static final java.lang.String ENV_SERVLET_CONTEXT
See Also:
Constant Field Values (src)

config

protected EngineConfiguration (src)  config
Our go-to guy for configuration...

_hasSafePassword

protected boolean _hasSafePassword
Has the user changed the password yet?

shouldSaveConfig

protected boolean shouldSaveConfig
Should we save the engine config each time we modify it?

Constructor Detail

AxisEngine

public AxisEngine(EngineConfiguration (src)  config)
Construct an AxisEngine using the specified engine configuration.

Parameters:
config - the EngineConfiguration for this engine
Method Detail

setCurrentMessageContext

public static void setCurrentMessageContext(MessageContext (src)  mc)
Set the active message context.

Parameters:
mc - - the new active message context.

getCurrentMessageContext

public static MessageContext (src)  getCurrentMessageContext()
Get the active message context.

Returns:
the current active message context

init

public void init()
(re)initialize - What should really go in here???

Specified by:
init in interface Handler (src)
Overrides:
init in class BasicHandler (src)

cleanup

public void cleanup()
cleanup routine removes application scoped objects There is a small risk of this being called more than once so the cleanup should be designed to resist that event

Specified by:
cleanup in interface Handler (src)
Overrides:
cleanup in class BasicHandler (src)

saveConfiguration

public void saveConfiguration()
Write out our engine configuration.

getConfig

public EngineConfiguration (src)  getConfig()

hasSafePassword

public boolean hasSafePassword()

setAdminPassword

public void setAdminPassword(java.lang.String pw)

setShouldSaveConfig

public void setShouldSaveConfig(boolean shouldSaveConfig)

getHandler

public Handler (src)  getHandler(java.lang.String name)
                   throws AxisFault (src)
Throws:
AxisFault (src)

getService

public SOAPService (src)  getService(java.lang.String name)
                       throws AxisFault (src)
Throws:
AxisFault (src)

getTransport

public Handler (src)  getTransport(java.lang.String name)
                     throws AxisFault (src)
Throws:
AxisFault (src)

getTypeMappingRegistry

public TypeMappingRegistry (src)  getTypeMappingRegistry()

getGlobalRequest

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

getGlobalResponse

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

getActorURIs

public java.util.ArrayList getActorURIs()

addActorURI

public void addActorURI(java.lang.String uri)

removeActorURI

public void removeActorURI(java.lang.String uri)

getClientEngine

public abstract AxisEngine (src)  getClientEngine()
****************************************************************** Client engine access

An AxisEngine may define another specific AxisEngine to be used by newly created Clients. For instance, a server may create an AxisClient and allow deployment to it. Then the server's services may access the AxisClient's deployed handlers and transports. ********************************************************************

normaliseOptions

public static void normaliseOptions(Handler (src)  handler)
Normalise the engine's options.

Convert boolean options from String to Boolean and default any ommitted boolean options to TRUE. Default the admin. password.

refreshGlobalOptions

public void refreshGlobalOptions()
                          throws ConfigurationException (src)
(Re-)load the global options from the registry.

Throws:
ConfigurationException (src)

getApplicationSession

public Session (src)  getApplicationSession()
accessor only, for application session (could call it "engine session" instead, but named with reference to Apache SOAP's notion of "application scope")

getClassCache

public ClassCache (src)  getClassCache()
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD