org.objectweb.joram.mom.dest.Destination Class Reference

Inherits fr.dyade.aaa.agent.Agent, and org.objectweb.joram.mom.dest.AdminDestinationItf.

Inherited by org.objectweb.joram.mom.dest.Queue, and org.objectweb.joram.mom.dest.Topic.

Inheritance diagram for org.objectweb.joram.mom.dest.Destination:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.joram.mom.dest.Destination:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Destination ()
final void init (AgentId adminId, Properties properties)
abstract DestinationImpl createsImpl (AgentId adminId, Properties prop)
void agentFinalize (boolean lastTime)
void react (AgentId from, Notification not) throws Exception

Static Public Attributes

static Logger logger = Debug.getLogger(Destination.class.getName())

Protected Member Functions

 Destination (String name, boolean fixed, int stamp)
void agentInitialize (boolean firstTime) throws Exception
void setNoSave ()
void setSave ()

Protected Attributes

DestinationImpl destImpl

Detailed Description

A Destination agent is an agent hosting a MOM destination, for example a Queue or a Topic. Its behaviour is provided by a DestinationImpl instance.

See also:
DestinationItf

Definition at line 63 of file Destination.java.


Constructor & Destructor Documentation

org.objectweb.joram.mom.dest.Destination.Destination (  ) 

Empty constructor for newInstance().

Definition at line 76 of file Destination.java.

org.objectweb.joram.mom.dest.Destination.Destination ( String  name,
boolean  fixed,
int  stamp 
) [protected]

Constructor with parameters for fixing the destination and specifying its identifier. It is uniquely used by the AdminTopic agent.

Definition at line 83 of file Destination.java.


Member Function Documentation

final void org.objectweb.joram.mom.dest.Destination.init ( AgentId  adminId,
Properties  properties 
)

Initializes the destination by creating the DestinationItf object.

Parameters:
adminId Identifier of the destination administrator.
prop The initial set of properties.

Implements org.objectweb.joram.mom.dest.AdminDestinationItf.

Definition at line 94 of file Destination.java.

References org.objectweb.joram.mom.dest.Destination.createsImpl(), org.objectweb.joram.mom.dest.Destination.destImpl, and org.objectweb.joram.mom.dest.DestinationImpl.setAgent().

Referenced by org.objectweb.joram.mom.dest.AdminTopic.AdminTopic().

Here is the call graph for this function:

abstract DestinationImpl org.objectweb.joram.mom.dest.Destination.createsImpl ( AgentId  adminId,
Properties  prop 
) [pure virtual]

Creates the specific implementation.

Parameters:
adminId Identifier of the topic administrator.
prop The initial set of properties.

Implemented in com.scalagent.joram.mom.dest.ftp.FtpQueue, com.scalagent.joram.mom.dest.mail.JavaMailQueue, com.scalagent.joram.mom.dest.mail.JavaMailTopic, com.scalagent.joram.mom.dest.scheduler.SchedulerQueue, org.objectweb.joram.mom.dest.AdminTopic, org.objectweb.joram.mom.dest.ClusterQueue, org.objectweb.joram.mom.dest.DeadMQueue, org.objectweb.joram.mom.dest.jmsbridge.JMSBridgeQueue, org.objectweb.joram.mom.dest.jmsbridge.JMSBridgeTopic, org.objectweb.joram.mom.dest.MonitoringTopic, org.objectweb.joram.mom.dest.Queue, and org.objectweb.joram.mom.dest.Topic.

Referenced by org.objectweb.joram.mom.dest.Destination.init().

void org.objectweb.joram.mom.dest.Destination.agentInitialize ( boolean  firstTime  )  throws Exception [protected]

Gives this agent an opportunity to initialize after having been deployed, and each time it is loaded into memory.

Parameters:
firstTime true when first called by the factory
Exceptions:
Exception unspecialized exception

Reimplemented from fr.dyade.aaa.agent.Agent.

Reimplemented in com.scalagent.joram.mom.dest.mail.JavaMailQueue, com.scalagent.joram.mom.dest.mail.JavaMailTopic, org.objectweb.joram.mom.dest.MonitoringTopic, and org.objectweb.joram.mom.dest.Queue.

Definition at line 116 of file Destination.java.

References org.objectweb.joram.mom.dest.Destination.destImpl, org.objectweb.joram.mom.dest.DestinationImpl.initialize(), org.objectweb.joram.mom.dest.Destination.logger, and org.objectweb.joram.mom.dest.DestinationImpl.setAgent().

Here is the call graph for this function:

void org.objectweb.joram.mom.dest.Destination.agentFinalize ( boolean  lastTime  ) 

Finalizes the agent before it is garbaged.

Reimplemented from fr.dyade.aaa.agent.Agent.

Definition at line 133 of file Destination.java.

void org.objectweb.joram.mom.dest.Destination.react ( AgentId  from,
Notification  not 
) throws Exception

Distributes the received notifications to the appropriate reactions.

Exceptions:
Exception 

Reimplemented from fr.dyade.aaa.agent.Agent.

