Package org.objectweb.joram.mom.dest

Interface DestinationMBean

All Superinterfaces:

AgentMBean

All Known Subinterfaces:

AcquisitionQueueMBean, AcquisitionTopicMBean, AdminTopicMBean, ClusterQueueMBean, DistributionQueueMBean, DistributionTopicMBean, QueueMBean, TopicMBean

All Known Implementing Classes:

AcquisitionQueue, AcquisitionTopic, AdminTopic, AliasInQueue, AliasQueue, ClusterQueue, Destination, DistributionQueue, DistributionTopic, ElasticTopic, FtpQueue, Queue, SchedulerQueue, Topic

public interface DestinationMBean
extends AgentMBean

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes the destination.
String	getCreationDate()	Returns this destination creation time through a String of the form: dow mon dd hh:mm:ss zzz yyyy.
long	getCreationTimeInMillis()	Returns this destination creation time as a long.
String	getDestinationId()	Returns the unique identifier of the destination.
String	getDMQId()	Return the unique identifier of DMQ set for this destnation if any.
String	getName()	Returns the name of the destination.
long	getNbMsgsDeliverSinceCreation()	Returns the number of messages delivered since creation time of this destination.
long	getNbMsgsReceiveSinceCreation()	Returns the number of messages received since creation time of this destination.
long	getNbMsgsSentToDMQSinceCreation()	Returns the number of erroneous messages forwarded to the DMQ since creation time of this destination.
long	getPeriod()	Returns the period value of this destination, -1 if not set.
String	getRight(String userid)	Returns a string representation of rights set on this destination for a particular user.
String[]	getRights()	Returns a string representation of all rights set on this destination.
byte	getType()	Returns the type of this destination: Queue or Topic.
boolean	isFreeReading()	Tests if this destination is free for reading.
boolean	isFreeWriting()	Tests if this destination is free for writing.
void	setFreeReading(boolean on)	Sets the FreeReading attribute for this destination.
void	setFreeWriting(boolean on)	Sets the FreeWriting attribute for this destination.
void	setPeriod(long period)	Sets or unsets the period for this destination.
String	toString()	Returns a string representation of this destination.

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

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

Method Detail

toString

String toString()

Returns a string representation of this destination.

Specified by:

toString in interface AgentMBean

Overrides:

toString in class Object

Returns:

A string representation of this agent.

getName

String getName()

Returns the name of the destination.

Specified by:

getName in interface AgentMBean

Returns:

the name of the destination.

getDestinationId

String getDestinationId()

Returns the unique identifier of the destination.

Returns:

the unique identifier of the destination.

getType

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, DestinationConstants.TEMPORARY

isFreeReading

boolean isFreeReading()

Tests if this destination is free for reading.

Returns:

true if anyone can receive messages from this destination; false otherwise.

setFreeReading

void setFreeReading(boolean on)

Sets the FreeReading attribute for this destination.

Parameters:

on - if true anyone can receive message from this destination.

isFreeWriting

boolean isFreeWriting()

Tests if this destination is free for writing.

Returns:

true if anyone can send messages to this destination; false otherwise.

setFreeWriting

void setFreeWriting(boolean on)

Sets the FreeWriting attribute for this destination.

Parameters:

on - if true anyone can send message to this destination.

getRights

String[] getRights()

Returns a string representation of all rights set on this destination.

Returns:

the rights set on this destination.

getRight

String getRight(String userid)

Returns a string representation of rights set on this destination for a particular user. The user is pointed out by its unique identifier.

Parameters:

userid - The user's unique identifier.

Returns:

the rights set on this destination.

getDMQId

String getDMQId()

Return the unique identifier of DMQ set for this destnation if any.

Returns:

the unique identifier of DMQ set for this destnation if any; null otherwise.

getCreationTimeInMillis

long getCreationTimeInMillis()

Returns this destination creation time as a long.

Returns:

the destination creation time as UTC milliseconds from the epoch.

getCreationDate

String getCreationDate()

Returns this destination creation time through a String of the form: dow mon dd hh:mm:ss zzz yyyy.

Returns:

the destination creation time.

getNbMsgsReceiveSinceCreation

long getNbMsgsReceiveSinceCreation()

Returns the number of messages received since creation time of this destination.

Returns:

the number of messages received since creation time.

getNbMsgsDeliverSinceCreation

long getNbMsgsDeliverSinceCreation()

Returns the number of messages delivered since creation time of this destination. It includes messages all delivered messages to a consumer, already acknowledged or not.

Returns:

the number of messages delivered since creation time.

getNbMsgsSentToDMQSinceCreation

long getNbMsgsSentToDMQSinceCreation()

Returns the number of erroneous messages forwarded to the DMQ since creation time of this destination.

Returns:

the number of erroneous messages forwarded to the DMQ.

getPeriod

long getPeriod()

Returns the period value of this destination, -1 if not set.

Returns:

the period value of this destination; -1 if not set.

setPeriod

void setPeriod(long period)

Sets or unsets the period for this destination.

Parameters:

period - The period value to be set or -1 for unsetting previous value.

delete

void delete()

Deletes the destination.

Specified by:

delete in interface AgentMBean