org.friendlysnmp

Class FConfig

java.lang.Object

org.friendlysnmp.FConstant

org.friendlysnmp.FConfig

public class FConfig
extends FConstant

Field Summary

Fields inherited from class org.friendlysnmp.FConstant

AGENPRO_INFO, DEFAULT_ALLOW_BOOTS_COUNT_RESET, DEFAULT_CONSOLE_UNCAUGHT, DEFAULT_DEADLOCK_CHECK_INTERVAL_SEC, DEFAULT_IGNORE_UPDATE_MS, DEFAULT_NOTIFY_RETRY_COUNT, DEFAULT_NOTIFY_TIMEOUT_MS, DEFAULT_OID_ROOT, DEFAULT_PERSIST_POLICY, DEFAULT_STORAGE_COMMUNITY, DEFAULT_STORAGE_NOTIFY, DEFAULT_STORAGE_VACM_ACCESS, DEFAULT_STORAGE_VACM_GROUP, DEFAULT_STORAGE_VACM_VIEWTREE, DEFAULT_THREAD_POOL_SIZE, DEFAULT_TRANSPORT, DEFAULT_TRANSPORT_DOMAIN, DEFAULT_V3_PASSWORD_KEY, FRIENDLY_ENTERPRISE_ID, FRIENDLYSNMP_INFO, JVM_MIB_INFO, KEY_ADDRESS_SEND_NOTIFY, KEY_ADDRESS_SET_GET, KEY_ALLOW_BOOTS_COUNT_RESET, KEY_CONSOLE_UNCAUGHT, KEY_ENGINE_ID, KEY_IGNORE_UPDATE_MS, KEY_NOTIFY_RETRY_COUNT, KEY_NOTIFY_TIMEOUT_MS, KEY_OID_ROOT_NOTIFY_VIEW, KEY_OID_ROOT_READ_VIEW, KEY_OID_ROOT_WRITE_VIEW, KEY_PERSIST_FILENAME, KEY_PERSIST_POLICY, KEY_PLUGIN_PREFIX, KEY_STORAGE_COMMUNITY, KEY_STORAGE_NOTIFY, KEY_STORAGE_VACM_ACCESS, KEY_STORAGE_VACM_GROUP, KEY_STORAGE_VACM_VIEWTREE, KEY_THREAD_POOL_SIZE, KEY_TRANSPORT, KEY_TRANSPORT_DOMAIN, KEY_V1_COMMUNITY, KEY_V2_COMMUNITY, KEY_V3_CONTEXT, KEY_V3_PASSWORD_AUTH, KEY_V3_PASSWORD_KEY, KEY_V3_PASSWORD_PRIV, KEY_V3_PROTOCOL_AUTH, KEY_V3_PROTOCOL_PRIV, KEY_V3_USER, MAX_IGNORE_UPDATE_MS, PREFIX_APP, PREFIX_DEPENDENCY, SNMP4J_INFO, SNMP4JAGENT_INFO

Constructor Summary

Constructors

Constructor and Description
FConfig(java.lang.String appTitle, java.lang.String appVersion, java.util.Properties propApp)

Method Summary

Modifier and Type	Method and Description
void	addDefaultProperty(java.lang.String key, java.lang.String value)
java.lang.String	getAddress()
java.util.Map<java.lang.String,java.lang.String>	getAppDependencies() Returns application dependencies collection: external jars, used tools, and so on.
java.util.Map<java.lang.String,java.lang.String>	getAppInfo() Returns collection of application information: title, version and so on.
java.util.Map<java.lang.String,java.lang.String>	getAppProp() Returns application properties.
java.lang.String	getAppProperty(java.lang.String key)
java.lang.String	getAppTitle() Returns application title
boolean	getConfigBoolean(java.lang.String key)
int	getConfigInteger(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getConfigProp()
java.lang.String	getConfigString(java.lang.String key)
static java.net.InetAddress	getInetAddress() Returns network host in the following preferences order: (1)IPv4 host, (2)IPv6 host if IPv4 host is not found, (3)localhost if none of the above is found.
java.lang.String	getNotifyAddress()
java.lang.String[]	getPlugins()
java.lang.String[]	getTargets(java.lang.String key)
static void	throwFException(java.lang.String key)
static void	throwRuntimeException(java.lang.String key)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FConfig

public FConfig(java.lang.String appTitle,
               java.lang.String appVersion,
               java.util.Properties propApp)

Method Detail

addDefaultProperty

public void addDefaultProperty(java.lang.String key,
                               java.lang.String value)

getAppProperty

public java.lang.String getAppProperty(java.lang.String key)

getTargets

public java.lang.String[] getTargets(java.lang.String key)

getConfigString

public java.lang.String getConfigString(java.lang.String key)

getConfigInteger

public int getConfigInteger(java.lang.String key)
                     throws FException

Throws:

FException

getConfigBoolean

public boolean getConfigBoolean(java.lang.String key)

getAppInfo

public java.util.Map<java.lang.String,java.lang.String> getAppInfo()
                                                            throws FException

Returns collection of application information: title, version and so on. This information is for information only and is presented in MIB browser.

Returns:

collection of application information.

Throws:

FException - if not valid property.

getAppDependencies

public java.util.Map<java.lang.String,java.lang.String> getAppDependencies()
                                                                    throws FException

Returns application dependencies collection: external jars, used tools, and so on. This information is for information only and is presented in MIB browser.

Returns:

application dependencies collection.

Throws:

FException - if not valid property.

getAppProp

public java.util.Map<java.lang.String,java.lang.String> getAppProp()

Returns application properties. This method loads the properties object at agent startup to expose them to MIB browser. Any changes to the properties object after the fact are ignored.

Returns:

collection object.

getConfigProp

public java.util.Map<java.lang.String,java.lang.String> getConfigProp()

getAppTitle

public java.lang.String getAppTitle()

Returns application title

Returns:

application title

getAddress

public java.lang.String getAddress()

getNotifyAddress

public java.lang.String getNotifyAddress()

getPlugins

public java.lang.String[] getPlugins()
                              throws FException

Throws:

FException

getInetAddress

public static java.net.InetAddress getInetAddress()
                                           throws java.io.IOException

Returns network host in the following preferences order: (1)IPv4 host, (2)IPv6 host if IPv4 host is not found, (3)localhost if none of the above is found.

The method InetAddress.getLocalHost() returns localhost on a Linux. Also, Linux returns IPv6 host _before_ IPv4 host while IPv4 return value is preferable in many cases. Thus more complex method to find a host is required.

Returns:

network address

Throws:

java.io.IOException - failure to access network.

throwRuntimeException

public static void throwRuntimeException(java.lang.String key)

throwFException

public static void throwFException(java.lang.String key)
                            throws FException

Throws:

FException