|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SnmpTrapSenderFacade
Title: SnmpTrapSenderFacade
Description: A simplified interface to an underlying SNMP API.
The intent of this class is both to limit the available interface, and allow
the underlying SNMP library to be changed, as desired.
Method Summary | |
---|---|
void |
addTrapMessageVariable(java.lang.String applicationTrapOIDValue,
java.lang.String value)
Adds a new Varbind to the SNMP PDU. |
void |
initialize(java.lang.String managementHostValue,
int managementHostTrapListenPortValue,
java.lang.String enterpriseOIDValue,
java.lang.String localIPAddressValue,
int localTrapSendPortValue,
int genericTrapTypeValue,
int specificTrapTypeValue,
java.lang.String communityStringValue,
long sysUpTimeValue)
This method is called to set the values of all of the class fields used as parameters to the underlying SNMP API. |
void |
sendTrap()
Sends the PDU defined by the variables of the fields of this class. |
Method Detail |
---|
void initialize(java.lang.String managementHostValue, int managementHostTrapListenPortValue, java.lang.String enterpriseOIDValue, java.lang.String localIPAddressValue, int localTrapSendPortValue, int genericTrapTypeValue, int specificTrapTypeValue, java.lang.String communityStringValue, long sysUpTimeValue)
managementHostValue
- - the numeric IP address of the host
to which traps should be sent, e.g. "10.255.255.1".
managementHostTrapListenPortValue
- - any valid TCP/IP port
number. This is the port that the host specified in the
"managementHostValue" variable will listen on for SNMP traps.
enterpriseOIDValue
- - formatted as an OID
E.g. "1.3.6.1.2.1.1.2.0" -- this OID would point to the standard
sysObjectID of the "systemName" node of the standard "system" MIB.
localIPAddressValue
- - an IP address, as a String, in
numeric, dotted decimal format. E.g. "10.255.255.2". This is the IP
address of the host that is using this appender to send SNMP traps.
This address will be encoded in the SNMP PDU, and used to provide
things like the "agent"'s IP address.
localTrapSendPortValue
- - the port that should be used on the
local host by the appender to send the trap.
genericTrapTypeValue
- - generic trap type for this SNMP PDU.
One of the following values (from the SNMP standard):specificTrapTypeValue
- - any value within the range defined
for an INTEGER in the ASN.1/BER notation; i.e. -128 to 127.
communityStringValue
- - E.g. "public".
sysUpTimeValue
- - this is meant to be the amount of time, in
seconds, elapsed since the last re-start or re-initialization of the
calling application. Of course, to set this, your application needs
to keep track of the value.void sendTrap()
void addTrapMessageVariable(java.lang.String applicationTrapOIDValue, java.lang.String value)
applicationTrapOIDValue
- - formatted as an OID
E.g. "1.3.6.1.2.1.1.2.0.0.0.0" -- this OID would point to the standard
sysObjectID of the "systemName" node of the standard "system" MIB.
value
- - the text to append to the Varbind that will be added to
the SNMP PDU.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |