org.objectweb.joram.mom.dest
Class Destination

java.lang.Object
  fr.dyade.aaa.agent.Agent
      org.objectweb.joram.mom.dest.Destination

All Implemented Interfaces:

fr.dyade.aaa.agent.AgentMBean, java.io.Serializable, AdminDestinationItf

Direct Known Subclasses:

Queue, Topic

public abstract class Destination
extends fr.dyade.aaa.agent.Agent
implements AdminDestinationItf

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:

AdminDestinationItf, Serialized Form

Field Summary

protected DestinationImpl	destImpl The reference of the DestinationItf instance providing this this agent with its Destination behaviour.
static org.objectweb.util.monolog.api.Logger	logger logger

Fields inherited from class fr.dyade.aaa.agent.Agent

fixed, logmon, name, nullName

Constructor Summary

	Destination() Empty constructor for newInstance().
protected	Destination(java.lang.String name, boolean fixed, int stamp) Constructor with parameters for fixing the destination and specifying its identifier.

Method Summary

void	agentFinalize(boolean lastTime) Finalizes the agent before it is garbaged.
protected void	agentInitialize(boolean firstTime) Gives this agent an opportunity to initialize after having been deployed, and each time it is loaded into memory.
abstract DestinationImpl	createsImpl(fr.dyade.aaa.agent.AgentId adminId, java.util.Properties prop) Creates the specific implementation.
abstract byte	getType() Returns the type of this destination: Queue or Topic.
void	init(fr.dyade.aaa.agent.AgentId adminId, java.util.Properties props) Initializes the destination by creating the DestinationItf object.
void	react(fr.dyade.aaa.agent.AgentId from, fr.dyade.aaa.agent.Notification not) Distributes the received notifications to the appropriate reactions.
protected void	setNoSave()
protected void	setSave()

Methods inherited from class fr.dyade.aaa.agent.Agent

delete, delete, delete, deploy, deploy, getAgentId, getId, getLogTopic, getName, isDeployed, isFixed, needToBeCommited, save, sendTo, sendTo, sendTo, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

public static org.objectweb.util.monolog.api.Logger logger

logger

destImpl

protected DestinationImpl destImpl

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

Constructor Detail

Destination

public Destination()

Empty constructor for newInstance().

Destination

protected Destination(java.lang.String name,
                      boolean fixed,
                      int stamp)

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

Method Detail

init

public final void init(fr.dyade.aaa.agent.AgentId adminId,
                       java.util.Properties props)

Initializes the destination by creating the DestinationItf object.

Specified by:

init in interface AdminDestinationItf

Parameters:

adminId - Identifier of the destination administrator.

props - The initial set of properties.

createsImpl

public abstract DestinationImpl createsImpl(fr.dyade.aaa.agent.AgentId adminId,
                                            java.util.Properties prop)

Creates the specific implementation.

Parameters:

adminId - Identifier of the topic administrator.

prop - The initial set of properties.

getType

public abstract byte getType()

Returns the type of this destination: Queue or Topic.

Returns:

the type of this destination.

See Also:

DestinationConstants.TOPIC_TYPE, DestinationConstants.QUEUE_TYPE

agentInitialize

protected void agentInitialize(boolean firstTime)
                        throws java.lang.Exception

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

Overrides:

agentInitialize in class fr.dyade.aaa.agent.Agent

Parameters:

firstTime - true when first called by the factory

Throws:

java.lang.Exception - unspecialized exception

agentFinalize

public void agentFinalize(boolean lastTime)

Finalizes the agent before it is garbaged.

Overrides:

agentFinalize in class fr.dyade.aaa.agent.Agent

react

public void react(fr.dyade.aaa.agent.AgentId from,
                  fr.dyade.aaa.agent.Notification not)
           throws java.lang.Exception

Distributes the received notifications to the appropriate reactions.

Overrides:

react in class fr.dyade.aaa.agent.Agent

Throws:

java.lang.Exception

setNoSave

protected void setNoSave()

Overrides:

setNoSave in class fr.dyade.aaa.agent.Agent

setSave

protected void setSave()

Overrides:

setSave in class fr.dyade.aaa.agent.Agent