Interface AgentState

  • All Known Implementing Classes:
    AgentConfigManager.AgentState

    public interface AgentState
    The AgentState interface provides information about the state of a SNMP agent. States are represented by integer values. This allows implementing classes to extend states supported by an agent.
    Since:
    3.0
    Version:
    3.0.2
    Author:
    Frank Fock
    • Field Detail

      • STATE_INITIALIZED

        static final int STATE_INITIALIZED
        Agent has been initialized.
        See Also:
        Constant Field Values
      • STATE_CONFIGURED

        static final int STATE_CONFIGURED
        Agent has been configured.
        See Also:
        Constant Field Values
      • STATE_RESTORED

        static final int STATE_RESTORED
        Agent's state has been restored.
        See Also:
        Constant Field Values
      • STATE_SUSPENDED

        static final int STATE_SUSPENDED
        Agent is suspended, i.e. does not accept/answer communication requests.
        See Also:
        Constant Field Values
      • STATE_SAVED

        static final int STATE_SAVED
        Agent's state has been saved.
        See Also:
        Constant Field Values
      • STATE_SHUTDOWN

        static final int STATE_SHUTDOWN
        Agent has been shutdown.
        See Also:
        Constant Field Values
    • Method Detail

      • getState

        int getState()
        Gets the current state of the agent.
        Returns:
        an integer representing the current state. See STATE_CREATED.
      • setState

        void setState​(int newState)
        Sets the new state independent from the current state.
        Parameters:
        newState - the new state.
      • advanceState

        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.
        Parameters:
        newState - the new minimum state.
      • addError

        void addError​(AgentState.ErrorDescriptor error)
        Add an error description to the internal error list.
        Parameters:
        error - an ErrorDescriptor instance to add.
      • getErrors

        List<AgentState.ErrorDescriptor> getErrors()
        Get the error descriptors associated with this agent state.
        Returns:
        the errors descriptor list.