Uses of Class
org.snmp4j.smi.OctetString

Packages that use OctetString
org.snmp4j Provides classes and interfaces for creating, sending, and receiving SNMP messages. 
org.snmp4j.event Provides classes and interfaces for SNMP4J event processing. 
org.snmp4j.mp Provides classes and interfaces for the SNMP message processing. 
org.snmp4j.security Provides classes and interfaces for authentication and privacy of SNMP(v3) messages. 
org.snmp4j.smi Provides classes for the representation of SMIv1/v2 data types (which also includes some basic ASN.1 primitive data types). 
org.snmp4j.tools.console   
org.snmp4j.util Contains table retrieval utilities and multi-threading support classes as well as miscellaneous utility classes. 
 

Uses of OctetString in org.snmp4j
 

Methods in org.snmp4j that return OctetString
 OctetString CommunityTarget.getCommunity()
          Gets the community octet string.
 OctetString ScopedPDU.getContextEngineID()
          Gets the context engine ID of this scoped PDU.
 OctetString ScopedPDU.getContextName()
          Gets the context name of this scoped PDU.
 OctetString SecureTarget.getSecurityName()
          Gets the security name associated with this target.
 

Methods in org.snmp4j with parameters of type OctetString
 void CommunityTarget.setCommunity(OctetString community)
          Sets the community octet sting.
 void ScopedPDU.setContextEngineID(OctetString contextEngineID)
          Sets the context engine ID field of the scoped PDU.
 void ScopedPDU.setContextName(OctetString contextName)
          Sets the context name field of this scoped PDU.
 void SecureTarget.setSecurityName(OctetString securityName)
          Sets the security name to be used with this target.
 

Constructors in org.snmp4j with parameters of type OctetString
CommunityTarget(Address address, OctetString community)
          Creates a fully specified communtity target.
SecureTarget(Address address, OctetString securityName)
          Creates a SNMPv3 secure target with an address and security name.
UserTarget(Address address, OctetString securityName, byte[] authoritativeEngineID)
          Creates a SNMPv3 USM target with security level noAuthNoPriv, one second time-out without retries.
UserTarget(Address address, OctetString securityName, byte[] authoritativeEngineID, int securityLevel)
          Creates a SNMPv3 USM target with the supplied security level, one second time-out without retries.
 

Uses of OctetString in org.snmp4j.event
 

Methods in org.snmp4j.event that return OctetString
 OctetString SnmpEngineEvent.getEngineID()
          Returns the engine ID associated with this event.
 

Constructors in org.snmp4j.event with parameters of type OctetString
SnmpEngineEvent(java.lang.Object source, int type, OctetString engineID, Address engineAddress)
           
 

Uses of OctetString in org.snmp4j.mp
 

Methods in org.snmp4j.mp that return OctetString
 OctetString MPv3.getEngineID(Address address)
          Gets the engine ID associated with the supplied address from the local storage and fires the corresponding SnmpEngineEvent.
 OctetString MPv3.removeEngineID(Address address)
          Removes an engine ID association from the local storage and fires the corresponding SnmpEngineEvent.
 

Methods in org.snmp4j.mp with parameters of type OctetString
 boolean MPv3.addEngineID(Address address, OctetString engineID)
          Adds an engine ID (other than the local engine ID) to the internal storage.
