net.sf.cuf.xfer

Interface Request<T>

Type Parameters:

T - Generic type of the Response, see execute().

All Known Implementing Classes:

AbstractRequest

public interface Request<T>

The Request interface encapsulates all information needed for generating and dispatching a response for a request. A Request knows how to generate the response and who is interested in the result, but is has no knowledge about the dispatching process (@see Dispatch).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canBeCancelled() A request object may be canceled if this method returns true.
void	cancel() Cancel the current request; if the request was completed before the cancel call, the cancel call will be silently ignored.
Response<T>	execute() Generate a response for the current request state.
RequestDelegate<T>	getDelegate() Returns our request delegate.
DispatchTarget	getDispatchTarget() Returns our dispatch target.
void	setDispatchTarget(DispatchTarget pTarget) Sets our dispatch target.
void	setDispatchTarget(Object pTargetObject, String pMethodName) Sets our dispatch target.

Method Detail

setDispatchTarget

void setDispatchTarget(DispatchTarget pTarget)

Sets our dispatch target.

Parameters:

pTarget - the target to set (null is o.k.)

setDispatchTarget

void setDispatchTarget(Object pTargetObject,
                     String pMethodName)

Sets our dispatch target.

Parameters:

pTargetObject - target to call, must not be null

pMethodName - method to call, must not be null and match the void <pMethodname>(Response pResponse) signature

getDispatchTarget

DispatchTarget getDispatchTarget()

Returns our dispatch target.

Returns:

dispatch target (may be null)

getDelegate

RequestDelegate<T> getDelegate()

Returns our request delegate.

Returns:

request delegate (may be null)

execute

Response<T> execute()

Generate a response for the current request state.

Returns:

the response (must not be null)

canBeCancelled

boolean canBeCancelled()

A request object may be canceled if this method returns true.

Returns:

true if this request can be cancelled, false otherwise

cancel

void cancel()
            throws IllegalStateException

Cancel the current request; if the request was completed before the cancel call, the cancel call will be silently ignored.

Throws:

IllegalStateException - if we can't be canceled at all