org.snmp4j.agent.mo.snmp
Interface TDomainAddressFactory

All Known Implementing Classes:

TDomainAddressFactoryImpl

public interface TDomainAddressFactory

The TDomainAddressFactory defines the interface for address factories that can create an address from a transport domain ID and a TDomainAddress textual convention conforming OctetString value and vice versa.

Version:

1.0

Author:

Frank Fock

Method Summary

org.snmp4j.smi.Address	createAddress(org.snmp4j.smi.OID transportDomain, org.snmp4j.smi.OctetString address) Creates an Address from a transport domain ID and a TDomainAddress textual convention conforming OctetString value.
org.snmp4j.smi.OctetString	getAddress(org.snmp4j.smi.Address address) Gets the TDomainAddress textual convention conforming OctetString value for the specified address.
org.snmp4j.smi.OID[]	getTransportDomain(org.snmp4j.smi.Address address) Gets the transport domain(s) ID for the specified address.
boolean	isValidAddress(org.snmp4j.smi.OID transportDomain, org.snmp4j.smi.OctetString address) Checks whether a transport domain ID and a OctetString value represent a valid and consistent address.

Method Detail

createAddress

org.snmp4j.smi.Address createAddress(org.snmp4j.smi.OID transportDomain,
                                     org.snmp4j.smi.OctetString address)

Creates an Address from a transport domain ID and a TDomainAddress textual convention conforming OctetString value.

Parameters:

transportDomain - a transport domain ID as defined by TransportDomains.

address - a TDomainAddress TC conforming OctetString.

Returns:

an Address if address could be mapped or null if not.

isValidAddress

boolean isValidAddress(org.snmp4j.smi.OID transportDomain,
                       org.snmp4j.smi.OctetString address)

Checks whether a transport domain ID and a OctetString value represent a valid and consistent address.

Parameters:

transportDomain - a transport domain ID as defined by TransportDomains.

address - an OctetString.

Returns:

true if transportDomain and address are consitent and valid.

getTransportDomain

org.snmp4j.smi.OID[] getTransportDomain(org.snmp4j.smi.Address address)

Gets the transport domain(s) ID for the specified address.

Parameters:

address - an address.

Returns:

the corresponding transport domain ID as defined by TransportDomains or null if the address cannot be mapped.

getAddress

org.snmp4j.smi.OctetString getAddress(org.snmp4j.smi.Address address)

Gets the TDomainAddress textual convention conforming OctetString value for the specified address.

Parameters:

address - an address.

Returns:

a TDomainAddress OctetString value or null if the address cannot be mapped.