|
Joram 5.1.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.joram.mom.dest.DestinationImpl
org.objectweb.joram.mom.dest.TopicImpl
public class TopicImpl
The TopicImpl
class implements the MOM topic behaviour,
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't 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 fr.dyade.aaa.agent.AgentId |
fatherId
Identifier of this topic's father, if any. |
protected java.util.Set |
friends
Set of cluster fellows, if any. |
protected java.util.Hashtable |
selectors
Table of subscribers' selectors. |
protected java.util.Vector |
subscribers
Vector of subscribers' identifiers. |
Fields inherited from class org.objectweb.joram.mom.dest.DestinationImpl |
---|
_rights, agent, clients, creationDate, dmqId, freeReading, freeWriting, logger, nbMsgsDeliverSinceCreation, nbMsgsReceiveSinceCreation, nbMsgsSentToDMQSinceCreation, READ, READWRITE, WRITE |
Constructor Summary | |
---|---|
TopicImpl(fr.dyade.aaa.agent.AgentId adminId,
java.util.Properties prop)
Constructs a TopicImpl instance. |
Method Summary | |
---|---|
void |
clusterAck(fr.dyade.aaa.agent.AgentId from,
org.objectweb.joram.mom.dest.ClusterAck ack)
Method implementing the reaction to a ClusterAck
notification sent by a topic requested to join the cluster. |
void |
clusterNot(fr.dyade.aaa.agent.AgentId from,
org.objectweb.joram.mom.dest.ClusterNot not)
Method implementing the reaction to a ClusterNot
notification sent by a fellow topic for notifying this topic
of a new cluster fellow. |
void |
clusterRequest(fr.dyade.aaa.agent.AgentId from,
ClusterRequest req)
Method implementing the reaction to a ClusterRequest
instance requesting to add a topic to the cluster, or to set a
cluster with a given topic. |
void |
clusterTest(fr.dyade.aaa.agent.AgentId from,
org.objectweb.joram.mom.dest.ClusterTest not)
Method implementing the reaction to a ClusterTest
notification sent by a fellow topic for testing if this topic might be
part of a cluster. |
void |
destinationAdminRequestNot(fr.dyade.aaa.agent.AgentId from,
DestinationAdminRequestNot not)
|
protected void |
doClientMessages(fr.dyade.aaa.agent.AgentId from,
ClientMessages not)
Method specifically processing a ClientMessages instance. |
protected void |
doDeleteNot(fr.dyade.aaa.agent.DeleteNot not)
Method specifically processing a fr.dyade.aaa.agent.DeleteNot instance. |
protected void |
doRightRequest(SetRightRequest not)
Method specifically processing a SetRightRequest instance. |
protected void |
doUnknownAgent(fr.dyade.aaa.agent.UnknownAgent uA)
Method specifically processing an UnknownAgent instance. |
void |
fatherAck(fr.dyade.aaa.agent.AgentId from,
org.objectweb.joram.mom.dest.FatherAck not)
Method reacting to a FatherAck notification coming from
the topic this topic requested as a father. |
void |
fatherTest(fr.dyade.aaa.agent.AgentId from,
org.objectweb.joram.mom.dest.FatherTest not)
Method reacting to a FatherTest notification checking if it
can be a father to a topic. |
protected void |
forwardMessages(ClientMessages messages)
Actually forwards a vector of messages to the father or the cluster fellows, if any. |
long |
getNbMsgsReceiveSinceCreation()
Returns the number of messages received since creation time of this destination. |
java.lang.String[] |
getSubscriberIds()
Returns the list of unique identifiers of all subscribers. |
void |
initialize(boolean firstTime)
Initializes the destination. |
void |
monitGetCluster(fr.dyade.aaa.agent.AgentId from,
Monit_GetCluster not)
Method implementing the reaction to a Monit_GetCluster
notification requesting the identifiers of the cluster's topics. |
void |
monitGetFather(fr.dyade.aaa.agent.AgentId from,
Monit_GetFather not)
Method implementing the reaction to a Monit_GetFather
notification requesting the identifier of the hierarchical father. |
void |
monitGetSubscriptions(fr.dyade.aaa.agent.AgentId from,
Monit_GetSubscriptions not)
Method implementing the reaction to a Monit_GetSubscriptions notification requesting the
number of subscriptions. |
void |
postSubscribe(SubscribeRequest not)
|
void |
postUnsubscribe(UnsubscribeRequest not)
|
void |
preSubscribe(SubscribeRequest not)
|
void |
preUnsubscribe(UnsubscribeRequest not)
|
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 |
setAlreadySentLocally(boolean alreadySentLocally)
|
void |
setFatherRequest(fr.dyade.aaa.agent.AgentId from,
SetFatherRequest request)
Method implementing the reaction to a SetFatherRequest
instance notifying this topic it is part of a hierarchy as a son. |
void |
subscribeRequest(fr.dyade.aaa.agent.AgentId from,
SubscribeRequest not)
Method implementing the reaction to a SubscribeRequest
instance. |
void |
topicForwardNot(fr.dyade.aaa.agent.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. |
void |
unclusterNot(fr.dyade.aaa.agent.AgentId from,
org.objectweb.joram.mom.dest.UnclusterNot not)
Method implementing the reaction to an UnclusterNot
notification sent by a topic leaving the cluster. |
void |
unclusterRequest(fr.dyade.aaa.agent.AgentId from,
UnclusterRequest request)
Method implementing the reaction to an UnclusterRequest
instance requesting this topic to leave the cluster it is part of. |
void |
unsetFatherRequest(fr.dyade.aaa.agent.AgentId from,
UnsetFatherRequest request)
Method implementing the reaction to an UnsetFatherRequest
instance notifying this topic to leave its father. |
void |
unsubscribeRequest(fr.dyade.aaa.agent.AgentId from,
UnsubscribeRequest not)
Method implementing the reaction to an UnsubscribeRequest
instance, requesting to remove a subscriber. |
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.DestinationImplMBean |
---|
getCreationDate, getCreationTimeInMillis, getDestinationId, getDMQId, getNbMsgsDeliverSinceCreation, getNbMsgsSentToDMQSinceCreation, getRight, getRights, isFreeReading, isFreeWriting, setFreeReading, setFreeWriting |
Field Detail |
---|
protected fr.dyade.aaa.agent.AgentId fatherId
protected java.util.Set friends
protected java.util.Vector subscribers
protected java.util.Hashtable selectors
protected transient boolean alreadySentLocally
Constructor Detail |
---|
public TopicImpl(fr.dyade.aaa.agent.AgentId adminId, java.util.Properties prop)
TopicImpl
instance.
destId
- Identifier of the agent hosting the topic.adminId
- Identifier of the administrator of the topic.prop
- The initial set of properties.Method Detail |
---|
public void initialize(boolean firstTime)
initialize
in class DestinationImpl
firstTime
- true when first called by the factorypublic java.lang.String toString()
toString
in interface DestinationImplMBean
toString
in class java.lang.Object
public void clusterRequest(fr.dyade.aaa.agent.AgentId from, ClusterRequest req) throws AccessException
ClusterRequest
instance requesting to add a topic to the cluster, or to set a
cluster with a given topic.
AccessException
- If the requester is not an administrator.public void clusterTest(fr.dyade.aaa.agent.AgentId from, org.objectweb.joram.mom.dest.ClusterTest not)
ClusterTest
notification sent by a fellow topic for testing if this topic might be
part of a cluster.
public void clusterAck(fr.dyade.aaa.agent.AgentId from, org.objectweb.joram.mom.dest.ClusterAck ack)
ClusterAck
notification sent by a topic requested to join the cluster.
public void clusterNot(fr.dyade.aaa.agent.AgentId from, org.objectweb.joram.mom.dest.ClusterNot not)
ClusterNot
notification sent by a fellow topic for notifying this topic
of a new cluster fellow.
public void unclusterRequest(fr.dyade.aaa.agent.AgentId from, UnclusterRequest request) throws MomException
UnclusterRequest
instance requesting this topic to leave the cluster it is part of.
AccessException
- If the requester is not an administrator.
MomException
public void unclusterNot(fr.dyade.aaa.agent.AgentId from, org.objectweb.joram.mom.dest.UnclusterNot not)
UnclusterNot
notification sent by a topic leaving the cluster.
public void setFatherRequest(fr.dyade.aaa.agent.AgentId from, SetFatherRequest request) throws MomException
SetFatherRequest
instance notifying this topic it is part of a hierarchy as a son.
AccessException
- If the requester is not an administrator.
MomException
public void fatherTest(fr.dyade.aaa.agent.AgentId from, org.objectweb.joram.mom.dest.FatherTest not)
FatherTest
notification checking if it
can be a father to a topic.
public void fatherAck(fr.dyade.aaa.agent.AgentId from, org.objectweb.joram.mom.dest.FatherAck not)
FatherAck
notification coming from
the topic this topic requested as a father.
public void unsetFatherRequest(fr.dyade.aaa.agent.AgentId from, UnsetFatherRequest request) throws MomException
UnsetFatherRequest
instance notifying this topic to leave its father.
AccessException
- If the requester is not an administrator.
MomException
public void monitGetSubscriptions(fr.dyade.aaa.agent.AgentId from, Monit_GetSubscriptions not) throws AccessException
Monit_GetSubscriptions
notification requesting the
number of subscriptions.
AccessException
- If the requester is not the administrator.public void monitGetFather(fr.dyade.aaa.agent.AgentId from, Monit_GetFather not) throws AccessException
Monit_GetFather
notification requesting the identifier of the hierarchical father.
AccessException
- If the requester is not the administrator.public void monitGetCluster(fr.dyade.aaa.agent.AgentId from, Monit_GetCluster not) throws AccessException
Monit_GetCluster
notification requesting the identifiers of the cluster's topics.
AccessException
- If the requester is not the administrator.public void preSubscribe(SubscribeRequest not)
public void postSubscribe(SubscribeRequest not)
public void subscribeRequest(fr.dyade.aaa.agent.AgentId from, SubscribeRequest not) throws AccessException
SubscribeRequest
instance.
AccessException
- If the sender is not a READER.public void preUnsubscribe(UnsubscribeRequest not)
public void postUnsubscribe(UnsubscribeRequest not)
public void unsubscribeRequest(fr.dyade.aaa.agent.AgentId from, UnsubscribeRequest not)
UnsubscribeRequest
instance, requesting to remove a subscriber.
public void topicForwardNot(fr.dyade.aaa.agent.AgentId from, TopicForwardNot not)
TopicForwardNot
instance, carrying messages forwarded by a cluster fellow or a
hierarchical son.
public void destinationAdminRequestNot(fr.dyade.aaa.agent.AgentId from, DestinationAdminRequestNot not)
destinationAdminRequestNot
in class DestinationImpl
public java.lang.String[] getSubscriberIds()
getSubscriberIds
in interface TopicImplMBean
protected void doRightRequest(SetRightRequest not)
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 DestinationImpl
protected void doClientMessages(fr.dyade.aaa.agent.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 DestinationImpl
protected void doUnknownAgent(fr.dyade.aaa.agent.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 DestinationImpl
protected void doDeleteNot(fr.dyade.aaa.agent.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 DestinationImpl
protected void forwardMessages(ClientMessages messages)
protected void processMessages(ClientMessages not)
TopicMsgsReply
notification
to the valid subscribers.
public void setAlreadySentLocally(boolean alreadySentLocally)
public long getNbMsgsReceiveSinceCreation()
DestinationImpl
getNbMsgsReceiveSinceCreation
in interface DestinationImplMBean
getNbMsgsReceiveSinceCreation
in class DestinationImpl
|
Joram 5.1.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |