Module org.snmp4j.agent

Package org.snmp4j.agent

Class AgentConfigManager.AgentState

java.lang.Object

org.snmp4j.agent.AgentConfigManager.AgentState

All Implemented Interfaces:

AgentState

Enclosing class:

AgentConfigManager

public class AgentConfigManager.AgentState
extends Object
implements AgentState

The AgentConfigManager.AgentState provides information about the state of this SNMP agent. States are represented by integer values.

Since:

3.0

Version:

3.0.2

Author:

Frank Fock

Nested Class Summary

Nested classes/interfaces inherited from interface org.snmp4j.agent.AgentState

AgentState.ErrorDescriptor

Field Summary

Fields inherited from interface org.snmp4j.agent.AgentState

STATE_CONFIGURED, STATE_CREATED, STATE_INITIALIZED, STATE_RESTORED, STATE_RUNNING, STATE_SAVED, STATE_SHUTDOWN, STATE_SUSPENDED

Constructor Summary

Constructors

Constructor	Description
AgentState()

Method Summary

Modifier and Type	Method	Description
void	addError(AgentState.ErrorDescriptor error)	Add an error description to the internal error list.
void	advanceState(int newState)	Advance the state to the given state.
List<AgentState.ErrorDescriptor>	getErrors()	Get the error descriptors associated with this agent state.
int	getState()	Gets the current state of the agent.
void	setState(int newState)	Sets the new state independent from the current state.

Methods inherited from class java.lang.Object

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

Constructor Details

AgentState

public AgentState()

Method Details

getState

public int getState()

Description copied from interface: AgentState

Gets the current state of the agent.

Specified by:

getState in interface AgentState

Returns:

an integer representing the current state. See AgentState.STATE_CREATED.

setState

public void setState(int newState)

Sets the new state independent from the current state.

Specified by:

setState in interface AgentState

Parameters:

newState - the new state.

advanceState

public void advanceState(int newState)

Advance the state to the given state. If the current state is greater than the provided state, the current state will not be changed.

Specified by:

advanceState in interface AgentState

Parameters:

newState - the new minimum state.

addError

public void addError(AgentState.ErrorDescriptor error)

Add an error description to the internal error list.

Specified by:

addError in interface AgentState

Parameters:

error - an ErrorDescriptor instance to add.

getErrors

public List<AgentState.ErrorDescriptor> getErrors()

Get the error descriptors associated with this agent state.

Specified by:

getErrors in interface AgentState

Returns:

the error descriptor list.