Package com.sun.enterprise.ee.cms.impl.common

Class MessageSignalImpl

java.lang.Object

com.sun.enterprise.ee.cms.impl.common.MessageSignalImpl

All Implemented Interfaces:

com.sun.enterprise.ee.cms.core.MessageSignal, com.sun.enterprise.ee.cms.core.Signal

public class MessageSignalImpl
extends Object
implements com.sun.enterprise.ee.cms.core.MessageSignal

Implements MessageSignal and provides methods to access message sent by a remote member.

Version:

$Revision$

Author:

Shreedhar Ganapathy Date: Jan 20, 2004

Constructor Summary

Constructors

Constructor	Description
MessageSignalImpl(byte[] message, String targetComponent, String sender, String groupName, long startTime)

Method Summary

Modifier and Type	Method	Description
void	acquire()	Signal is acquired prior to processing of the signal to protect group resources being acquired from being affected by a race condition
String	getGroupName()	returns the group to which the member involved in the Signal belonged to
Map<Serializable,Serializable>	getMemberDetails()
String	getMemberToken()
byte[]	getMessage()	Returns the message(payload) as a byte array.
long	getStartTime()
String	getTargetComponent()	Returns the target component in this member to which this message is addressed.
void	release()	Signal is released after processing of the signal to bring the group resources to a state of availability

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageSignalImpl

public MessageSignalImpl(byte[] message,
                         String targetComponent,
                         String sender,
                         String groupName,
                         long startTime)

Method Detail

getTargetComponent

public String getTargetComponent()

Returns the target component in this member to which this message is addressed.

Specified by:

getTargetComponent in interface com.sun.enterprise.ee.cms.core.MessageSignal

Returns:

String targetComponent

getMessage

public byte[] getMessage()

Returns the message(payload) as a byte array.

Specified by:

getMessage in interface com.sun.enterprise.ee.cms.core.MessageSignal

Returns:

byte[]

acquire

public void acquire()
             throws com.sun.enterprise.ee.cms.core.SignalAcquireException

Signal is acquired prior to processing of the signal to protect group resources being acquired from being affected by a race condition

Specified by:

acquire in interface com.sun.enterprise.ee.cms.core.Signal

Throws:

com.sun.enterprise.ee.cms.core.SignalAcquireException - Exception when unable to aquire the signal

release

public void release()
             throws com.sun.enterprise.ee.cms.core.SignalReleaseException

Signal is released after processing of the signal to bring the group resources to a state of availability

Specified by:

release in interface com.sun.enterprise.ee.cms.core.Signal

Throws:

com.sun.enterprise.ee.cms.core.SignalReleaseException - Exception when unable to release the signal

getMemberToken

public String getMemberToken()

Specified by:

getMemberToken in interface com.sun.enterprise.ee.cms.core.Signal

getMemberDetails

public Map<Serializable,Serializable> getMemberDetails()

Specified by:

getMemberDetails in interface com.sun.enterprise.ee.cms.core.Signal

getGroupName

public String getGroupName()

returns the group to which the member involved in the Signal belonged to

Specified by:

getGroupName in interface com.sun.enterprise.ee.cms.core.Signal

Returns:

String

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface com.sun.enterprise.ee.cms.core.Signal