Module org.snmp4j

Package org.snmp4j

Class CommunityTarget<A extends Address>

java.lang.Object

org.snmp4j.AbstractTarget<A>

org.snmp4j.CommunityTarget<A>

All Implemented Interfaces:

Serializable, Cloneable, Target<A>

public class CommunityTarget<A extends Address>
extends AbstractTarget<A>

A CommunityTarget represents SNMP target properties for community based message processing models (SNMPv1 and SNMPv2c).

Version:

3.1

Author:

Frank Fock

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.snmp4j.AbstractTarget

securityLevel, securityModel, securityName

Constructor Summary

Constructors

Constructor	Description
CommunityTarget()	Default constructor.
CommunityTarget(A address, OctetString community)	Creates a fully specified community target.

Method Summary

Modifier and Type	Method	Description
Target<A>	duplicate()	Creates a new copy of this target with the same address type.
OctetString	getCommunity()	Gets the community octet string (which is the same as the security name).
int	getSecurityModel()	Gets the security model associated with this target.
void	setCommunity(OctetString community)	Sets the community octet sting.
void	setSecurityLevel(int securityLevel)	Sets the security level for this target.
void	setSecurityModel(int securityModel)	Sets the security model for this target.
String	toString()

Methods inherited from class org.snmp4j.AbstractTarget

clone, equals, getAddress, getMaxSizeRequestPDU, getPreferredTransports, getRetries, getSecurityLevel, getSecurityName, getTimeout, getVersion, hashCode, setAddress, setMaxSizeRequestPDU, setPreferredTransports, setRetries, setSecurityName, setTimeout, setVersion, toStringAbstractTarget

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CommunityTarget

public CommunityTarget()

Default constructor.

CommunityTarget

public CommunityTarget(A address,
 OctetString community)

Creates a fully specified community target.

Parameters:

address - the transport Address of the target.

community - the community to be used for the target.

Method Details

getCommunity

public OctetString getCommunity()

Gets the community octet string (which is the same as the security name). Thus, you can (and should) use AbstractTarget.getSecurityName() directly.

Returns:

an OctetString instance, should be never null when using this target to send messages over community based SNMP (v1 and v2c).

setCommunity

public void setCommunity(OctetString community)

Sets the community octet sting. This is a convenience method to set the security name for community based SNMP (v1 and v2c). It basically checks that the community is not null and then calls AbstractTarget.setSecurityName(org.snmp4j.smi.OctetString) with the supplied parameter.

Parameters:

community - an OctetString instance which must not be null.

duplicate

public Target<A> duplicate()

Description copied from interface: Target

Creates a new copy of this target with the same address type.

Returns:

a copy of this target with the same address type.

getSecurityModel

public int getSecurityModel()

Description copied from interface: Target

Gets the security model associated with this target.

Specified by:

getSecurityModel in interface Target<A extends Address>

Overrides:

getSecurityModel in class AbstractTarget<A extends Address>

Returns:

an int value as defined in the SecurityModel interface or any third party subclass thereof.

setSecurityLevel

public void setSecurityLevel(int securityLevel)

Description copied from class: AbstractTarget

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 interface Target<A extends Address>

Overrides:

setSecurityLevel in class AbstractTarget<A extends Address>

Parameters:

securityLevel - one of

• SecurityLevel.NOAUTH_NOPRIV
• SecurityLevel.AUTH_NOPRIV
• SecurityLevel.AUTH_PRIV

setSecurityModel

public void setSecurityModel(int securityModel)

Description copied from class: AbstractTarget

Sets the security model for this target.

Specified by:

setSecurityModel in interface Target<A extends Address>

Overrides:

setSecurityModel in class AbstractTarget<A extends Address>

Parameters:

securityModel - an int value as defined in the SecurityModel interface or any third party subclass thereof.

toString

public String toString()

Overrides:

toString in class AbstractTarget<A extends Address>