static byte[] MPv3.createLocalEngineID(OctetString id)
          Creates a local engine ID based on the ID string supplied
 int MessageProcessingModel.prepareDataElements(MessageDispatcher messageDispatcher, Address transportAddress, BERInputStream wholeMsg, Integer32 messageProcessingModel, Integer32 securityModel, OctetString securityName, Integer32 securityLevel, MutablePDU pdu, PduHandle sendPduHandle, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, MutableStateReference stateReference)
          Prepare data elements from an incoming SNMP message as described in RFC3412 ยง7.2.
 int MPv2c.prepareDataElements(MessageDispatcher messageDispatcher, Address transportAddress, BERInputStream wholeMsg, Integer32 messageProcessingModel, Integer32 securityModel, OctetString securityName, Integer32 securityLevel, MutablePDU pdu, PduHandle sendPduHandle, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, MutableStateReference stateReference)
           
 int MPv1.prepareDataElements(MessageDispatcher messageDispatcher, Address transportAddress, BERInputStream wholeMsg, Integer32 messageProcessingModel, Integer32 securityModel, OctetString securityName, Integer32 securityLevel, MutablePDU pdu, PduHandle sendPduHandle, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, MutableStateReference stateReference)
           
 int MPv3.prepareDataElements(MessageDispatcher messageDispatcher, Address transportAddress, BERInputStream wholeMsg, Integer32 messageProcessingModel, Integer32 securityModel, OctetString securityName, Integer32 securityLevel, MutablePDU pdu, PduHandle sendPduHandle, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, MutableStateReference mutableStateReference)
           
 int MPv3.sendReport(MessageDispatcher messageDispatcher, ScopedPDU pdu, int securityLevel, int securityModel, OctetString securityName, int maxSizeResponseScopedPDU, StateReference stateReference, VariableBinding payload)
          Sends a report message.
 

Uses of OctetString in org.snmp4j.security
 

Methods in org.snmp4j.security that return OctetString
 OctetString UsmSecurityParameters.getAuthenticationParameters()
           
 OctetString UsmUser.getAuthenticationPassphrase()
          Gets the authentication passphrase.
 OctetString UsmUserEntry.getEngineID()
           
 OctetString UsmTimeEntry.getEngineID()
           
 OctetString USM.getLocalEngineID()
          Returns the local engine ID.
 OctetString UsmUser.getLocalizationEngineID()
          Returns the localization engine ID for which this USM user has been already localized.
 OctetString UsmSecurityParameters.getPrivacyParameters()
           
 OctetString UsmUser.getPrivacyPassphrase()
          Gets the privacy passphrase.
 OctetString UsmUser.getSecurityName()
          Gets the user's security name.
 OctetString UsmSecurityParameters.getUserName()
           
 OctetString UsmUserEntry.getUserName()
           
 

