|
||||||||||
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 |
ATTACHMENTS_DIR
The directory where in coming attachments are created. |
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. |
protected static org.apache.commons.logging.Log |
log
|
static java.lang.String |
QUIT_REQUESTED
Has a quit been requested? Hackish... |
protected static java.lang.String |
systemTempDir
|
static java.lang.String |
TRANS_URL
This String is the URL that the message came to |
Constructor Summary | |
MessageContext(AxisEngine engine)
|
Method Summary | |
void |
clearProperty(java.lang.String propName)
|
AxisEngine |
getAxisEngine()
|
java.lang.ClassLoader |
getClassLoader()
|
static MessageContext |
getCurrentContext()
Get the active message context. |
Message |
getCurrentMessage()
Return the current (i.e. |
java.lang.String |
getEncodingStyle()
Returns the encoding style as a URI that should be used for the SOAP message. |
boolean |
getMaintainSession()
Are we maintaining session state? |
OperationDesc |
getOperation()
|
OperationDesc |
getOperationByQName(QName qname)
|
int |
getOperationStyle()
Get the operation style. |
java.lang.String |
getPassword()
Get the password |
boolean |
getPastPivot()
Determine when we've passed the pivot |
OperationDesc[] |
getPossibleOperationsByQName(QName qname)
|
java.lang.Object |
getProperty(java.lang.String name)
Returns the value associated with the named property - or null if not defined/set. |
Message |
getRequestMessage()
Get the request message. |
Message |
getResponseMessage()
Get the response message. |
SOAPService |
getService()
|
Session |
getSession()
Sessions |
java.lang.String |
getSOAPActionURI()
Get the soapAction URI. |
SOAPConstants |
getSOAPConstants()
SOAP constants |
java.lang.String |
getStrProp(java.lang.String propName)
Just a util so we don't have to cast the result |
static java.lang.String |
getStyleFromInt(int style)
Utility function to return a string representation of a style constant. |
static int |
getStyleFromString(java.lang.String operationStyle)
Utility function to convert string to operation style constants |
java.lang.String |
getTargetService()
|
int |
getTimeout()
Get timeout from our MessageContext. |
java.lang.String |
getTransportName()
Transport |
TypeMapping |
getTypeMapping()
Return the type mapping currently in scope for our encoding style |
TypeMappingRegistry |
getTypeMappingRegistry()
Get the currently in-scope type mapping registry. |
java.lang.String |
getUsername()
Get the user name |
boolean |
isClient()
Let us know whether this is the client or the server. |
boolean |
isEncoded()
Encoding |
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(java.lang.ClassLoader cl)
|
void |
setCurrentMessage(Message curMsg)
Set the current (i.e. |
void |
setEncodingStyle(java.lang.String namespaceURI)
Sets the encoding style to the URL passed in. |
void |
setMaintainSession(boolean yesno)
Set whether we are maintaining session state |
void |
setOperation(OperationDesc operation)
|
void |
setOperationStyle(int operationStyle)
Set the operation style. |
void |
setPassword(java.lang.String password)
Set the password. |
void |
setPastPivot(boolean pastPivot)
Indicate when we've passed the pivot |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Allows you to set a named property to the passed in value. |
void |
setPropertyParent(java.util.Hashtable parent)
|
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 |
setService(SOAPService sh)
|
void |
setSession(Session session)
|
void |
setSOAPActionURI(java.lang.String SOAPActionURI)
Set the soapAction URI. |
void |
setSOAPConstants(SOAPConstants soapConstants)
|
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)
|
void |
setUsername(java.lang.String username)
Set the username. |
void |
setUseSOAPAction(boolean useSOAPAction)
Should soapAction be used? |
boolean |
useSOAPAction()
Are we using soapAction? |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static org.apache.commons.logging.Log log
protected static java.lang.String systemTempDir
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 AUTHUSER
public static java.lang.String CALL
public static java.lang.String ATTACHMENTS_DIR
Constructor Detail |
public MessageContext(AxisEngine engine)
Method Detail |
public OperationDesc getOperation()
public void setOperation(OperationDesc operation)
public OperationDesc[] getPossibleOperationsByQName(QName qname)
public OperationDesc getOperationByQName(QName qname)
public static MessageContext getCurrentContext()
public void setTypeMappingRegistry(TypeMappingRegistry reg)
public TypeMappingRegistry getTypeMappingRegistry()
public TypeMapping getTypeMapping()
public java.lang.String getTransportName()
public void setTransportName(java.lang.String transportName)
public SOAPConstants getSOAPConstants()
public void setSOAPConstants(SOAPConstants soapConstants)
public Session getSession()
public void setSession(Session session)
public boolean isEncoded()
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)
respMsg
- 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 java.lang.ClassLoader getClassLoader()
public void setClassLoader(java.lang.ClassLoader cl)
public java.lang.String getTargetService()
public AxisEngine getAxisEngine()
public void setTargetService(java.lang.String tServ) throws AxisFault
tServ
- the name of the target service.public SOAPService getService()
public void setService(SOAPService 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 void setProperty(java.lang.String name, java.lang.Object value)
name
- Name of the propertyvalue
- Value of the propertypublic java.lang.Object getProperty(java.lang.String name)
public void setPropertyParent(java.util.Hashtable parent)
public void setUsername(java.lang.String username)
public java.lang.String getUsername()
public void setPassword(java.lang.String password)
public java.lang.String getPassword()
public void setOperationStyle(int operationStyle)
public int getOperationStyle()
public void setUseSOAPAction(boolean useSOAPAction)
public boolean useSOAPAction()
public void setSOAPActionURI(java.lang.String SOAPActionURI) throws java.lang.IllegalArgumentException
public java.lang.String getSOAPActionURI()
public void setEncodingStyle(java.lang.String namespaceURI)
namespaceURI
- URI of the encoding to use.public java.lang.String getEncodingStyle()
public void clearProperty(java.lang.String propName)
public void reset()
public static int getStyleFromString(java.lang.String operationStyle)
operationStyle
- "rpc", "document", or "wrapped"public static java.lang.String getStyleFromInt(int style)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |