Module org.snmp4j.agent
Package org.snmp4j.agent.mo.snmp

Class SnmpProxyMIB

    • Field Detail

      • oidSnmpProxyEntry

        public static final org.snmp4j.smi.OID oidSnmpProxyEntry

      • colSnmpProxyContextEngineID

        public static final int colSnmpProxyContextEngineID
        See Also:
        Constant Field Values

      • colSnmpProxyContextName

        public static final int colSnmpProxyContextName
        See Also:
        Constant Field Values

      • colSnmpProxyTargetParamsIn

        public static final int colSnmpProxyTargetParamsIn
        See Also:
        Constant Field Values

      • colSnmpProxySingleTargetOut

        public static final int colSnmpProxySingleTargetOut
        See Also:
        Constant Field Values

      • colSnmpProxyMultipleTargetOut

        public static final int colSnmpProxyMultipleTargetOut
        See Also:
        Constant Field Values

      • colSnmpProxyStorageType

        public static final int colSnmpProxyStorageType
        See Also:
        Constant Field Values

      • idxSnmpProxyContextEngineID

        public static final int idxSnmpProxyContextEngineID
        See Also:
        Constant Field Values

      • idxSnmpProxyContextName

        public static final int idxSnmpProxyContextName
        See Also:
        Constant Field Values

      • idxSnmpProxyTargetParamsIn

        public static final int idxSnmpProxyTargetParamsIn
        See Also:
        Constant Field Values

      • idxSnmpProxySingleTargetOut

        public static final int idxSnmpProxySingleTargetOut
        See Also:
        Constant Field Values

      • idxSnmpProxyMultipleTargetOut

        public static final int idxSnmpProxyMultipleTargetOut
        See Also:
        Constant Field Values

      • idxSnmpProxyStorageType

        public static final int idxSnmpProxyStorageType
        See Also:
        Constant Field Values

    • Constructor Detail

      • SnmpProxyMIB

        public SnmpProxyMIB()

    • Method Detail

      • registerMOs

        public void registerMOs​(MOServer server,
                        org.snmp4j.smi.OctetString context)
                 throws DuplicateRegistrationException
        Description copied from interface: MOGroup
        Registers the managed objects of this group with the server for the supplied context.
        Specified by:
        registerMOs in interface MOGroup
        Parameters:
        server - the MOServer where to register the managed objects.
        context - the context to use (may be null if no specific context is selected).
        Throws:
        DuplicateRegistrationException - if a managed object's scope (i.e. lower bound) is already registered at the server.

      • unregisterMOs

        public void unregisterMOs​(MOServer server,
                          org.snmp4j.smi.OctetString context)
        Description copied from interface: MOGroup
        Unregisters the managed objects of this group from the supplied server and from the supplied context.
        Specified by:
        unregisterMOs in interface MOGroup
        Parameters:
        server - the MOServer where to unregister the managed objects.
        context - the context to use (may be null if no specific context is selected).

      • addProxyEntry

        public boolean addProxyEntry​(org.snmp4j.smi.OctetString name,
                             int type,
                             org.snmp4j.smi.OctetString contextEngineId,
                             org.snmp4j.smi.OctetString contextName,
                             org.snmp4j.smi.OctetString targetParamsIn,
                             org.snmp4j.smi.OctetString singleTargetOut,
                             org.snmp4j.smi.OctetString multipleTargetOut,
                             int storageType)
        Adds a proxy entry to the snmpProxyTable (descriptions taken from SNMP-PROXY-MIB definition).
        Parameters:
        name - The locally arbitrary, but unique identifier associated with this snmpProxyEntry.
        type - The type of message that may be forwarded using the translation parameters defined by this entry. See SnmpProxyMIB.SnmpProxyTypeEnum for possible values.
        contextEngineId - The contextEngineID contained in messages that may be forwarded using the translation parameters defined by this entry.
        contextName - The contextName contained in messages that may be forwarded using the translation parameters defined by this entry. This object is optional, and if not supported, the contextName contained in a message is ignored when selecting an entry in the snmpProxyTable.
        targetParamsIn - This object selects an entry in the snmpTargetParamsTable. The selected entry is used to determine which row of the snmpProxyTable to use for forwarding received messages.
        singleTargetOut - This object selects a management target defined in the snmpTargetAddrTable (in the SNMP-TARGET-MIB). The selected target is defined by an entry in the snmpTargetAddrTable whose index value (snmpTargetAddrName) is equal to this object. This object is only used when selection of a single target is required (i.e. when forwarding an incoming read or write request).
        multipleTargetOut - This object selects a set of management targets defined in the snmpTargetAddrTable (in the SNMP-TARGET-MIB). This object is only used when selection of multiple targets is required (i.e. when forwarding an incoming notification).
        storageType - The storage type of this conceptual row. Conceptual rows having the value 'permanent' need not allow write-access to any columnar objects in the row. See StorageType for possible values.
        Returns:
        true if the row could be added, false otherwise.

      • removeProxyEntry

        public SnmpProxyMIB.SnmpProxyRow removeProxyEntry​(org.snmp4j.smi.OctetString name)
        Removes the proxy entry with the specified name.
        Parameters:
        name - the name of the proxy entry to remove from the proxy configuration.
        Returns:
        the removed row or null if no such row exists.

      • getProxyRows

        public List<SnmpProxyMIB.SnmpProxyRow> getProxyRows​(int proxyType,
                                                    org.snmp4j.smi.OctetString contextEngineID,
                                                    org.snmp4j.smi.OctetString context)