Package org.objectweb.joram.mom.dest

Class AcquisitionTopic

java.lang.Object

fr.dyade.aaa.agent.Agent

org.objectweb.joram.mom.dest.Destination

org.objectweb.joram.mom.dest.Topic

org.objectweb.joram.mom.dest.AcquisitionTopic

All Implemented Interfaces:

AgentMBean, Encodable, Serializable, AcquisitionMBean, AcquisitionTopicMBean, ClusterDestinationMBean, DestinationMBean, TopicMBean

public class AcquisitionTopic
extends Topic
implements AcquisitionTopicMBean

The AcquisitionTopic class implements the MOM acquisition topic behavior, basically acquiring messages periodically or on client request, using an AcquisitionModule.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private String	ACQ_TOPIC_MAX_MSG
private String	ACQ_TOPIC_MIN_MSG
private String	acquisitionClassName	The acquisition class name.
private AcquisitionModule	acquisitionModule	The acquisition module.
private long	acquisitionNotNb
private static boolean	DEBUG
private long	diff_max	The threshold of messages send by the handler in the engine
private long	diff_min
private String	lastMessageId	Stores the id of the last message received to avoid duplicates.
private static Logger	logger
private long	msgCount	The number of produced messages.
private boolean	pause
private Properties	properties	Stores the last set of properties defined.
private static long	serialVersionUID	define serialVersionUID for interoperability

Fields inherited from class org.objectweb.joram.mom.dest.Topic

fatherId, friends, nbMsgsReceiveSinceCreation, selectors, subscribers

Fields inherited from class org.objectweb.joram.mom.dest.Destination

clients, dmqId, freeReading, freeWriting, nbMsgsDeliverSinceCreation, nbMsgsSentToDMQSinceCreation, READ, READWRITE, strbuf, strictCounters, task, temporary, WRITE

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

agentProfiling, emptyString, fixed, logmon

Fields inherited from interface fr.dyade.aaa.common.encoding.Encodable

BOOLEAN_ENCODED_SIZE, BYTE_ENCODED_SIZE, DOUBLE_ENCODED_SIZE, FLOAT_ENCODED_SIZE, INT_ENCODED_SIZE, LONG_ENCODED_SIZE, SHORT_ENCODED_SIZE

Constructor Summary

Constructors

Constructor	Description
AcquisitionTopic()

Method Summary

Modifier and Type	Method	Description
private void	acquisitionNot(AgentId from, AcquisitionNot not)	This method process messages from the acquisition module.
void	agentFinalize(boolean lastTime)	Finalizes the agent before it is garbaged.
private void	close()
String	dumpProperties()
long	getAcquiredMsgCount()	Returns the number of messages acquired by the acquisition handler.
String	getAcquisitionClassName()	Returns the acquisition handler class name.
long	getAcquisitionPeriod()	Returns the acquisition period.
long	getDiffMax()	Returns the maximum number of acquired messages waiting to be handled by the destination.
long	getDiffMin()	Returns the minimum threshold of acquired messages waiting to be handled by the destination for restarting the acquisition handler.
long	getExpiration()	Returns the expiration value for produced messages.
int	getPriority()	Returns the priority of produced messages.
void	initialize(boolean firstTime)	Initializes the destination.
boolean	isMessagePersistent()	Returns true if the messages produced are persistent.
ClientMessages	preProcess(AgentId from, ClientMessages cm)	Incoming JMS messages are processed by the acquisition module and a null ClientMessages is always returned to the base implementation.
void	react(AgentId from, Notification not)	Distributes the received notifications to the appropriate reactions.
void	setExpiration(long expiration)	Sets the expiration value for produced messages.
void	setMessagePersistent(boolean isPersistent)	Sets the DeliveryMode value for the produced messages.
void	setPriority(int priority)	Sets the priority of produced messages.
void	setProperties(Properties properties, boolean firstTime)	Configures an AcquisitionTopic instance.
protected Properties	startHandler(Properties prop)	Start the handler.
protected Properties	stopHandler(Properties prop)	Stop the handler.
String	toString()	Returns a string representation of this destination.

Methods inherited from class org.objectweb.joram.mom.dest.Topic

