org.xins.server

Class FunctionRequest

java.lang.Object

org.xins.server.FunctionRequest

public class FunctionRequest
extends Object

Function request. Consists of a function name, a set of parameters and a data section. The function name is mandatory, while there may not be any parameters nor data section.

Since:

XINS 1.2.0

Version:

$Revision: 1.28 $ $Date: 2012/02/28 18:10:54 $

Author:

Anthony Goubard, Ernst de Haan

Constructor Summary

Constructors

Constructor and Description
FunctionRequest(String functionName, Map<String,String> parameters, Element dataElement) Creates a new FunctionRequest.
FunctionRequest(String functionName, Map<String,String> parameters, Element dataElement, Map<String,Object> backpack) Creates a new FunctionRequest.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getBackpack() Gets the backpack.
Element	getDataElement() Gets the data section of the request.
String	getFunctionName() Gets the name of the function.
Map<String,String>	getParameters() Gets the parameters of the function.
boolean	shouldSkipFunctionCall() Gets whether the function should be executed or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionRequest

public FunctionRequest(String functionName,
               Map<String,String> parameters,
               Element dataElement)
                throws IllegalArgumentException

Creates a new FunctionRequest. The function name must be specified.

Parameters:

functionName - the name of the function, cannot be null.

parameters - the parameters of the function requested, cannot be null.

dataElement - the data section of the input request, can be null.

Throws:

IllegalArgumentException - if functionName == null.

FunctionRequest

public FunctionRequest(String functionName,
               Map<String,String> parameters,
               Element dataElement,
               Map<String,Object> backpack)
                throws IllegalArgumentException

Creates a new FunctionRequest. The function name must be specified.

Parameters:

functionName - the name of the function, cannot be null.

parameters - the parameters of the function requested, cannot be null.

dataElement - the data section of the input request, can be null.

backpack - the container containing information for the XINS engine or the function.

Throws:

IllegalArgumentException - if functionName == null.

Since:

XINS 2.0

Method Detail

getFunctionName

public String getFunctionName()

Gets the name of the function.

Returns:

the name of the function, never null.

Since:

XINS 2.0

getParameters

public Map<String,String> getParameters()

Gets the parameters of the function. The returned Map instance is unmodifiable.

Returns:

the parameters of the function, never null.

Since:

XINS 2.0

getDataElement

public Element getDataElement()

Gets the data section of the request.

Returns:

the data section, or null if there is none.

Since:

XINS 2.0

shouldSkipFunctionCall

public boolean shouldSkipFunctionCall()

Gets whether the function should be executed or not.

Returns:

true if the function shouldn't be executed, false otherwise.

Since:

XINS 2.0

getBackpack

public Map<String,Object> getBackpack()

Gets the backpack.

Returns:

the backpack.

Since:

XINS 3.0