net.sf.mmm.service.base

Class GenericRemoteInvocationResponse

java.lang.Object

net.sf.mmm.service.base.GenericRemoteInvocationResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GenericRemoteInvocationCommandResponse, GenericRemoteInvocationRpcResponse

public class GenericRemoteInvocationResponse
extends Object
implements Serializable

This is the transfer-object for the generic response to a remote invocation.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

GenericRemoteInvocationRpcService.callServices(net.sf.mmm.service.base.rpc.GenericRemoteInvocationRpcRequest), GenericRemoteInvocationCommandService.callCommands(net.sf.mmm.service.base.command.GenericRemoteInvocationCommandRequest), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	requestId
private static long	serialVersionUID UID for serialization.
private GenericRemoteInvocationTransactionalResults[]	transactionalResults
private CsrfToken	xsrfToken

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericRemoteInvocationResponse() The constructor.
	GenericRemoteInvocationResponse(int requestId, CsrfToken xsrfToken, Collection<GenericRemoteInvocationTransactionalResults> transactionalResults) The constructor.
	GenericRemoteInvocationResponse(int requestId, CsrfToken xsrfToken, GenericRemoteInvocationTransactionalResults[] transactionalResults) The constructor.

Method Summary

Modifier and Type	Method and Description
int	getRequestId()
GenericRemoteInvocationTransactionalResults[]	getTransactionalResults()
CsrfToken	getXsrfToken() Gets the CsrfToken that has been generated on the server-side.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

transactionalResults

private GenericRemoteInvocationTransactionalResults[] transactionalResults

See Also:

getTransactionalResults()

requestId

private int requestId

See Also:

getRequestId()

xsrfToken

private CsrfToken xsrfToken

See Also:

getXsrfToken()

Constructor Detail

GenericRemoteInvocationResponse

protected GenericRemoteInvocationResponse()

The constructor.

GenericRemoteInvocationResponse

public GenericRemoteInvocationResponse(int requestId,
                                       CsrfToken xsrfToken,
                                       GenericRemoteInvocationTransactionalResults[] transactionalResults)

The constructor.

Parameters:

requestId - - see getRequestId().

xsrfToken - - see getXsrfToken().

transactionalResults - - see getTransactionalResults().

GenericRemoteInvocationResponse

public GenericRemoteInvocationResponse(int requestId,
                                       CsrfToken xsrfToken,
                                       Collection<GenericRemoteInvocationTransactionalResults> transactionalResults)

The constructor.

Parameters:

requestId - - see getRequestId().

xsrfToken - - see getXsrfToken().

transactionalResults - - see getTransactionalResults().

Method Detail

getRequestId

public int getRequestId()

Returns:

the ID of the request this response corresponds to.

getXsrfToken

public CsrfToken getXsrfToken()

Gets the CsrfToken that has been generated on the server-side. If not null the client has to store the token and send it back to the server within the next request. This is all handled by the infrastructure of mmm-service but can be extended for custom needs.

Returns:

the CsrfToken or null if unchanged.

getTransactionalResults

public GenericRemoteInvocationTransactionalResults[] getTransactionalResults()

Returns:

an array with the GenericRemoteInvocationTransactionalResultss.