clusterJoin, clusterJoinAck, createTopicForward, doClientMessages, doDeleteNot, doRightRequest, doUnknownAgent, finalize, forwardMessages, forwardMessages, getClusterElements, getNbMsgsReceiveSinceCreation, getNumberOfSubscribers, getStats, getSubscriberIds, getType, handleAdminRequestNot, processMessages, sendToCluster, subscribeRequest, topicForwardNot, unsubscribeRequest, wakeUpNot

Methods inherited from class org.objectweb.joram.mom.dest.Destination

agentInitialize, clientMessages, decode, delete, deleteNot, encode, forward, getCreationDate, getCreationTimeInMillis, getDestinationId, getDMQAgentId, getDMQId, getEncodedSize, getJMXStatistics, getNbMsgsDeliverSinceCreation, getNbMsgsSentToDMQSinceCreation, getPeriod, getRight, getRights, getRights, handleDeniedMessage, interceptorsAvailable, isAdministrator, isFreeReading, isFreeWriting, isLocal, isReader, isValidJMXAttribute, isWriter, postProcess, processAdminCommand, processInterceptors, processPause, processSetRight, processStartHandler, processStopHandler, replyToTopic, requestGroupNot, setAdminId, setFreeReading, setFreeWriting, setPeriod, setRight, unknownAgent

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

agentSave, delete, delete, deploy, deploy, doAdminSyncNotification, getAgentId, getCommitTime, getEncodableClassId, getId, getLogTopic, getName, getReactNb, getReactTime, hasName, incWorkInProgress, isAgentProfiling, isDeployed, isFixed, isUpdated, load, needToBeCommited, resetCommitTime, resetReactTime, resetTimer, save, sendTo, sendTo, sendTo, setAgentProfiling, setName, setNoSave, setSave

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.dyade.aaa.agent.AgentMBean

getAgentId, getCommitTime, getReactNb, getReactTime, isAgentProfiling, isFixed, resetCommitTime, resetReactTime, resetTimer, setAgentProfiling

Methods inherited from interface org.objectweb.joram.mom.dest.ClusterDestinationMBean

getClusterElements

Methods inherited from interface org.objectweb.joram.mom.dest.DestinationMBean

delete, getCreationDate, getCreationTimeInMillis, getDestinationId, getDMQId, getName, getNbMsgsDeliverSinceCreation, getNbMsgsReceiveSinceCreation, getNbMsgsSentToDMQSinceCreation, getPeriod, getRight, getRights, getType, isFreeReading, isFreeWriting, setFreeReading, setFreeWriting, setPeriod

Methods inherited from interface org.objectweb.joram.mom.dest.TopicMBean

getNumberOfSubscribers, getSubscriberIds

Field Detail

serialVersionUID

private static final long serialVersionUID

define serialVersionUID for interoperability

See Also:

Constant Field Values

logger

private static final Logger logger

DEBUG

private static final boolean DEBUG

acquisitionModule

private transient AcquisitionModule acquisitionModule

The acquisition module.

properties

private Properties properties

Stores the last set of properties defined.

lastMessageId

private String lastMessageId

Stores the id of the last message received to avoid duplicates.

msgCount

private long msgCount

The number of produced messages.

diff_max

private long diff_max

The threshold of messages send by the handler in the engine

diff_min

private long diff_min

ACQ_TOPIC_MAX_MSG

private final String ACQ_TOPIC_MAX_MSG

See Also:

Constant Field Values

ACQ_TOPIC_MIN_MSG

private final String ACQ_TOPIC_MIN_MSG

See Also:

Constant Field Values

pause

private boolean pause

acquisitionClassName

private String acquisitionClassName

The acquisition class name.

acquisitionNotNb

private transient long acquisitionNotNb

Constructor Detail

AcquisitionTopic

public AcquisitionTopic()

Method Detail

dumpProperties

public String dumpProperties()

Specified by:

dumpProperties in interface AcquisitionTopicMBean

getDiffMax

public final long getDiffMax()

Returns the maximum number of acquired messages waiting to be handled by the destination. When the number of messages waiting to be handled is greater the acquisition handler is temporarily stopped.

A value lesser or equal to 0 disables the mechanism.

Returns:

the maximum number of acquired messages waiting to be handled by the destination.

getDiffMin

public final long getDiffMin()

Returns the minimum threshold of acquired messages waiting to be handled by the destination for restarting the acquisition handler.

Returns:

the minimum threshold of acquired messages waiting to be handled by the destination.

getAcquisitionClassName

public String getAcquisitionClassName()

Description copied from interface: AcquisitionMBean

