net.sf.eBus.client

Class EReplyFeed.ERequest

java.lang.Object

net.sf.eBus.client.EFeed

net.sf.eBus.client.EReplyFeed.ERequest

All Implemented Interfaces:

IEFeed

Enclosing class:

EReplyFeed

public static final class EReplyFeed.ERequest
extends EFeed

ERequest is responsible for matching an ERequestFeed.ERequest with a single EReplyFeed. The replier uses reply(EReplyMessage) to post a reply message back to the requesting client. Replies cannot be sent using EReplyFeed nor can ERequest instances be retrieved from EReplyFeed. It is the application's responsibility to track active ERequest instances in order to send reply messages back to requestors.

(EReplyFeed does track the active ERequest instances but for internal purposes only. The reason is due to ERequest not having the original request message. Without the request message, an ERequest object is unusable by the application.)

A request client does not directly interact with ERequest instances but with its ERequestFeed.ERequest. This is because there is a one-to-one relationship between ERequestFeed.ERequest and EReplyFeed.ERequest.

Each request is given an identifier that is unique for the request lifespan. Once the request reaches the done or canceled state, this identifier is returned an identifier pool for re-use. It is likely that a later request will be assigned the same identifier.

See Also:

ERequestFeed, ERequestFeed.ERequest, EReplyFeed, ERequestMessage, EReplyMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ESingleFeed.FeedType Enumerates the supported feed types.

Nested classes/interfaces inherited from class net.sf.eBus.client.EFeed

EFeed.AbstractClientTask, EFeed.FeedScope, EFeed.NotifyTask, EFeed.StatusTask<T extends IEFeed>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mActivationCount Tracks the number of contra-feeds matched to this feed.
protected static List<EFeed>	mAdvertisers Track the advertised feeds in order to generate advertise messages.
protected ESingleFeed.FeedType	mFeedType Specifies whether this is a publish, subscribe, request, or reply feed.
protected net.sf.eBus.client.ESubject	mSubject The feed interfaces with this eBus subject.

Fields inherited from class net.sf.eBus.client.EFeed

mEClient, mFeedId, mFeedState, mInPlace, mIsActive, mScope, NO_CONDITION, NOTIFY_METHOD

Method Summary

Modifier and Type	Method and Description
int	activationCount() Returns the feed activation count.
protected void	inactivate() Cancels this request if still active.
EMessageKey	key() Returns the feed message key.
String	messageSubject() Returns the feed message key subect.
EReplyFeed	replier() Returns the associated reply feed.
void	reply(EReplyMessage msg) Forwards the reply message to the request feed.
ERequestMessage	request() Returns the associated request message.
ERequestFeed.RequestState	state() Returns the current request state.
String	toString() Returns a containing the feed message key and data member values.

Methods inherited from class net.sf.eBus.client.EFeed

addAllKeys, addKey, checkScopes, clientId, close, defaultDispatcher, eClient, equals, feedId, feedState, findKeys, findKeys, findKeys, hashCode, inPlace, isActive, isFeedUp, isOverridden, loadKeys, location, register, register, register, scope, shutdown, shutdown, shutdownAll, startup, startup, startupAll, storeKeys, storeKeys, storeKeys

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

mAdvertisers

protected static final List<EFeed> mAdvertisers

Track the advertised feeds in order to generate advertise messages.

mFeedType

protected final ESingleFeed.FeedType mFeedType

Specifies whether this is a publish, subscribe, request, or reply feed.

mSubject

protected final net.sf.eBus.client.ESubject mSubject

The feed interfaces with this eBus subject. The subject type is based on feed type.

mActivationCount

protected int mActivationCount

Tracks the number of contra-feeds matched to this feed. If this is a publisher feed, then counts subscriber feeds. If a subscriber feed, then counts publisher feeds.

Method Detail

inactivate

protected void inactivate()

Cancels this request if still active.

Specified by:

inactivate in class EFeed

toString

public String toString()

Returns a containing the feed message key and data member values.

Returns:

textual representation of this feed.

request

public ERequestMessage request()

Returns the associated request message.

Returns:

request message.

state

public ERequestFeed.RequestState state()

Returns the current request state.

Returns:

the request state.

replier

public EReplyFeed replier()

Returns the associated reply feed.

Returns:

a reply feed.

reply

public void reply(EReplyMessage msg)
           throws IllegalArgumentException,
                  IllegalStateException

Forwards the reply message to the request feed. If this is a final reply (whether OK or error), the request state is set to done.

Parameters:

msg - the reply message.

Throws:

IllegalArgumentException - if msg is null or is not a valid reply message class for this request.

IllegalStateException - if the request state is done.

key

public final EMessageKey key()

Returns the feed message key. The message key type matches the feed type. If this is a EPublishFeed, then a notification message key is returned.

Returns:

message key.

messageSubject

public final String messageSubject()

Returns the feed message key subect.

Returns:

message key subject.

activationCount

public final int activationCount()

Returns the feed activation count.

Returns:

value ≥ zero.