Reimplemented in com.scalagent.joram.mom.dest.ftp.FtpQueue, com.scalagent.joram.mom.dest.mail.JavaMailQueue, com.scalagent.joram.mom.dest.mail.JavaMailTopic, com.scalagent.joram.mom.dest.scheduler.SchedulerQueue, org.objectweb.joram.mom.dest.AdminTopic, org.objectweb.joram.mom.dest.ClusterQueue, org.objectweb.joram.mom.dest.jmsbridge.JMSBridgeQueue, org.objectweb.joram.mom.dest.jmsbridge.JMSBridgeTopic, org.objectweb.joram.mom.dest.MonitoringTopic, org.objectweb.joram.mom.dest.Queue, and org.objectweb.joram.mom.dest.Topic.

Definition at line 154 of file Destination.java.

References org.objectweb.joram.mom.dest.DestinationImpl.canBeDeleted(), org.objectweb.joram.mom.dest.DestinationImpl.clientMessages(), org.objectweb.joram.mom.dest.DestinationImpl.deleteNot(), org.objectweb.joram.mom.dest.Destination.destImpl, org.objectweb.joram.mom.dest.DestinationImpl.destinationAdminRequestNot(), org.objectweb.joram.mom.dest.Destination.logger, org.objectweb.joram.mom.dest.DestinationImpl.monitFreeAccess(), org.objectweb.joram.mom.dest.DestinationImpl.monitGetDMQSettings(), org.objectweb.joram.mom.dest.DestinationImpl.monitGetReaders(), org.objectweb.joram.mom.dest.DestinationImpl.monitGetStat(), org.objectweb.joram.mom.dest.DestinationImpl.monitGetWriters(), org.objectweb.joram.mom.dest.DestinationImpl.requestGroupNot(), org.objectweb.joram.mom.dest.DestinationImpl.setDMQRequest(), org.objectweb.joram.mom.dest.Destination.setNoSave(), org.objectweb.joram.mom.dest.DestinationImpl.setRightRequest(), org.objectweb.joram.mom.dest.DestinationImpl.specialAdminRequest(), and org.objectweb.joram.mom.dest.DestinationImpl.unknownAgent().

Here is the call graph for this function:

void org.objectweb.joram.mom.dest.Destination.setNoSave (  )  [protected]

Sets the updated field to false so that the agent state is not saved after the current reaction; the field is set back to true for the next reaction.

Reimplemented from fr.dyade.aaa.agent.Agent.

Definition at line 210 of file Destination.java.

Referenced by org.objectweb.joram.mom.dest.Destination.react(), and org.objectweb.joram.mom.dest.DestinationImpl.setNoSave().

void org.objectweb.joram.mom.dest.Destination.setSave (  )  [protected]

Sets the updated field to true so that the agent state is saved after the current reaction.

Reimplemented from fr.dyade.aaa.agent.Agent.

Definition at line 217 of file Destination.java.

Referenced by org.objectweb.joram.mom.dest.AdminTopic.react(), and org.objectweb.joram.mom.dest.DestinationImpl.setSave().


Member Data Documentation

Logger org.objectweb.joram.mom.dest.Destination.logger = Debug.getLogger(Destination.class.getName()) [static]

logger

Reimplemented in com.scalagent.joram.mom.dest.ftp.FtpQueue, and com.scalagent.joram.mom.dest.scheduler.SchedulerQueue.

Definition at line 65 of file Destination.java.

Referenced by org.objectweb.joram.mom.dest.Destination.agentInitialize(), org.objectweb.joram.mom.dest.MonitoringTopic.createsImpl(), org.objectweb.joram.mom.dest.MonitoringTopic.init(), org.objectweb.joram.mom.dest.MonitoringTopic.react(), org.objectweb.joram.mom.dest.AdminTopic.react(), org.objectweb.joram.mom.dest.Topic.react(), org.objectweb.joram.mom.dest.Queue.react(), and org.objectweb.joram.mom.dest.Destination.react().

DestinationImpl org.objectweb.joram.mom.dest.Destination.destImpl [protected]

The reference of the DestinationItf instance providing this this agent with its Destination behaviour.

Definition at line 71 of file Destination.java.

Referenced by org.objectweb.joram.mom.dest.MonitoringTopic.agentInitialize(), org.objectweb.joram.mom.dest.Queue.agentInitialize(), org.objectweb.joram.mom.dest.Destination.agentInitialize(), com.scalagent.joram.mom.dest.mail.JavaMailTopic.agentInitialize(), com.scalagent.joram.mom.dest.mail.JavaMailQueue.agentInitialize(), org.objectweb.joram.mom.dest.Destination.init(), org.objectweb.joram.mom.dest.MonitoringTopic.react(), org.objectweb.joram.mom.dest.jmsbridge.JMSBridgeTopic.react(), org.objectweb.joram.mom.dest.jmsbridge.JMSBridgeQueue.react(), org.objectweb.joram.mom.dest.AdminTopic.react(), org.objectweb.joram.mom.dest.ClusterQueue.react(), org.objectweb.joram.mom.dest.Topic.react(), org.objectweb.joram.mom.dest.Queue.react(), org.objectweb.joram.mom.dest.Destination.react(), com.scalagent.joram.mom.dest.scheduler.SchedulerQueue.react(), com.scalagent.joram.mom.dest.mail.JavaMailTopic.react(), com.scalagent.joram.mom.dest.mail.JavaMailQueue.react(), com.scalagent.joram.mom.dest.ftp.FtpQueue.react(), org.objectweb.joram.mom.dest.Queue.readBag(), and org.objectweb.joram.mom.dest.Queue.writeBag().


The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:19:32 2008 for joram by  doxygen 1.5.0