| java.lang.Object
 org.xins.server.CallContext
| CallContext | | final public class CallContext (Code) | | Context for a function call. Objects of this kind are passed with a
function call.
version:
$Revision: 1.124 $ $Date: 2007/03/15 17:08:40 $
author:
Ernst de Haan
since:
XINS 1.0.0 |
| CallContext | | CallContext(FunctionRequest functionRequest, long start, Function function, int callID, String remoteIP) throws IllegalArgumentException(Code) | | Constructs a new CallContext and configures it for the
specified request.
Parameters:
functionRequest - the request, never null.
Parameters:
start - the start time of the call, as milliseconds since theUNIX Epoch.
Parameters:
function - the concerning function, cannot be null.
Parameters:
callID - the assigned call ID.
Parameters:
remoteIP - the IP address of the caller.
throws:
IllegalArgumentException - if parameters == null || function == null. |
| getCallID | | public int getCallID()(Code) | | Returns the assigned call ID. This ID is unique within the context of
the pertaining function. If no call ID is assigned, then -1
is returned.
the assigned call ID for the function, or -1 if none isassigned. |
| getDataElement | | public Element getDataElement()(Code) | | Returns the data section of the request, if any.
the element representing the data section or null if thefunction does not define a data section or if the data section sent isempty. |
| getErrorCode | | final String getErrorCode()(Code) | | Returns the stored return code.
the return code, can be null. |
| getParameter | | public String getParameter(String name) throws IllegalArgumentException(Code) | | Returns the value of a parameter with the specificied name. Note that
reserved parameters, i.e. those starting with an underscore
('_') cannot be retrieved.
Parameters:
name - the name of the parameter, not null.the value of the parameter, or null if the parameter isnot set, never an empty string ("") because it will bereturned as being null.
throws:
IllegalArgumentException - if name == null. |
| getRemoteAddr | | public String getRemoteAddr()(Code) | | Returns the IP address of the host that requested this function.
the IP address as a String. |
| getStart | | public long getStart()(Code) | | Returns the start time of the call.
the timestamp indicating when the call was started, as a number ofmilliseconds since theUNIX Epoch.
See Also: System.currentTimeMillis |
|
|