|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.xins.common.service.CallRequest
org.xins.client.XINSCallRequest
Abstraction of a XINS request.
Note that instances of this class are not thread-safe.
XINSServiceCaller,
Serialized Form| Field Summary | |
static String |
PARAMETER_NAME_PATTERN_STRING
The pattern for a parameter name, as a character string. |
| Constructor Summary | |
XINSCallRequest(String functionName)
Constructs a new XINSCallRequest for the specified function
with no parameters, disallowing fail-over unless the request was
definitely not (yet) accepted by the service. |
|
XINSCallRequest(String functionName,
PropertyReader parameters)
Constructs a new XINSCallRequest for the specified function
and parameters, disallowing fail-over unless the request was definitely
not (yet) accepted by the service. |
|
XINSCallRequest(String functionName,
PropertyReader parameters,
boolean failOverAllowed)
Constructs a new XINSCallRequest for the specified function
and parameters, possibly allowing fail-over even if the request was
possibly already received by a target service. |
|
XINSCallRequest(String functionName,
PropertyReader parameters,
boolean failOverAllowed,
HTTPMethod method)
Constructs a new XINSCallRequest for the specified function
and parameters, possibly allowing fail-over, optionally specifying the
HTTP method to use. |
|
XINSCallRequest(String functionName,
PropertyReader parameters,
Element dataSection)
Constructs a new XINSCallRequest for the specified function
and parameters, disallowing fail-over unless the request was definitely
not (yet) accepted by the service. |
|
| Method Summary | |
String |
describe()
Describes this request. |
Element |
getDataSection()
Retrieves the data section for the input. |
String |
getFunctionName()
Returns the name of the function to call. |
String |
getParameter(String name)
Gets the value of the specified parameter. |
PropertyReader |
getParameters()
Gets all parameters to pass with the call, with their respective values. |
XINSCallConfig |
getXINSCallConfig()
Returns the XINS call configuration. |
void |
setDataSection(Element dataSection)
Sets the data section for the input. |
void |
setParameter(String name,
String value)
Sets the parameter with the specified name. |
void |
setParameters(PropertyReader parameters)
Sets the parameters for this function, replacing any existing parameters. |
void |
setXINSCallConfig(XINSCallConfig callConfig)
Sets the associated XINS call configuration. |
| Methods inherited from class org.xins.common.service.CallRequest |
getCallConfig, setCallConfig, toString |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final String PARAMETER_NAME_PATTERN_STRING
| Constructor Detail |
public XINSCallRequest(String functionName)
throws IllegalArgumentException
XINSCallRequest for the specified function
with no parameters, disallowing fail-over unless the request was
definitely not (yet) accepted by the service.
functionName - the name of the function to call, cannot be null.
IllegalArgumentException - if functionName == null.
public XINSCallRequest(String functionName,
PropertyReader parameters)
throws IllegalArgumentException
XINSCallRequest for the specified function
and parameters, disallowing fail-over unless the request was definitely
not (yet) accepted by the service.
functionName - the name of the function to call, cannot be null.parameters - the input parameters, if any, can be null if there are
none.
IllegalArgumentException - if functionName == null.
public XINSCallRequest(String functionName,
PropertyReader parameters,
Element dataSection)
throws IllegalArgumentException
XINSCallRequest for the specified function
and parameters, disallowing fail-over unless the request was definitely
not (yet) accepted by the service.
functionName - the name of the function to call, cannot be null.parameters - the input parameters, if any, can be null if there are
none.dataSection - the data section for the input, if any, can be null if
there are none.
IllegalArgumentException - if functionName == null.
public XINSCallRequest(String functionName,
PropertyReader parameters,
boolean failOverAllowed)
throws IllegalArgumentException
XINSCallRequest for the specified function
and parameters, possibly allowing fail-over even if the request was
possibly already received by a target service.
functionName - the name of the function to call, cannot be null.parameters - the input parameters, if any, can be null if there are
none.failOverAllowed - flag that indicates whether fail-over is in principle allowed, even
if the request was already sent to the other end.
IllegalArgumentException - if functionName == null.
public XINSCallRequest(String functionName,
PropertyReader parameters,
boolean failOverAllowed,
HTTPMethod method)
throws IllegalArgumentException
XINSCallRequest for the specified function
and parameters, possibly allowing fail-over, optionally specifying the
HTTP method to use.
functionName - the name of the function to call, cannot be null.parameters - the input parameters, if any, can be null if there are
none.failOverAllowed - flag that indicates whether fail-over is in principle allowed, even
if the request was already sent to the other end.method - the HTTP method to use, or null if a default should be
used.
IllegalArgumentException - if functionName == null or if parameters
contains a name that does not match the constraints for a parameter
name, see PARAMETER_NAME_PATTERN_STRING or if it equals
"function", which is currently still reserved.| Method Detail |
public String describe()
describe in class CallRequestnull.public XINSCallConfig getXINSCallConfig()
null.public void setXINSCallConfig(XINSCallConfig callConfig)
callConfig - the XINS call configuration object to associate with this request, or
null.public String getFunctionName()
null.
public void setParameters(PropertyReader parameters)
throws IllegalArgumentException
parameters - the input parameters, if any, can be null if there are
none.
IllegalArgumentException - if parameters contains a name that does not match the
constraints for a parameter name, see
PARAMETER_NAME_PATTERN_STRING or if it equals
"function", which is currently still reserved.
public void setParameter(String name,
String value)
throws IllegalArgumentException
name - the parameter name, cannot be null.value - the new value for the parameter, can be null.
IllegalArgumentException - if name does not match the constraints for a parameter
name, see PARAMETER_NAME_PATTERN_STRING or if it equals
"function", which is currently still reserved.public PropertyReader getParameters()
null if there are none.
public String getParameter(String name)
throws IllegalArgumentException
name - the parameter name, not null.
null.
IllegalArgumentException - if name == null.public void setDataSection(Element dataSection)
dataSection - the data section for the input, or null if there is
none.public Element getDataSection()
null if there is
none.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||