All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.jaw.snmp.manager.Request

java.lang.Object
   |
   +----com.sun.jaw.snmp.manager.Request

public abstract class Request
extends Object

This class is an abtract representation of a request.

stAborted: Status of a request: request aborted.
stInProgress: Status of a request: in progress.
stInternalError: Status of a request: internal error occured.
stNeverUsed: Status of a request: request never used.
stReceivedReply: Status of a request: reply received.
stResultsAvailable: Status of a request: result available for the request.
stTimeout: Status of a request: timeout.
stWaitingForReply: Status of a request: waiting for reply.
stWaitingToSend: Status of a request: waiting to be sent.

action(): This method decides whether the request is to be retried.
allowMultiplex(): Checks to see if this request can be multiplexed with other requests.
cancelRequest(): Cancels the active request and removes itself from polling list.
getAbsMaxTimeToWait(): Returns absolute time in milliseconds (based on epoch time) before which a response is expected from a agent.
getAbsNextPollTime(): Returns absolute time in milliseconds (based on epoch time) when the next polling activity will begin.
getMaxRetry(): Returns the maximum number of retries before declaring that the peer is not responding.
getPollTimestamp(): Returns the absolute time (based on epoch time) when the poll started.
getRequestId(): Get the request id (invoke identifier) of the current request.
getRequestStatus(): get current status of the request.
getRetryCount(): Get the number of retries performed for the current request.
inProgress(): Indicates whether or not the request is in progress.
invokeOnResponse(Object): For Java DMK internal use only.
isAborted(): Indicates whether or not the request was aborted.
isResultAvailable()
setPreviousPollTimestamp(long): For Java DMK internal use only.
setTimeout(int): For Java DMK internal use only.
stopRequest(): This method cancels an active request and removes it from the polling list.
timeRemainingForAction(long): For Java DMK internal use only.
toString(): Get a string representation of the request.

stInProgress

 public static final int stInProgress

Status of a request: in progress.

stWaitingToSend

 public static final int stWaitingToSend

Status of a request: waiting to be sent.

stWaitingForReply

 public static final int stWaitingForReply

Status of a request: waiting for reply.

stReceivedReply

 public static final int stReceivedReply

Status of a request: reply received.

stAborted

 public static final int stAborted

Status of a request: request aborted.

stTimeout

 public static final int stTimeout

Status of a request: timeout.

stInternalError

 public static final int stInternalError

Status of a request: internal error occured.

stResultsAvailable

 public static final int stResultsAvailable

Status of a request: result available for the request.

stNeverUsed

 public static final int stNeverUsed

Status of a request: request never used.

getMaxRetry

 public abstract int getMaxRetry()

Returns the maximum number of retries before declaring that the peer is not responding.

allowMultiplex

 public abstract boolean allowMultiplex()

Checks to see if this request can be multiplexed with other requests.

cancelRequest

 public abstract void cancelRequest()

Cancels the active request and removes itself from polling list.

getRetryCount

 public final synchronized int getRetryCount()

Get the number of retries performed for the current request.

getRequestId

 public final synchronized int getRequestId()

Get the request id (invoke identifier) of the current request.

getRequestStatus

 public final synchronized int getRequestStatus()

get current status of the request.

setTimeout

 public final synchronized void setTimeout(int value)

For Java DMK internal use only.

isAborted

 public final synchronized boolean isAborted()

Indicates whether or not the request was aborted.

inProgress

 public final synchronized boolean inProgress()

Indicates whether or not the request is in progress.

isResultAvailable

 public final synchronized boolean isResultAvailable()

stopRequest

 public synchronized void stopRequest()

This method cancels an active request and removes it from the polling list.

action

 public void action()

This method decides whether the request is to be retried. This is used if the peer did not respond to a previous request. If the request exceeds the retry limit, a timeout is signaled.

See Also:: SnmpHandlerIf

getAbsNextPollTime

 public final synchronized long getAbsNextPollTime()

Returns absolute time in milliseconds (based on epoch time) when the next polling activity will begin.

Returns:: time when polling will begin.

getAbsMaxTimeToWait

 public final synchronized long getAbsMaxTimeToWait()

Returns absolute time in milliseconds (based on epoch time) before which a response is expected from a agent.

Returns:: time within which a response is expected.

setPreviousPollTimestamp

 public final synchronized void setPreviousPollTimestamp(long prev)

For Java DMK internal use only.

getPollTimestamp

 public final synchronized long getPollTimestamp()

Returns the absolute time (based on epoch time) when the poll started.

Returns:: time the polling started.

timeRemainingForAction

 public long timeRemainingForAction(long currtime)

For Java DMK internal use only.

toString

 public synchronized String toString()

Get a string representation of the request.

Overrides:: toString in class Object

invokeOnResponse

 public abstract void invokeOnResponse(Object responseObj)

For Java DMK internal use only.

All Packages  Class Hierarchy  This Package  Previous  Next  Index