|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.joram.mom.dest.DestinationImpl
public abstract class DestinationImpl
The DestinationImpl
class implements the common behavior of
MOM destinations.
Field Summary | |
---|---|
static java.lang.String[] |
_rights
|
private AgentId |
adminId
Identifier of the destination's administrator. |
protected Destination |
agent
Reference to the agent hosting the destination. |
protected java.util.Hashtable |
clients
Table of the destination readers and writers. |
long |
creationDate
date of creation. |
private boolean |
deletable
true if the destination successfully processed a deletion
request. |
protected AgentId |
dmqId
Identifier of the dead message queue this destination must send its dead messages to, if any. |
protected boolean |
freeReading
true if the READ access is granted to everybody. |
protected boolean |
freeWriting
true if the WRITE access is granted to everybody. |
static org.objectweb.util.monolog.api.Logger |
logger
|
protected long |
nbMsgsDeliverSinceCreation
|
protected long |
nbMsgsReceiveSinceCreation
|
protected long |
nbMsgsSentToDMQSinceCreation
|
private long |
period
period to run task at regular interval: cleaning, load-balancing, etc. |
static int |
READ
READ access value. |
static int |
READWRITE
READ and WRITE access value. |
(package private) java.lang.StringBuffer |
strbuf
Transient StringBuffer used to build message, this buffer
is created during agent initialization, then reused during the destination
life. |
static java.lang.String |
WAKEUP_PERIOD
|
static int |
WRITE
WRITE access value. |
Constructor Summary | |
---|---|
DestinationImpl(AgentId adminId,
java.util.Properties prop)
Constructs a DestinationImpl . |
Method Summary | |
---|---|
boolean |
canBeDeleted()
Returns true if the destination might be deleted. |
protected void |
clientMessages(AgentId from,
ClientMessages not)
Method implementing the reaction to a ClientMessages
notification holding messages sent by a client. |
void |
delete()
Deletes the destination. |
void |
deleteNot(AgentId from,
DeleteNot not)
Method implementing the reaction to a DeleteNot
notification requesting the deletion of the destination. |
protected abstract void |
doClientMessages(AgentId from,
ClientMessages not)
|
protected abstract void |
doDeleteNot(DeleteNot not)
|
protected abstract void |
doRightRequest(AgentId user,
int right)
This method is needed for right revocation. |
protected abstract void |
doUnknownAgent(UnknownAgent not)
|
void |
forward(AgentId to,
Notification not)
|
java.lang.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. |
java.lang.String |
getDestinationId()
Returns the unique identifier of the destination. |
AgentId |
getDMQAgentId()
|
java.lang.String |
getDMQId()
Return the unique identifier of DMQ set for this destination if any. |
AgentId |
getId()
Identifier of the agent hosting the destination. |
protected java.util.Hashtable |
getJMXStatistics()
Returns values of all valid JMX attributes about the destination. |
java.lang.String |
getName()
Returns the name of the destination. |
long |
getNbMsgsDeliverSinceCreation()
Returns the number of messages delivered since creation time of this destination. |
abstract 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. |
java.lang.String |
getRight(java.lang.String userid)
Returns a string representation of rights set on this destination for a particular user. |
java.lang.String[] |
getRights()
Returns a string representation of the rights set on this destination. |
void |
getRights(AgentId from,
GetRightsRequestNot not)
Method implementing the reaction to a GetRightsRequest
notification requesting the rights about this destination. |
void |
handleAdminRequestNot(AgentId from,
FwdAdminRequestNot not)
|
protected void |
handleDeniedMessage(java.lang.String msgId,
AgentId replyTo)
Method used to do specific actions when a message is denied because of a lack of rights. |
abstract void |
initialize(boolean firstTime)
Initializes the destination. |
protected boolean |
isAdministrator(AgentId client)
Checks the administering permission of a given client agent. |
boolean |
isFreeReading()
Tests if this destination is free for reading. |
boolean |
isFreeWriting()
Tests if this destination is free for writing. |
protected boolean |
isLocal(AgentId id)
|
protected boolean |
isReader(AgentId client)
Checks the reading permission of a given client agent. |
protected boolean |
isValidJMXAttribute(java.lang.String attrName)
This method allows to exclude some JMX attribute of getJMXStatistics method. |
protected boolean |
isWriter(AgentId client)
Checks the writing permission of a given client agent. |
void |
postProcess(ClientMessages msgs)
This method is needed to add processing after the standard handling. |
ClientMessages |
preProcess(AgentId from,
ClientMessages msgs)
This method is needed to add processing before the standard handling. |
protected void |
processSetRight(AgentId user,
int right)
set user right. |
private void |
readObject(java.io.ObjectInputStream in)
|
protected void |
replyToTopic(AdminReply reply,
AgentId replyTo,
java.lang.String requestMsgId,
java.lang.String replyMsgId)
|
void |
requestGroupNot(AgentId from,
RequestGroupNot not)
|
void |
setAgent(Destination agent)
|
void |
setFreeReading(boolean on)
Sets the FreeReading attribute for this destination. |
void |
setFreeWriting(boolean on)
Sets the FreeWriting attribute for this destination. |
(package private) void |
setNoSave()
|
void |
setPeriod(long period)
Sets or unsets the period for this destination. |
void |
setRight(SetRight request,
AgentId replyTo,
java.lang.String requestMsgId,
java.lang.String replyMsgId)
Method implementing the reaction to a SetRightRequest
notification requesting rights to be set for a user. |
(package private) void |
setSave()
|
protected java.lang.Object |
specialAdminProcess(SpecialAdminRequest not)
|
void |
specialAdminRequest(AgentId from,
SpecialAdminRequest not)
Method implementing the reaction to a SpecialAdminRequest
notification requesting the special administration of the destination. |
void |
unknownAgent(AgentId from,
UnknownAgent not)
Method implementing the reaction to an UnknownAgent
notification. |
abstract void |
wakeUpNot(WakeUpNot not)
|
private void |
writeObject(java.io.ObjectOutputStream out)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.objectweb.joram.mom.dest.DestinationImplMBean |
---|
toString |
Field Detail |
---|
public static org.objectweb.util.monolog.api.Logger logger
public static final java.lang.String WAKEUP_PERIOD
private boolean deletable
true
if the destination successfully processed a deletion
request.
private long period
private AgentId adminId
protected transient Destination agent
protected boolean freeReading
true
if the READ access is granted to everybody.
protected boolean freeWriting
true
if the WRITE access is granted to everybody.
protected java.util.Hashtable clients
public static int READ
public static int WRITE
public static int READWRITE
protected AgentId dmqId
transient java.lang.StringBuffer strbuf
StringBuffer
used to build message, this buffer
is created during agent initialization, then reused during the destination
life.
public long creationDate
protected long nbMsgsReceiveSinceCreation
protected long nbMsgsDeliverSinceCreation
protected long nbMsgsSentToDMQSinceCreation
public static java.lang.String[] _rights
Constructor Detail |
---|
public DestinationImpl(AgentId adminId, java.util.Properties prop)
DestinationImpl
.
adminId
- Identifier of the administrator of the destination.prop
- The initial set of properties.Method Detail |
---|
public final AgentId getId()
public final java.lang.String getName()
DestinationImplMBean
getName
in interface DestinationImplMBean
void setNoSave()
void setSave()
public abstract void initialize(boolean firstTime)
firstTime
- true when first called by the factorypublic void setAgent(Destination agent)
protected boolean isLocal(AgentId id)
public final boolean canBeDeleted()
true
if the destination might be deleted.
public long getPeriod()
getPeriod
in interface DestinationImplMBean
public void setPeriod(long period)
setPeriod
in interface DestinationImplMBean
period
- The period value to be set or -1 for unsetting previous
value (ignore 0).public abstract void wakeUpNot(WakeUpNot not)
public void setRight(SetRight request, AgentId replyTo, java.lang.String requestMsgId, java.lang.String replyMsgId)
SetRightRequest
notification requesting rights to be set for a user.
not
- The notification describing the security modifications.protected abstract void doRightRequest(AgentId user, int right)
user
- The user about right modification.right
- The right modification.protected void processSetRight(AgentId user, int right) throws RequestException
RequestException
public void getRights(AgentId from, GetRightsRequestNot not) throws AccessException
GetRightsRequest
notification requesting the rights about this destination.
AccessException
- If the requester is not the administrator.public java.lang.String[] getRights()
getRights
in interface DestinationImplMBean
public java.lang.String getRight(java.lang.String userid)
getRight
in interface DestinationImplMBean
userid
- The user's unique identifier.
protected boolean isValidJMXAttribute(java.lang.String attrName)
attrName
- name of attribute to test.
protected final java.util.Hashtable getJMXStatistics()
protected void clientMessages(AgentId from, ClientMessages not) throws AccessException
ClientMessages
notification holding messages sent by a client.
If the sender is not a writer on the destination the messages are sent to the DMQ and an exception is thrown. Otherwise, the processing of the received messages is performed in subclasses.
AccessException
- If the sender is not a WRITER on the
destination.protected void handleDeniedMessage(java.lang.String msgId, AgentId replyTo)
public void unknownAgent(AgentId from, UnknownAgent not)
UnknownAgent
notification.
If the unknown agent is the DMQ, its identifier is set to null. If it is a client of the destination, it is removed. Specific processing is also done in subclasses.
public void deleteNot(AgentId from, DeleteNot not)
DeleteNot
notification requesting the deletion of the destination.
The processing is done in subclasses if the sender is an administrator.
public void specialAdminRequest(AgentId from, SpecialAdminRequest not)
SpecialAdminRequest
notification requesting the special administration of the destination.
public void requestGroupNot(AgentId from, RequestGroupNot not)
protected java.lang.Object specialAdminProcess(SpecialAdminRequest not) throws RequestException
RequestException
protected boolean isReader(AgentId client)
client
- AgentId of the client requesting a reading permission.protected boolean isWriter(AgentId client)
client
- AgentId of the client requesting a writing permission.protected boolean isAdministrator(AgentId client)
client
- AgentId of the client requesting an admin permission.protected abstract void doClientMessages(AgentId from, ClientMessages not)
protected abstract void doUnknownAgent(UnknownAgent not)
protected abstract void doDeleteNot(DeleteNot not)
public void delete()
DestinationImplMBean
delete
in interface DestinationImplMBean
public ClientMessages preProcess(AgentId from, ClientMessages msgs)
QueueImpl
and TopicImpl
.
The incoming messages can be modified or deleted during the processing.
from
- The sender of the messagemsgs
- The incoming messages.
public void postProcess(ClientMessages msgs)
QueueImpl
and TopicImpl
.
The incoming messages can be modified or deleted during the processing.
from
- The sender of the messagemsgs
- The incoming messages.private void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
java.io.IOException
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
java.io.IOException
java.lang.ClassNotFoundException
public final java.lang.String getDestinationId()
getDestinationId
in interface DestinationImplMBean
public boolean isFreeReading()
isFreeReading
in interface DestinationImplMBean
public void setFreeReading(boolean on)
FreeReading
attribute for this destination.
setFreeReading
in interface DestinationImplMBean
on
- if true anyone can receive message from this destination.public boolean isFreeWriting()
isFreeWriting
in interface DestinationImplMBean
public void setFreeWriting(boolean on)
FreeWriting
attribute for this destination.
setFreeWriting
in interface DestinationImplMBean
on
- if true anyone can send message to this destination.public java.lang.String getDMQId()
getDMQId
in interface DestinationImplMBean
public AgentId getDMQAgentId()
public long getCreationTimeInMillis()
getCreationTimeInMillis
in interface DestinationImplMBean
public java.lang.String getCreationDate()
String
of
the form: dow mon dd hh:mm:ss zzz yyyy
.
getCreationDate
in interface DestinationImplMBean
public abstract long getNbMsgsReceiveSinceCreation()
getNbMsgsReceiveSinceCreation
in interface DestinationImplMBean
public long getNbMsgsDeliverSinceCreation()
getNbMsgsDeliverSinceCreation
in interface DestinationImplMBean
public long getNbMsgsSentToDMQSinceCreation()
getNbMsgsSentToDMQSinceCreation
in interface DestinationImplMBean
protected void replyToTopic(AdminReply reply, AgentId replyTo, java.lang.String requestMsgId, java.lang.String replyMsgId)
public final void forward(AgentId to, Notification not)
public void handleAdminRequestNot(AgentId from, FwdAdminRequestNot not)
from
- not
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |