com.genesyslab.omsdk.mil
Interface MILESPRequest


public interface MILESPRequest

Represents the low-level ESP (External Service Protocol) request passed by the ESP layer to the processing method.

To get a MILESPRequest instance, define a class implementing the MILESPExtension interface. The fully qualified name of this extension class corresponds to the ServiceName attribute, and the method processing the ESP request corresponds to the MethodName parameter.

In response to this MILESPRequest, you can create a fault response or a success response by calling the createFaultResponse() or createSuccessResponse() methods.

Since:
7.1.002.00

Method Summary
 MILESPFaultResponse createFaultResponse()
          Creates a fault response bound to this request.
 MILESPSuccessResponse createSuccessResponse()
          Creates a successful response bound to this request.
 int getID()
          Returns the request ID.
 java.lang.String getInteractionID()
          Returns the ID of the MILInteraction associated with this ESP request.
 java.lang.String getMethodName()
          Returns the methodName parameter.
 java.util.Map getRequestParameters()
          Returns the request parameters of this ESP request.
 java.lang.String getServiceName()
          Returns the ServiceName parameter.
 java.util.Map getUserData()
          Returns the user data specified in this ESP request.
 

Method Detail

getServiceName

public java.lang.String getServiceName()
Returns the ServiceName parameter.

The ServiceName parameter is the fully qualified name of the targeted ESP extension.

Returns:
the ServiceName parameter.

getMethodName

public java.lang.String getMethodName()
Returns the methodName parameter.

Returns:
the methodName parameter

getID

public int getID()
Returns the request ID.

Returns:
the request ID.

getRequestParameters

public java.util.Map getRequestParameters()
Returns the request parameters of this ESP request.

The returned Map is read-only.

Returns:
read-only Map of ESP request parameters.

getUserData

public java.util.Map getUserData()
Returns the user data specified in this ESP request.

Returns:
Map of user data.

getInteractionID

public java.lang.String getInteractionID()
Returns the ID of the MILInteraction associated with this ESP request.

Returns:
interactionId associated with this ESP request.
See Also:
MILInteraction

createSuccessResponse

public MILESPSuccessResponse createSuccessResponse()
Creates a successful response bound to this request.

The returned MILESPSuccessResponse is populated with default values and is ready to be sent to Interaction Server.

Returns:
successful response bound to this request.

createFaultResponse

public MILESPFaultResponse createFaultResponse()
Creates a fault response bound to this request.

The returned MILESPFaultResponse is populated with default values and is ready to be sent to Interaction Server.

Returns:
fault response bound to this request.