Package org.snmp4j
Class AbstractTarget
java.lang.Object
org.snmp4j.AbstractTarget
- All Implemented Interfaces:
Serializable
,Cloneable
,Target
- Direct Known Subclasses:
CommunityTarget
,SecureTarget
A
AbstractTarget
class is an abstract representation of a remote
SNMP entity. It represents a target with an Address object, as well protocol
parameters such as retransmission and timeout policy. Implementers of the
Target
interface can subclass AbstractTarget
to
take advantage of the implementation of common Target
properties.- Since:
- 1.2
- Version:
- 2.0
- Author:
- Frank Fock
- See Also:
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
Default constructorprotected
AbstractTarget
(Address address) Creates a SNMPv3 target with no retries and a timeout of one second.protected
AbstractTarget
(Address address, OctetString securityName) -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Gets the address of this target.int
Gets the maximum size of request PDUs that this target is able to respond to.List<TransportMapping<? extends Address>>
Gets the prioritised list of transport mappings to be used for this target.int
Gets the number of retries.int
Gets the security level associated with this target.int
Gets the security model associated with this target.final OctetString
Gets the security name associated with this target.long
Gets the timeout for a target.int
Gets the SNMP version (NMP messagen processing model) of the target.int
hashCode()
void
setAddress
(Address address) Sets the address of the target.void
setMaxSizeRequestPDU
(int maxSizeRequestPDU) Sets the maximum size of request PDUs that this target is able to receive.void
setPreferredTransports
(List<TransportMapping<? extends Address>> preferredTransports) Sets the prioritised list of transport mappings to be used for this target.void
setRetries
(int retries) Sets the number of retries to be performed before a request is timed out.void
setSecurityLevel
(int securityLevel) Sets the security level for this target.void
setSecurityModel
(int securityModel) Sets the security model for this target.final void
setSecurityName
(OctetString securityName) Sets the security name to be used with this target.void
setTimeout
(long timeout) Sets the timeout for a target.void
setVersion
(int version) Sets the SNMP version (thus the SNMP message processing model) of the target.toString()
protected String
-
Field Details
-
securityLevel
protected int securityLevel -
securityModel
protected int securityModel -
securityName
-
-
Constructor Details
-
AbstractTarget
protected AbstractTarget()Default constructor -
AbstractTarget
Creates a SNMPv3 target with no retries and a timeout of one second.- Parameters:
address
- anAddress
instance.
-
AbstractTarget
-
-
Method Details
-
getAddress
Gets the address of this target.- Specified by:
getAddress
in interfaceTarget
- Returns:
- an Address instance.
-
setAddress
Sets the address of the target.- Specified by:
setAddress
in interfaceTarget
- Parameters:
address
- an Address instance.
-
setVersion
public void setVersion(int version) Sets the SNMP version (thus the SNMP message processing model) of the target.- Specified by:
setVersion
in interfaceTarget
- Parameters:
version
- the message processing model ID.- See Also:
-
getVersion
public int getVersion()Gets the SNMP version (NMP messagen processing model) of the target.- Specified by:
getVersion
in interfaceTarget
- Returns:
- the message processing model ID.
- See Also:
-
setRetries
public void setRetries(int retries) Sets the number of retries to be performed before a request is timed out.- Specified by:
setRetries
in interfaceTarget
- Parameters:
retries
- the number of retries. Note: If the number of retries is set to 0, then the request will be sent out exactly once.
-
getRetries
public int getRetries()Gets the number of retries.- Specified by:
getRetries
in interfaceTarget
- Returns:
- an integer >= 0.
-
setTimeout
public void setTimeout(long timeout) Sets the timeout for a target.- Specified by:
setTimeout
in interfaceTarget
- Parameters:
timeout
- timeout in milliseconds before a confirmed request is resent or timed out.
-
getTimeout
public long getTimeout()Gets the timeout for a target.- Specified by:
getTimeout
in interfaceTarget
- Returns:
- the timeout in milliseconds.
-
getMaxSizeRequestPDU
public int getMaxSizeRequestPDU()Gets the maximum size of request PDUs that this target is able to respond to. The default is 65535.- Specified by:
getMaxSizeRequestPDU
in interfaceTarget
- Returns:
- the maximum PDU size of request PDUs for this target. Which is always greater than 484.
-
setMaxSizeRequestPDU
public void setMaxSizeRequestPDU(int maxSizeRequestPDU) Sets the maximum size of request PDUs that this target is able to receive.- Specified by:
setMaxSizeRequestPDU
in interfaceTarget
- Parameters:
maxSizeRequestPDU
- the maximum PDU (SNMP message) size this session will be able to process.
-
getPreferredTransports
Description copied from interface:Target
Gets the prioritised list of transport mappings to be used for this target. The first mapping in the list that matches the target address is chosen for sending new requests.- Specified by:
getPreferredTransports
in interfaceTarget
- Returns:
- an ordered list of
TransportMapping
instances.
-
setPreferredTransports
Sets the prioritised list of transport mappings to be used for this target. The first mapping in the list that matches the target address will be chosen for sending new requests. If the value is set tonull
(default), the appropriateTransportMapping
will be chosen by the suppliedaddress
of the target. If an entity supports more than oneTransportMapping
for anAddress
class, the the results are not defined. This situation can be controlled by setting this preferredTransports list.- Parameters:
preferredTransports
- a list of transport mappings that are preferred for this target class.- Since:
- 2.0
-
toStringAbstractTarget
-
toString
-
clone
-
getSecurityModel
public int getSecurityModel()Description copied from interface:Target
Gets the security model associated with this target.- Specified by:
getSecurityModel
in interfaceTarget
- Returns:
- an
int
value as defined in theSecurityModel
interface or any third party subclass thereof.
-
getSecurityName
Description copied from interface:Target
Gets the security name associated with this target. The security name is used by the security model to lookup further parameters like authentication and privacy protocol settings from the security model dependent internal storage.- Specified by:
getSecurityName
in interfaceTarget
- Returns:
- an
OctetString
instance (nevernull
).
-
getSecurityLevel
public int getSecurityLevel()Description copied from interface:Target
Gets the security level associated with this target.- Specified by:
getSecurityLevel
in interfaceTarget
- Returns:
- one of
-
setSecurityLevel
public void setSecurityLevel(int securityLevel) Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target.- Specified by:
setSecurityLevel
in interfaceTarget
- Parameters:
securityLevel
- one of
-
setSecurityModel
public void setSecurityModel(int securityModel) Sets the security model for this target.- Specified by:
setSecurityModel
in interfaceTarget
- Parameters:
securityModel
- anint
value as defined in theSecurityModel
interface or any third party subclass thereof.
-
setSecurityName
Sets the security name to be used with this target.- Specified by:
setSecurityName
in interfaceTarget
- Parameters:
securityName
- anOctetString
instance (must not benull
).- See Also:
-
equals
-
hashCode
public int hashCode()
-