org.xmlBlaster.engine.admin.extern.snmp
Class SessionEntryImpl

java.lang.Object
  jax.AgentXEntry
      org.xmlBlaster.engine.admin.extern.snmp.SessionEntry
          org.xmlBlaster.engine.admin.extern.snmp.SessionEntryImpl

public class SessionEntryImpl
extends SessionEntry

This class extends the Java AgentX (JAX) implementation of the table row sessionEntry defined in XMLBLASTER-MIB. SessionEntryImpl is the interface side of a bridge pattern. Contains a reference to the implementation side of the bridge pattern (= SessionEntryImplPeer). Implements its methods by forwarding its calls to SessionEntryImplPeer.

Version:

@VERSION@

Author:

Udo Thalmann

Field Summary

SessionEntryImplPeer

sessionEntryImplPeer

Fields inherited from class org.xmlBlaster.engine.admin.extern.snmp.SessionEntry

cbQueueMaxEntries, cbQueueNumEntries, cbQueueThreshold, clearCbQueue, clientIndex, closeSession, nodeIndex, sessionIndex, sessionName, undo_cbQueueMaxEntries, undo_cbQueueThreshold, undo_clearCbQueue, undo_closeSession

Fields inherited from class jax.AgentXEntry

instance

Constructor Summary

SessionEntryImpl(long nodeIndex, long clientIndex, long sessionIndex, SessionEntryImplPeer sessionEntryImplPeer)
SessionEntryImpl initializes mib variables.

Method Summary

long	get_cbQueueMaxEntries() Forwards the call to sessionEntryImplPeer.get_cbQueueMaxEntries().
long	get_cbQueueNumEntries() Forwards the call to sessionEntryImplPeer.get_cbQueueNumEntries().
long	get_cbQueueThreshold() Forwards the call to sessionEntryImplPeer.get_cbQueueThreshold().
int	get_clearCbQueue() Indicates the callback queue status.
int	get_closeSession() Forwards the call to sessionEntryImplPeer.get_closeSession().
byte[]	get_sessionName() Forwards the call to sessionEntryImplPeer.get_sessionName().
int	set_cbQueueMaxEntries(jax.AgentXSetPhase phase, long value) Implements the snmp set command for the mib object cbQueueMaxEntries.
int	set_cbQueueThreshold(jax.AgentXSetPhase phase, long value) Implements the snmp set command for the mib object cbQueueThreshold.
int	set_clearCbQueue(jax.AgentXSetPhase phase, int value) Implements the snmp set command for the mib object clearCbQueue.
int	set_closeSession(jax.AgentXSetPhase phase, int value) Implements the snmp set command for the mib object closeSession.

Methods inherited from class org.xmlBlaster.engine.admin.extern.snmp.SessionEntry

get_clientIndex, get_nodeIndex, get_sessionIndex

Methods inherited from class jax.AgentXEntry

getInstance

Methods inherited from class java.lang.Object

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

Field Detail

sessionEntryImplPeer

public SessionEntryImplPeer sessionEntryImplPeer

Constructor Detail

SessionEntryImpl

public SessionEntryImpl(long nodeIndex,
                        long clientIndex,
                        long sessionIndex,
                        SessionEntryImplPeer sessionEntryImplPeer)

SessionEntryImpl initializes mib variables. Builds a reference to SessionEntryImplPeer, which implements SessionEntryImpl methods.

Parameters:

NodeIndex - identifies a node in node table.

ClientIndex - identifies a client in client table together with nodeIndex.

SessionIndex - identfies a session in session table together with nodeIndex and clientIndex.

SessionEntryImplPeer - implements SessionEntryImpl methods.

Method Detail

get_sessionName

public byte[] get_sessionName()

Forwards the call to sessionEntryImplPeer.get_sessionName().

Overrides:

get_sessionName in class SessionEntry

Returns:

SessionName name of a client session.

get_cbQueueNumEntries

public long get_cbQueueNumEntries()

Forwards the call to sessionEntryImplPeer.get_cbQueueNumEntries().

Overrides:

get_cbQueueNumEntries in class SessionEntry

Returns:

CbQueueNumEntries actual number of messages in the callback queue.

get_cbQueueMaxEntries

public long get_cbQueueMaxEntries()

Forwards the call to sessionEntryImplPeer.get_cbQueueMaxEntries().

Overrides:

get_cbQueueMaxEntries in class SessionEntry

Returns:

CbQueueMaxEntries maximum number of messages in the callback queue.

set_cbQueueMaxEntries

public int set_cbQueueMaxEntries(jax.AgentXSetPhase phase,
                                 long value)

Implements the snmp set command for the mib object cbQueueMaxEntries.

Overrides:

set_cbQueueMaxEntries in class SessionEntry

Parameters:

AgentXSetPhase -

Value - is the new value of cbQueueMaxEntries.

Returns:

AgentXResponsePDU.PROCESSING_ERROR

get_cbQueueThreshold

public long get_cbQueueThreshold()

Forwards the call to sessionEntryImplPeer.get_cbQueueThreshold().

Overrides:

get_cbQueueThreshold in class SessionEntry

Returns:

CbQueueThreshold threshold (%) number of messages in the callback queue.

set_cbQueueThreshold

public int set_cbQueueThreshold(jax.AgentXSetPhase phase,
                                long value)

Implements the snmp set command for the mib object cbQueueThreshold.

Overrides:

set_cbQueueThreshold in class SessionEntry

Parameters:

AgentXSetPhase - phase:

Value - is the new value for cbQueueThreshold.

Returns:

AgentXResponsePDU.PROCESSING_ERROR

get_clearCbQueue

public int get_clearCbQueue()

Indicates the callback queue status. = 0: the callback queue is not empty. > 0: the callback queue is empty.

Overrides:

get_clearCbQueue in class SessionEntry

Returns:

ClearCbQueue indicates whether the callback is empty (> 0) or not (= 0).

set_clearCbQueue

public int set_clearCbQueue(jax.AgentXSetPhase phase,
                            int value)

Implements the snmp set command for the mib object clearCbQueue.

Overrides:

set_clearCbQueue in class SessionEntry

Parameters:

AgentXSetPhase -

Value - indicates whether the callback queue has to emptied (> 0) or not (= 0).

Returns:

AgentXResponsePDU.PROCESSING_ERROR

get_closeSession

public int get_closeSession()

Forwards the call to sessionEntryImplPeer.get_closeSession(). Indicates the session status. = 0: the session is open. > 0: the session is closed.

Overrides:

get_closeSession in class SessionEntry

Returns:

CloseSession indicates whether the session is open (= 0) or closed (> 1).

set_closeSession

public int set_closeSession(jax.AgentXSetPhase phase,
                            int value)

Implements the snmp set command for the mib object closeSession.

Overrides:

set_closeSession in class SessionEntry

Parameters:

AgentXSetPhase -

Value - indicates whether the session is open (= 0) or closed (> 1).

Returns:

AgentXResponsePDU.PROCESSING_ERROR