org.xins.common.service

Class CallRequest

java.lang.Object

org.xins.common.service.CallRequest

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HTTPCallRequest, XINSCallRequest

public abstract class CallRequest
extends Object
implements Serializable

Abstraction of a request for a ServiceCaller call. Specific service callers typically only accept a single type of request, derived from this class.

This class is not thread-safe.

Implementations

Implementations of this class should stick to the following rules:

• the describe() method must be implemented;
• only a single non-argument constructor should be provided, all settings should be done using setter methods;
• a service caller-specific getter should be added for the associated call config object, this method should return the caller-specific call config object (a subclass of class CallConfig).

Since:

XINS 1.0.0

Version:

$Revision: 1.22 $ $Date: 2010/09/29 17:21:48 $

Author:

Ernst de Haan

See Also:

ServiceCaller, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CallRequest() Constructs a new CallRequest.

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	describe() Describes this request.
protected CallConfig	getCallConfig() Retrieves the associated call configuration, if any.
protected void	setCallConfig(CallConfig config) Sets the call configuration associated with this request.
String	toString() Returns a textual presentation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CallRequest

protected CallRequest()

Constructs a new CallRequest. This constructor is only available to subclasses, since this class is abstract.

Method Detail

describe

public abstract String describe()

Describes this request. The description should be trimmed and should fit in a sentence. Good examples include "LDAP request #1592" and "request #12903".

Returns:

the description of this request, should never be null, should never be empty and should never start or end with whitespace characters.

toString

public String toString()

Returns a textual presentation of this object.

The implementation of this method in class CallRequest returns describe().

Overrides:

toString in class Object

Returns:

a textual presentation of this object, should never be null.

getCallConfig

protected final CallConfig getCallConfig()

Retrieves the associated call configuration, if any.

Returns:

the associated call configuration, or null if none is.

Since:

XINS 1.1.0

setCallConfig

protected final void setCallConfig(CallConfig config)

Sets the call configuration associated with this request.

Parameters:

config - the call configuration to associate with this request, or null if none should be.

Since:

XINS 1.1.0