Methods in org.snmp4j.security with parameters of type OctetString
 UsmUserEntry USM.addLocalizedUser(byte[] engineID, OctetString userName, OID authProtocol, byte[] authKey, OID privProtocol, byte[] privKey)
          Adds a localized user to the USM.
 void USM.addUser(OctetString userName, OctetString engineID, UsmUser user)
          Adds an USM user to the internal user name table and associates it with an authoritative engine ID.
 void USM.addUser(OctetString userName, UsmUser user)
          Adds an USM user to the internal user name table.
 int UsmTimeTable.checkEngineID(OctetString engineID, boolean discoveryAllowed)
           
 byte[] PrivacyProtocol.extendShortKey(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol)
          Extend a localized key that is too short.
 byte[] PrivAES.extendShortKey(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol)
           
 byte[] PrivDES.extendShortKey(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol)
           
 byte[] Priv3DES.extendShortKey(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol)
           
 UsmTimeEntry UsmTimeTable.getEntry(OctetString engineID)
           
 UsmTimeEntry UsmTimeTable.getTime(OctetString engineID)
           
 UsmUserEntry UsmUserTable.getUser(OctetString securityName)
           
 UsmUserEntry USM.getUser(OctetString engineID, OctetString securityName)
           
 UsmUserEntry UsmUserTable.getUser(OctetString engineID, OctetString securityName)
           
 java.util.List UsmUserTable.getUserEntries(OctetString userName)
          Gets all user entries with the supplied user name.
 boolean USM.hasUser(OctetString engineID, OctetString securityName)
          Checks if the specified user is known by this USM.
 byte[] AuthenticationProtocol.passwordToKey(OctetString passwordString, byte[] engineID)
          Generates the localized key for the given password and engine id.
 byte[] AuthGeneric.passwordToKey(OctetString passwordString, byte[] engineID)
           
 byte[] SecurityProtocols.passwordToKey(OID authProtocolID, OctetString passwordString, byte[] engineID)
          Generates the localized key for the given password and engine id for the authentication protocol specified by the supplied OID.
 byte[] SecurityProtocols.passwordToKey(OID privProtocolID, OID authProtocolID, OctetString passwordString, byte[] engineID)
          Generates the localized key for the given password and engine id for the privacy protocol specified by the supplied OID.
 int USM.processIncomingMsg(int snmpVersion, int maxMessageSize, SecurityParameters securityParameters, SecurityModel securityModel, int securityLevel, BERInputStream wholeMsg, OctetString securityEngineID, OctetString securityName, BEROutputStream scopedPDU, Integer32 maxSizeResponseScopedPDU, SecurityStateReference securityStateReference, StatusInformation statusInfo)
           
 int SecurityModel.processIncomingMsg(int messageProcessingModel, int maxMessageSize, SecurityParameters securityParameters, SecurityModel securityModel, int securityLevel, BERInputStream wholeMsg, OctetString securityEngineID, OctetString securityName, BEROutputStream scopedPDU, Integer32 maxSizeResponseScopedPDU, SecurityStateReference securityStateReference, StatusInformation statusInfo)
          Processes an incoming message and returns its plaintext payload.
 void USM.removeEngineTime(OctetString engineID)
          Removes the specified engine ID from the internal time cache and thus forces an engine time rediscovery the next time the SNMP engine with the supplied ID is contacted.
 void UsmTimeTable.removeEntry(OctetString engineID)
          Removes the specified engine ID from the time cache.
 UsmUser USM.removeUser(OctetString engineID, OctetString userName)
          Removes an USM user from the internal user name table.
 UsmUserEntry UsmUserTable.removeUser(OctetString engineID, OctetString securityName)
           
 void UsmSecurityParameters.setAuthenticationParameters(OctetString authenticationParameters)
           
 void UsmUserEntry.setEngineID(OctetString engineID)
           
 void USM.setLocalEngine(OctetString localEngineID, int engineBoots, int engineTime)
          Sets the local engine ID, number of boots, and time after boot.
 void UsmSecurityParameters.setPrivacyParameters(OctetString privacyParameters)
           
 void UsmSecurityParameters.setUserName(OctetString userName)
           
 void UsmUserEntry.setUserName(OctetString userName)
           
 

Constructors in org.snmp4j.security with parameters of type OctetString
USM(SecurityProtocols securityProtocols, OctetString localEngineID, int engineBoots)
          Creates a USM with the support for the supplied security protocols.
UsmSecurityParameters(OctetString authoritativeEngineID, Integer32 authoritativeEngineBoots, Integer32 authoritativeEngineTime, OctetString userName, AuthenticationProtocol authenticationProtocol, PrivacyProtocol privacyProtocol)
           
UsmTimeEntry(OctetString engineID, int engineBoots, int engineTime)
          Creates a time entry with engine ID, engine boots and time.
UsmTimeTable(OctetString localEngineID, int engineBoots)
           
UsmUser(OctetString securityName, OID authenticationProtocol, OctetString authenticationPassphrase, OID privacyProtocol, OctetString privacyPassphrase)
          Creates a USM user.
UsmUser(OctetString securityName, OID authenticationProtocol, OctetString authenticationPassphrase, OID privacyProtocol, OctetString privacyPassphrase, OctetString localizationEngineID)
          Creates a localized USM user.
UsmUserEntry(byte[] engineID, OctetString securityName, OID authProtocol, byte[] authKey, OID privProtocol, byte[] privKey)
          Creates a localized user entry.
UsmUserEntry(OctetString userName, OctetString engineID, UsmUser user)
          Creates a user with user name and associated UsmUser.
UsmUserEntry(OctetString userName, UsmUser user)
          Creates a user with user name and associated UsmUser.
