|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.dyade.aaa.agent.Agent
org.objectweb.joram.mom.dest.Destination
org.objectweb.joram.mom.dest.Topic
public class Topic
The Topic
class implements the MOM topic behavior,
basically distributing the received messages to subscribers.
A Topic might be part of a hierarchy; if it is the case, and if the topic is not on top of that hierarchy, it will have a father to forward messages to.
A topic might also be part of a cluster; if it is the case, it will have friends to forward messages to.
A topic can be part of a hierarchy and of a cluster at the same time.
Field Summary | |
---|---|
protected boolean |
alreadySentLocally
Internal boolean used for tagging local sendings. |
protected AgentId |
fatherId
Identifier of this topic's father, if any. |
protected java.util.Set |
friends
Set of cluster elements (including itself), if any. |
static org.objectweb.util.monolog.api.Logger |
logger
|
protected java.util.Map |
selectors
Table of subscribers' selectors. |
protected java.util.List |
subscribers
Vector of subscribers' identifiers. |
Fields inherited from class org.objectweb.joram.mom.dest.Destination |
---|
_rights, clients, creationDate, dmqId, freeReading, freeWriting, nbMsgsDeliverSinceCreation, nbMsgsReceiveSinceCreation, nbMsgsSentToDMQSinceCreation, READ, READWRITE, task, WAKEUP_PERIOD, WRITE |
Fields inherited from class fr.dyade.aaa.agent.Agent |
---|
emptyString, fixed, logmon |
Constructor Summary | |
---|---|
Topic()
|
|
Topic(java.lang.String string,
boolean b,
int joramAdminStamp)
|
Method Summary | |
---|---|
protected void |
clusterJoin(ClusterJoinNot not)
Method implementing the reaction to a ClusterJoinNot notification,
sent by a fellow topic for notifying this topic to join the cluster, doing
a transitive closure of clusters, if any. |
protected void |
clusterJoinAck(ClusterJoinAck not)
Method implementing the reaction to a ClusterJoinAck notification,
doing a transitive closure with the current cluster and the one of the new
cluster element. |
protected void |
doClientMessages(AgentId from,
ClientMessages not)
Method specifically processing a ClientMessages instance. |
protected void |
doDeleteNot(DeleteNot not)
Method specifically processing a fr.dyade.aaa.agent.DeleteNot
instance. |
protected void |
doRightRequest(AgentId user,
int right)
Method specifically processing a SetRightRequest instance. |
protected void |
doUnknownAgent(UnknownAgent uA)
Method specifically processing an UnknownAgent instance. |
protected void |
forwardMessages(ClientMessages messages)
Actually forwards a list of messages to the father or the cluster fellows, if any. |
java.lang.String[] |
getClusterElements()
|
long |
getNbMsgsReceiveSinceCreation()
Returns the number of messages received since creation time of this destination. |
int |
getNumberOfSubscribers()
Returns the number of subscribers. |
java.lang.String[] |
getSubscriberIds()
Returns the list of unique identifiers of all subscribers. |
byte |
getType()
Returns the type of this destination: Queue or Topic. |
void |
handleAdminRequestNot(AgentId from,
FwdAdminRequestNot not)
|
void |
initialize(boolean firstTime)
Initializes the destination. |
void |
postSubscribe()
Deprecated. |
void |
postUnsubscribe()
Deprecated. |
void |
preSubscribe()
Deprecated. |
void |
preUnsubscribe()
Deprecated. |
protected void |
processMessages(ClientMessages not)
Actually processes the distribution of the received messages to the valid subscriptions by sending a TopicMsgsReply notification
to the valid subscribers. |
void |
react(AgentId from,
Notification not)
Distributes the received notifications to the appropriate reactions. |
protected void |
sendToCluster(Notification not)
Sends a notification to all topics in cluster. |
void |
setAlreadySentLocally(boolean alreadySentLocally)
|
protected void |
subscribeRequest(AgentId from,
SubscribeRequest not)
Method implementing the reaction to a SubscribeRequest
instance. |
protected void |
topicForwardNot(AgentId from,
TopicForwardNot not)
Method implementing the reaction to a TopicForwardNot
instance, carrying messages forwarded by a cluster fellow or a
hierarchical son. |
java.lang.String |
toString()
Returns a string representation of this destination. |
protected void |
unsubscribeRequest(AgentId from)
Method implementing the reaction to an UnsubscribeRequest
instance, requesting to remove a subscriber. |
void |
wakeUpNot(WakeUpNot not)
|
Methods inherited from class fr.dyade.aaa.agent.Agent |
---|
delete, delete, deploy, deploy, getAgentId, getCommitTime, getId, getLogTopic, getName, getReactNb, getReactTime, isDeployed, isFixed, needToBeCommited, save, sendTo, sendTo, sendTo, setName, setNoSave, setSave |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.objectweb.joram.mom.dest.DestinationMBean |
---|
delete, getCreationDate, getCreationTimeInMillis, getDestinationId, getDMQId, getName, getNbMsgsDeliverSinceCreation, getNbMsgsSentToDMQSinceCreation, getPeriod, getRight, getRights, isFreeReading, isFreeWriting, setFreeReading, setFreeWriting, setPeriod |
Methods inherited from interface fr.dyade.aaa.agent.AgentMBean |
---|
getAgentId, getCommitTime, getReactNb, getReactTime, isFixed |
Field Detail |
---|
public static org.objectweb.util.monolog.api.Logger logger
protected AgentId fatherId
protected java.util.Set friends
protected java.util.List subscribers
protected java.util.Map selectors
protected transient boolean alreadySentLocally
Constructor Detail |
---|
public Topic()
public Topic(java.lang.String string, boolean b, int joramAdminStamp)
Method Detail |
---|
public final byte getType()
Destination
getType
in class Destination
DestinationConstants.TOPIC_TYPE
,
DestinationConstants.QUEUE_TYPE
public void react(AgentId from, Notification not) throws java.lang.Exception
react
in class Destination
from
- agent sending notificationnot
- notification to react to
java.lang.Exception
public void initialize(boolean firstTime)
initialize
in class Destination
firstTime
- true when first called by the factorypublic java.lang.String toString()
toString
in interface AgentMBean
toString
in interface DestinationMBean
toString
in class Agent
public void wakeUpNot(WakeUpNot not)
wakeUpNot
in class Destination
protected void clusterJoin(ClusterJoinNot not)
ClusterJoinNot
notification,
sent by a fellow topic for notifying this topic to join the cluster, doing
a transitive closure of clusters, if any.
protected void clusterJoinAck(ClusterJoinAck not)
ClusterJoinAck
notification,
doing a transitive closure with the current cluster and the one of the new
cluster element.
public java.lang.String[] getClusterElements()
getClusterElements
in interface ClusterDestinationMBean
protected void sendToCluster(Notification not)
not
- The notification to send.public void preSubscribe()
public void postSubscribe()
protected void subscribeRequest(AgentId from, SubscribeRequest not) throws AccessException
SubscribeRequest
instance.
AccessException
- If the sender is not a READER.public void preUnsubscribe()
public void postUnsubscribe()
protected void unsubscribeRequest(AgentId from)
UnsubscribeRequest
instance, requesting to remove a subscriber.
protected void topicForwardNot(AgentId from, TopicForwardNot not)
TopicForwardNot
instance, carrying messages forwarded by a cluster fellow or a
hierarchical son.
public void handleAdminRequestNot(AgentId from, FwdAdminRequestNot not)
handleAdminRequestNot
in class Destination
Destination.handleAdminRequestNot(fr.dyade.aaa.agent.AgentId, org.objectweb.joram.mom.notifications.FwdAdminRequestNot)
public final int getNumberOfSubscribers()
getNumberOfSubscribers
in interface TopicMBean
public final java.lang.String[] getSubscriberIds()
getSubscriberIds
in interface TopicMBean
protected void doRightRequest(AgentId user, int right)
SetRightRequest
instance.
When a reader is removed, deleting this reader's subscription if any,
and sending an ExceptionReply
notification to the client.
doRightRequest
in class Destination
user
- The user about right modification.right
- The right modification.protected void doClientMessages(AgentId from, ClientMessages not)
ClientMessages
instance.
This method may forward the messages to the topic father if any, or
to the cluster fellows if any.It may finally send
TopicMsgsReply
instances to the valid subscribers.
doClientMessages
in class Destination
protected void doUnknownAgent(UnknownAgent uA)
UnknownAgent
instance.
This method notifies the administrator of the failing cluster or hierarchy building request, if needed, or removes the subscriptions of the deleted client, if any, or sets the father identifier to null if it comes from a deleted father.
doUnknownAgent
in class Destination
protected void doDeleteNot(DeleteNot not)
fr.dyade.aaa.agent.DeleteNot
instance.
UnknownAgent
notifications are sent to each subscriber and
UnclusterNot
notifications to the cluster fellows.
doDeleteNot
in class Destination
protected void forwardMessages(ClientMessages messages)
protected void processMessages(ClientMessages not)
TopicMsgsReply
notification
to the valid subscribers.
public void setAlreadySentLocally(boolean alreadySentLocally)
public long getNbMsgsReceiveSinceCreation()
Destination
getNbMsgsReceiveSinceCreation
in interface DestinationMBean
getNbMsgsReceiveSinceCreation
in class Destination
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |