com.adventnet.agent.tl1
Class TL1AgentRequestInfo

java.lang.Object
  |
  +--com.adventnet.agent.tl1.TL1AgentRequestInfo

public class TL1AgentRequestInfo

extends java.lang.Object

This class contains the TL1 Agent Request Information. Getters are provided for the Verb, modifiers, AIDs, Message Payload block and the TL1Session. This is passed as a parameter in the doAction of the MBean and the user can get the above mentioned details from it.

Constructor Summary

(package private)	TL1AgentRequestInfo()
	TL1AgentRequestInfo(java.lang.String commandCode, java.lang.String targetId, java.util.Vector accessId, java.lang.String cTag, TL1GeneralBlock generalBlock, java.util.Vector[] messagePayloadBlock, TL1Session session) Constructor for creating TL1AgentRequestInfo.

Method Summary

java.util.Vector	getAccessId() Getter for the Access Identifier.
boolean	getAckFlag() This method is used to get the status of the Acknowledgement.
java.lang.String	getCommandCode() Getter for the whole command code.
java.lang.String	getCorrelationTag() Getter for CorrelationTag.
TL1GeneralBlock	getGeneralBlock() Getter for the General Block of the Input Message.
java.util.Vector[]	getMessagePayload() Getter for the Message Payload Block.
java.lang.String	getModifier() Getter for the modifier.
TL1Session	getSession() Getter for the TL1Session which recieved this message.
java.lang.String	getTargetId() Getter for the Target Identifier.
(package private) long	getTime() This method is used to give the time
java.lang.String	getUserName() This method used to get the User name for the current session.
java.lang.String	getVerb() Getter for Verb.
void	setAckFlag(boolean flag) This method is used to set the status of Acknowledgement.
(package private) void	setTime(long time) This method is used to set the max time within which the request get executed.
(package private) void	setUserName(java.lang.String name) This method is used to set the user name.

Methods inherited from class java.lang.Object

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

Constructor Detail

TL1AgentRequestInfo

TL1AgentRequestInfo()

TL1AgentRequestInfo

public TL1AgentRequestInfo(java.lang.String commandCode,
                           java.lang.String targetId,
                           java.util.Vector accessId,
                           java.lang.String cTag,
                           TL1GeneralBlock generalBlock,
                           java.util.Vector[] messagePayloadBlock,
                           TL1Session session)

Constructor for creating TL1AgentRequestInfo.

Parameters:

commandCode - - The Command code

targetId - - The target identifier

accessId - - The access identifier

cTag - - The correlation tag

generalBlock - - THe TL1GeneralBlock

messagePayloadBlock - - The Vector[].

session - - TL1Session.

Method Detail

getVerb

public java.lang.String getVerb()

Getter for Verb.

Returns:

A string which represents the Verb.

getModifier

public java.lang.String getModifier()

Getter for the modifier.

Returns:

A String containing all the modifiers seperated by hyphens.

getCommandCode

public java.lang.String getCommandCode()

Getter for the whole command code.

Returns:

A String containing the command code.

getTargetId

public java.lang.String getTargetId()

Getter for the Target Identifier.

Returns:

A String representing the target id.

getAccessId

public java.util.Vector getAccessId()

Getter for the Access Identifier.

Returns:

A Vector of TL1Param Objects

getCorrelationTag

public java.lang.String getCorrelationTag()

Getter for CorrelationTag.

Returns:

The correlation tag as a String.

getGeneralBlock

public TL1GeneralBlock getGeneralBlock()

Getter for the General Block of the Input Message.

Returns:

The General Block.

See Also:

TL1GeneralBlock

getMessagePayload

public java.util.Vector[] getMessagePayload()

Getter for the Message Payload Block.

Returns:

An array of Vectors. Each element in the array represents a block.

getSession

public TL1Session getSession()

Getter for the TL1Session which recieved this message.

Returns:

TL1Session.

setUserName

void setUserName(java.lang.String name)

This method is used to set the user name. It will be set only if security is enabled. This is given package access .

getUserName

public java.lang.String getUserName()

This method used to get the User name for the current session. It will be set only if security is enabled.

Returns:

the user name

setTime

void setTime(long time)

This method is used to set the max time within which the request get executed. (Used for processing auto acknowledgement).

getTime

long getTime()

This method is used to give the time

setAckFlag

public void setAckFlag(boolean flag)

This method is used to set the status of Acknowledgement. It will be true if the response for this reuest info has been sent.

Parameters:

flag - - The status says the response has already sent or not.

getAckFlag

public boolean getAckFlag()

This method is used to get the status of the Acknowledgement. It will be true if the response for this reuest info has been sent.