UsmUserTable.UsmUserKey(OctetString engineID, OctetString securityName)
           
 

Uses of OctetString in org.snmp4j.smi
 

Subclasses of OctetString in org.snmp4j.smi
 class BitString
          The BitString class represents the obsolete SMI type BIT STRING which has been defined in RFC 1442 (an SNMPv2 draft) but which has been obsoleteted by RFC 1902 and RFC 2578.
 class Opaque
          The Opaque class represents the SMI type Opaque which is used to transparently exchange BER encoded values.
 

Methods in org.snmp4j.smi that return OctetString
static OctetString OctetString.fromByteArray(byte[] value)
          Creates an OctetString from an byte array.
static OctetString OctetString.fromHexString(java.lang.String hexString)
           
static OctetString OctetString.fromHexString(java.lang.String hexString, char delimiter)
           
static OctetString OctetString.fromString(java.lang.String string, char delimiter, int radix)
           
static OctetString OctetString.fromString(java.lang.String string, int radix)
          Creates an OctetString from a string represantation in the specified radix.
 OctetString OctetString.mask(OctetString mask)
          Returns a copy of this OctetString where each bit not set in the supplied mask zeros the corresponding bit in the returned OctetString.
 OctetString OctetString.substring(int beginIndex, int endIndex)
          Returns a new string that is a substring of this string.
 

Methods in org.snmp4j.smi with parameters of type OctetString
 void OctetString.append(OctetString octetString)
          Appends an octet string.
 OID OID.mask(OctetString mask)
          Returns a copy of this OID where sub-identifiers have been set to zero for all n-th sub-identifier where the n-th bit of mask is zero.
 OctetString OctetString.mask(OctetString mask)
          Returns a copy of this OctetString where each bit not set in the supplied mask zeros the corresponding bit in the returned OctetString.
 void TransportIpAddress.setTransportAddress(OctetString transportAddress)
          Sets this transport address from an OcetString containing the address value in format as specified by the TRANSPORT-ADDRESS-MIB.
 void VariantVariable.setValue(OctetString value)
           
 void Opaque.setValue(OctetString value)
           
static java.util.Collection OctetString.split(OctetString octetString, OctetString delimOctets)
          Splits an OctetString using a set of delimiter characters similar to how a StringTokenizer would do it.
 boolean OctetString.startsWith(OctetString prefix)
          Tests if this octet string starts with the specified prefix.
 

Constructors in org.snmp4j.smi with parameters of type OctetString
OctetString(OctetString other)
          Creates an octet string from another OctetString by cloning its value.
 

Uses of OctetString in org.snmp4j.tools.console
 

Methods in org.snmp4j.tools.console that return OctetString
 OctetString SnmpRequest.getAuthoritativeEngineID()
           
 OctetString SnmpRequest.getAuthPassphrase()
           
 OctetString SnmpRequest.getCommunity()
           
 OctetString SnmpRequest.getContextEngineID()
           
 OctetString SnmpRequest.getContextName()
           
 OctetString SnmpRequest.getPrivPassphrase()
           
 OctetString SnmpRequest.getSecurityName()
           
 

Methods in org.snmp4j.tools.console with parameters of type OctetString
 void SnmpRequest.setAuthoritativeEngineID(OctetString authoritativeEngineID)
           
 void SnmpRequest.setAuthPassphrase(OctetString authPassphrase)
           
 void SnmpRequest.setCommunity(OctetString community)
           
 void SnmpRequest.setContextEngineID(OctetString contextEngineID)
           
 void SnmpRequest.setContextName(OctetString contextName)
           
 void SnmpRequest.setPrivPassphrase(OctetString privPassphrase)
           
 void SnmpRequest.setSecurityName(OctetString securityName)
           
 

Uses of OctetString in org.snmp4j.util
 

Methods in org.snmp4j.util that return OctetString
static OctetString SnmpConfigurator.createOctetString(java.lang.String s, java.lang.String defaultString)
          Create an OctetString from a String value.
 


Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.