org.apache.axis2.engine
Class AxisEngine

java.lang.Object
  extended byorg.apache.axis2.engine.AxisEngine

public class AxisEngine
extends java.lang.Object

There is one engine for the Server and the Client. the send() and receive() Methods are the basic operations the Sync, Async messageing are build on top.


Constructor Summary
AxisEngine(ConfigurationContext engineContext)
          Constructor AxisEngine
 
Method Summary
 boolean clearStorage(ConfigurationContext context)
          Clears the underlying storage
 MessageContext createFaultMessageContext(MessageContext processingContext, java.lang.Throwable e)
          If error occurs at inflow or the out flow this method will call to handle the error.
 void receive(MessageContext msgContext)
          This methods represents the inflow of the Axis, this could be either at the server side or the client side.
 void receiveFault(MessageContext msgContext)
          This is invoked when a SOAP Fault is received from a Other SOAP Node
 java.lang.Object remove(ConfigurationContext context, java.lang.Object key)
          removes an object from the underlying storage
 void resumeInvocationPhases(java.util.ArrayList phases, MessageContext msgctx)
           
 java.lang.Object retrieve(ConfigurationContext context, java.lang.Object key)
          retrieves an object from the underlying storage
 void send(MessageContext msgContext)
          This methods represents the outflow of the Axis, this could be either at the server side or the client side.
 void sendFault(MessageContext msgContext)
          This Method Send the SOAP Fault to a Other SOAP Node
 void serialize()
          To serilze the entier context heirarachy to a given location from top to bottom
 java.lang.Object store(ConfigurationContext context, java.lang.Object obj)
          Stores an object in the underlying storage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AxisEngine

public AxisEngine(ConfigurationContext engineContext)
Constructor AxisEngine

Method Detail

send

public void send(MessageContext msgContext)
          throws AxisFault
This methods represents the outflow of the Axis, this could be either at the server side or the client side. Here the ExecutionChain is created using the Phases. The Handlers at the each Phases is ordered in deployment time by the deployment module

Throws:
AxisFault
See Also:
MessageContext, ExecutionChain, Phase, Handler

receive

public void receive(MessageContext msgContext)
             throws AxisFault
This methods represents the inflow of the Axis, this could be either at the server side or the client side. Here the ExecutionChain is created using the Phases. The Handlers at the each Phases is ordered in deployment time by the deployment module

Throws:
AxisFault
See Also:
MessageContext, ExecutionChain, Phase, Handler

sendFault

public void sendFault(MessageContext msgContext)
               throws AxisFault
This Method Send the SOAP Fault to a Other SOAP Node

Parameters:
msgContext -
Throws:
AxisFault

receiveFault

public void receiveFault(MessageContext msgContext)
                  throws AxisFault
This is invoked when a SOAP Fault is received from a Other SOAP Node

Parameters:
msgContext -
Throws:
AxisFault

createFaultMessageContext

public MessageContext createFaultMessageContext(MessageContext processingContext,
                                                java.lang.Throwable e)
                                         throws AxisFault
If error occurs at inflow or the out flow this method will call to handle the error. But if the execution reach this method twice, means the sending the error handling failed an in that case the this method just log the error and exit

Parameters:
e -
Throws:
AxisFault

resumeInvocationPhases

public void resumeInvocationPhases(java.util.ArrayList phases,
                                   MessageContext msgctx)
                            throws AxisFault
Throws:
AxisFault

store

public java.lang.Object store(ConfigurationContext context,
                              java.lang.Object obj)
Stores an object in the underlying storage

Parameters:
context - The relevant engine context
obj - the object to be stored
Returns:
the storage key

retrieve

public java.lang.Object retrieve(ConfigurationContext context,
                                 java.lang.Object key)
retrieves an object from the underlying storage

Parameters:
context -
key -
Returns:

remove

public java.lang.Object remove(ConfigurationContext context,
                               java.lang.Object key)
removes an object from the underlying storage

Parameters:
context -
key -
Returns:
the object removed

clearStorage

public boolean clearStorage(ConfigurationContext context)
Clears the underlying storage

Parameters:
context -
Returns:

serialize

public void serialize()
To serilze the entier context heirarachy to a given location from top to bottom

Throws:
AxisFault