Returns the acquisition handler class name.

Specified by:

getAcquisitionClassName in interface AcquisitionMBean

Returns:

the acquisition handler class name.

setProperties

public void setProperties(Properties properties,
                          boolean firstTime)
                   throws Exception

Configures an AcquisitionTopic instance.

Overrides:

setProperties in class Destination

Parameters:

properties - The initial set of properties.

Throws:

Exception

initialize

public void initialize(boolean firstTime)

Description copied from class: Topic

Initializes the destination.

Overrides:

initialize in class Topic

Parameters:

firstTime - true when first called by the factory

getAcquiredMsgCount

public final long getAcquiredMsgCount()

Returns the number of messages acquired by the acquisition handler. Be careful this counter is reseted at each time the server starts.

Returns:

the number of messages acquired by the acquisition handler.

react

public void react(AgentId from,
                  Notification not)
           throws Exception

Description copied from class: Topic

Distributes the received notifications to the appropriate reactions.

Overrides:

react in class Topic

Parameters:

from - agent sending notification

not - notification to react to

Throws:

Exception - unspecialized exception

agentFinalize

public void agentFinalize(boolean lastTime)

Description copied from class: Destination

Finalizes the agent before it is garbaged.

Overrides:

agentFinalize in class Destination

Parameters:

lastTime - true if the destination is deleted

preProcess

public ClientMessages preProcess(AgentId from,
                                 ClientMessages cm)

Incoming JMS messages are processed by the acquisition module and a null ClientMessages is always returned to the base implementation.

Overrides:

preProcess in class Destination

Parameters:

from - The sender of the message

cm - The incoming messages.

Returns:

The incoming messages after processing.

See Also:

AcquisitionModule.processMessages(ClientMessages), Destination.preProcess(AgentId, ClientMessages)

startHandler

protected Properties startHandler(Properties prop)
                           throws Exception

Start the handler.

Parameters:

prop - properties for start if needed

Returns:

properties for the reply.

Throws:

Exception

stopHandler

protected Properties stopHandler(Properties prop)
                          throws Exception

Stop the handler.

Parameters:

prop - properties for stop if needed

Returns:

properties for the reply.

Throws:

Exception

acquisitionNot

private void acquisitionNot(AgentId from,
                            AcquisitionNot not)

This method process messages from the acquisition module. The method addClientMessages of base implementation is used to handle incoming messages.

Parameters:

not -

toString

public String toString()

Description copied from class: Topic

Returns a string representation of this destination.

Specified by:

toString in interface AgentMBean

Specified by:

toString in interface DestinationMBean

Overrides:

toString in class Topic

Returns:

A string representation of this agent.

getExpiration

public long getExpiration()

Description copied from interface: AcquisitionMBean

Returns the expiration value for produced messages.

Specified by:

getExpiration in interface AcquisitionMBean

Returns:

the expiration value for produced messages.

getPriority

public int getPriority()

Description copied from interface: AcquisitionMBean

Returns the priority of produced messages.

Specified by:

getPriority in interface AcquisitionMBean

Returns:

the priority of produced messages.

isMessagePersistent

public boolean isMessagePersistent()

Description copied from interface: AcquisitionMBean

Returns true if the messages produced are persistent.

Specified by:

isMessagePersistent in interface AcquisitionMBean

Returns:

true if the messages produced are persistent.

setExpiration

public void setExpiration(long expiration)

Description copied from interface: AcquisitionMBean

Sets the expiration value for produced messages.

Specified by:

setExpiration in interface AcquisitionMBean

Parameters:

expiration - the expiration to set.

setMessagePersistent

public void setMessagePersistent(boolean isPersistent)

Description copied from interface: AcquisitionMBean

Sets the DeliveryMode value for the produced messages. If the parameter is true the messages produced are persistent.

Specified by:

setMessagePersistent in interface AcquisitionMBean

Parameters:

isPersistent - if true the messages produced are persistent.

setPriority

public void setPriority(int priority)

Description copied from interface: AcquisitionMBean

Sets the priority of produced messages.

Specified by:

setPriority in interface AcquisitionMBean

Parameters:

priority - the priority to set.

close

private void close()

getAcquisitionPeriod

public long getAcquisitionPeriod()

Description copied from interface: AcquisitionMBean

Returns the acquisition period.

Specified by:

getAcquisitionPeriod in interface AcquisitionMBean

Returns:

the acquisition period.