net.sf.eBus.client

Interface IEPublishFeed

All Superinterfaces:

IEFeed

All Known Implementing Classes:

EMultiPublishFeed, EPublishFeed

public interface IEPublishFeed
extends IEFeed

Provides a common view for EPublishFeed and EMultiPublishFeed feeds. Allows an application to reference single- and multi-key publish feeds referenced as an IEPublishFeed.

Author:

Charles W. Rapp

Method Summary

Modifier and Type	Method and Description
void	advertise() Advertises this publisher feed to the associated notification subject.
boolean	isAdvertised() Returns true if this publish feed is both open and advertised; otherwise, returns false.
boolean	isFeedUp(String subject) Returns true if the publisher is clear to publish a notification for the given feed and false if not clear.
void	publish(ENotificationMessage msg) Posts this notification message to all interested subscribers.
EFeedState	publishState() Returns the current publish state.
void	statusCallback(FeedStatusCallback<IEPublishFeed> cb) Puts the publish status callback in place.
void	unadvertise() Retracts this publisher feed from the associated notification subject.
void	updateFeedState(EFeedState update) Updates the publish feed state to the given value.

Methods inherited from interface net.sf.eBus.client.IEFeed

close, eClient, feedId, inPlace, isActive, isFeedUp, key, scope

Method Detail

isAdvertised

boolean isAdvertised()

Returns true if this publish feed is both open and advertised; otherwise, returns false.

Returns:

true if this publish feed is open and advertised.

publishState

EFeedState publishState()

Returns the current publish state.

Returns:

current publish state.

isFeedUp

boolean isFeedUp(String subject)

Returns true if the publisher is clear to publish a notification for the given feed and false if not clear.

Parameters:

subject - check the feed status for this subject.

Returns:

true if the specified publisher feed is up and the publisher is free to publish notification messages for the specified subject.

statusCallback

void statusCallback(FeedStatusCallback<IEPublishFeed> cb)

Puts the publish status callback in place. If cb is not null, publish status updates will be passed to cb rather than EPublisher.publishStatus(EFeedState, IEPublishFeed). The reverse is true if cb is null. That is, a null cb means publish status updates are posted to the EPublisher.publishStatus(EFeedState, IEPublishFeed) override.

Parameters:

cb - publish status update callback. May be null.

advertise

void advertise()

Advertises this publisher feed to the associated notification subject. If this feed is currently advertised to the subject, then does nothing.

unadvertise

void unadvertise()

Retracts this publisher feed from the associated notification subject. Does nothing if this feed is not currently advertised.

updateFeedState

void updateFeedState(EFeedState update)

Updates the publish feed state to the given value. If update equals the currently stored publish feed state, nothing is done. Otherwise, the updated value is stored. If this feed is advertised to the server and the subscription feed is up, then this update is forwarded to the subject.

Parameters:

update - new publish feed state.

publish

void publish(ENotificationMessage msg)

Posts this notification message to all interested subscribers.

Parameters:

msg - post this message to subscribers.