|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.axis.MessageContext
Some more general docs will go here. This class also contains constants for accessing some well-known properties. Using a hierarchical namespace is strongly suggested in order to lower the chance for conflicts. (These constants should be viewed as an explicit list of well known and widely used context keys, there's nothing wrong with directly using the key strings. This is the reason for the hierarchical constant namespace. Actually I think we might just list the keys in the docs and provide no such constants since they create yet another namespace, but we'd have no compile-time checks then. Whaddya think? - todo by Jacek)
Field Summary | |
static java.lang.String |
AUTHUSER
Place to store an AuthenticatedUser |
static java.lang.String |
CALL
If on the client - this is the Call object |
static java.lang.String |
ENGINE_HANDLER
Contains an instance of Handler, which is the ServiceContext and the entrypoint of this service. |
static java.lang.String |
ISRPC
Is this message an RPC message (instead of just a blob of xml) |
static java.lang.String |
PASSWORD
A String with the user's password (if available) |
static java.lang.String |
QUIT_REQUESTED
Has a quit been requested? Hackish... |
static java.lang.String |
TRANS_URL
This String is the URL that the message came to |
static java.lang.String |
USERID
A String with the user's ID (if available) |
Constructor Summary | |
MessageContext(AxisEngine engine)
|
Method Summary | |
void |
clearProperty(java.lang.String propName)
|
AxisEngine |
getAxisEngine()
|
AxisClassLoader |
getClassLoader()
|
static MessageContext |
getCurrentContext()
Get the active message context. |
Message |
getCurrentMessage()
Return the current (i.e. |
boolean |
getMaintainSession()
Are we maintaining session state? |
boolean |
getPastPivot()
Determine when we've passed the pivot |
java.lang.Object |
getProperty(java.lang.String propName)
|
Message |
getRequestMessage()
Get the request message. |
Message |
getResponseMessage()
Get the response message. |
Handler |
getServiceHandler()
|
Session |
getSession()
Sessions |
java.lang.String |
getStrProp(java.lang.String propName)
Just a util so we don't have to cast the result |
java.lang.String |
getTargetService()
|
int |
getTimeout()
Get timeout from our MessageContext. |
java.lang.String |
getTransportName()
Transport |
TypeMappingRegistry |
getTypeMappingRegistry()
Get the currently in-scope type mapping registry. |
boolean |
isClient()
Let us know whether this is the client or the server. |
boolean |
isPropertyTrue(java.lang.String propName)
Tests to see if the named property is set in the 'bag'. |
boolean |
isPropertyTrue(java.lang.String propName,
boolean defaultVal)
Tests to see if the named property is set in the 'bag'. |
void |
reset()
|
void |
setClassLoader(AxisClassLoader cl)
|
void |
setCurrentMessage(Message curMsg)
Set the current (i.e. |
void |
setMaintainSession(boolean yesno)
Set whether we are maintaining session state |
void |
setPastPivot(boolean pastPivot)
Indicate when we've passed the pivot |
void |
setProperty(java.lang.String propName,
java.lang.Object propValue)
|
void |
setRequestMessage(Message reqMsg)
Set the request message, and make sure that message is associated with this MessageContext. |
void |
setResponseMessage(Message respMsg)
Set the response message, and make sure that message is associated with this MessageContext. |
void |
setServiceHandler(Handler sh)
|
void |
setSession(Session session)
|
void |
setTargetService(java.lang.String tServ)
Set the target service for this message. |
void |
setTimeout(int value)
Set timeout in our MessageContext. |
void |
setTransportName(java.lang.String transportName)
|
void |
setTypeMappingRegistry(TypeMappingRegistry reg)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static java.lang.String ENGINE_HANDLER
public static java.lang.String TRANS_URL
public static java.lang.String QUIT_REQUESTED
public static java.lang.String USERID
public static java.lang.String PASSWORD
public static java.lang.String AUTHUSER
public static java.lang.String ISRPC
public static java.lang.String CALL
Constructor Detail |
public MessageContext(AxisEngine engine)
Method Detail |
public static MessageContext getCurrentContext()
public void setTypeMappingRegistry(TypeMappingRegistry reg)
public TypeMappingRegistry getTypeMappingRegistry()
public java.lang.String getTransportName()
public void setTransportName(java.lang.String transportName)
public Session getSession()
public void setSession(Session session)
public void setMaintainSession(boolean yesno)
public boolean getMaintainSession()
public Message getRequestMessage()
public void setRequestMessage(Message reqMsg)
reqMsg
- the new request Message.public Message getResponseMessage()
public void setResponseMessage(Message respMsg)
reqMsg
- the new response Message.public Message getCurrentMessage()
public void setCurrentMessage(Message curMsg)
public boolean getPastPivot()
public void setPastPivot(boolean pastPivot)
public void setTimeout(int value)
value
- the maximum amount of time, in millisecondspublic int getTimeout()
public AxisClassLoader getClassLoader()
public void setClassLoader(AxisClassLoader cl)
public java.lang.String getTargetService()
public AxisEngine getAxisEngine()
public void setTargetService(java.lang.String tServ)
tServ
- the name of the target service.public Handler getServiceHandler()
public void setServiceHandler(Handler sh)
public boolean isClient()
public java.lang.String getStrProp(java.lang.String propName)
public boolean isPropertyTrue(java.lang.String propName)
public boolean isPropertyTrue(java.lang.String propName, boolean defaultVal)
public java.lang.Object getProperty(java.lang.String propName)
public void setProperty(java.lang.String propName, java.lang.Object propValue)
public void clearProperty(java.lang.String propName)
public void reset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |