Java Doc for MessageContext.java in  » Web-Services-AXIS2 » kernal » org » apache » axis2 » context » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Axis2 states are held in two information models, called description hierarchy and context hierarchy. Description hierarchy hold deployment configuration and it's values does not change unless deployment configuration change occurs where Context hierarchy hold run time information. Both hierarchies consists four levels, Global, Service Group, Operation and Message. Please look at "Information Model" section of "Axis2 Architecture Guide" for more information.

MessageContext hold run time information about one Message invocation. It hold reference to OperationContext, ServiceGroupContext, and Configuration Context tied with current message. For an example if you need accesses to other messages of the current invocation, you can get to them via OperationContext. Addition to class attributes define in Message context, message context stores the information as name value pairs. Those name value pairs,and class attributes tweak the execution behavior of message context and some of them can be find in org.apache.axis2.Constants class. (TODO we should provide list of supported options). You may set them at any level of context hierarchy and they will affect invocations related to their child elements.

NOTE: The field data must read back in the same order and type as it was written.

NOTE: when activating an object, you only need to call one of the activate methods (activate() or activateWithOperationContext()) but not both.
Parameters:
  operationCtx - The operation context object that is a member of the active object graph

NOTE: The copy shares certain objects with the original. The intent is to use the copy to read values but not modify them, especially since the copy is not part of the normal *Context and Axis* object graph. A copy of the message context that is not in the object graph

1. Search in module configurations inside corresponding operation description if its there
2. Search in corresponding operation if its there
3. Search in module configurations inside corresponding service description if its there
4. Next search in Corresponding Service description if its there
5. Next search in module configurations inside axisConfiguration
6. Search in AxisConfiguration for parameters
7. Next get the corresponding module and search for the parameters
8. Search in HandlerDescription for the parameter

and the way of specifying module configuration is as follows N/A
Parameters:
  key - :Parameter Name
Parameters:
  moduleName - :Name of the module
Parameters:
  handler - HandlerDescription Parameter Parameter

1. Search in operation description if it exists
2. If parameter is not found or if operationContext is null, search in AxisService
3. If parameter is not found or if axisService is null, search in AxisConfiguration

NOTE: The field data must read back in the same order and type as it was written. Some data will need to be validated when resurrected.
Parameters:
  in - The stream to read the object contents from
throws:
  IOException -
throws:
  ClassNotFoundException -

This is primarily intended to allow handlers to manage their own message-specific data when the message context is saved/restored.
Parameters:
  clazz - The class of the caller that owns the key-value pair
Parameters:
  key - The key for this data object
Parameters:
  value - The data object

NOTE: Transient fields and static fields are not saved. Also, objects that represent "static" data are not saved, except for enough information to be able to find matching objects when the message context is re-constituted.
Parameters:
  out - The stream to write the object contents to
throws:
  IOException -