org.jnetpcap.util.config
Class JConfig

java.lang.Object
  org.jnetpcap.util.config.JConfig

public class JConfig
extends java.lang.Object

JConfig is responsible for jNetPcap configuration and global environment maintentance. Its main purpose to locate resources such as config files, read system properties and create an environment where resolver files can be stored and maintained. The class provides various static (global) methods for this purpose.

Property names and constant values:

• "jnetpcap.resolver.dir" - property defines full directory name where resolver files are saved
• "jnetpcap.resolver.suffix" - property defines overrides the default suffix name (default value ".resolver")
• "jnetpcap.resolver.subdir" property overrides the default sub directory name used, if explicit full directory is not defined (default value ".jnp")
• "user.home" - system property which defines where the current user's home dir is

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Nested Class Summary

protected static class	JConfig.ClasspathSearch
protected static class	JConfig.FilesystemSearch
static interface	JConfig.SearchPath Interface used to piece together specific types of search paths.
protected static class	JConfig.URLSearch

Field Summary

static java.lang.String	CACHE_DIR_PROPERTY Java property for resolver directory where resolver files are saved.
static java.lang.String	CACHE_FILE_SUFFIX Suffix of a resolver file.
static java.lang.String	CACHE_FILE_SUFFIX_PROPERTY Suffix of a resolver file.
static java.lang.String	CACHE_SUB_DIR If resolver directory is not explicitely defined with a property, this is the default sub directory name used in user's home directory for all resolver files.
static java.lang.String	CACHE_SUB_DIR_PROPERTY If resolver directory is not explicitely defined with a "jnetpcap.resolver.dir", this is the default sub directory name used in user's home directory for all resolver files.
static java.lang.String	RESOURCE_SEARCH_PATH_PROPERTY
static java.lang.String	USER_HOME_PROPERTY System property name used to lookup user's home directory.

Constructor Summary

JConfig()

Method Summary

static void	addListener(java.beans.PropertyChangeListener listener, java.lang.String defaults) Adds listener on any property change event.
static void	addListener(java.beans.PropertyChangeListener listener, java.lang.String property, boolean defaults)
static void	addListener(java.beans.PropertyChangeListener listener, java.lang.String property, int defaults)
static void	addListener(java.beans.PropertyChangeListener listener, java.lang.String property, long defaults)
static void	addListener(java.beans.PropertyChangeListener listener, java.lang.String property, java.lang.String defaults)
static ConfigString	createConfigString(java.lang.String str)
static java.io.File	createDir(java.lang.String property, java.lang.String defaults)
static JConfig.SearchPath[]	createSearchPath(java.lang.String property)
static SearchpathString	createSearchString(java.lang.String str)
static java.io.File	getDir(JConfig.SearchPath[] paths)
static java.io.File	getDir(java.lang.String property)
static java.lang.String	getExpandedProperty(java.lang.String property)
static java.lang.String	getExpandedProperty(java.lang.String property, java.lang.String defaults)
static java.io.File	getFile(java.lang.String name, JConfig.SearchPath[] paths)
static java.io.File	getFile(java.lang.String name, java.lang.String property)
static java.util.Map<java.lang.String,java.lang.String>	getGlobalVariables()
static java.io.InputStream	getInputStream(java.lang.String name, JConfig.SearchPath[] paths)
static java.io.InputStream	getInputStream(java.lang.String name, java.lang.String property)
static java.lang.String	getProperty(java.lang.String property)
static java.lang.String	getProperty(java.lang.String property, java.lang.String defaults)
static java.io.InputStream	getResourceInputStream(java.lang.String name)
static java.net.URL	getResourceURL(java.lang.String name)
static java.util.Properties	getTopProperties()
static java.net.URL	getURL(java.lang.String name, java.lang.String property)
static java.util.Properties	getUserProperties()
static void	init()
static void	removeListener(java.beans.PropertyChangeListener listener)
static void	removeListener(java.beans.PropertyChangeListener listener, java.lang.String property)
static java.lang.String	setProperty(java.lang.String property, java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_DIR_PROPERTY

public static final java.lang.String CACHE_DIR_PROPERTY

Java property for resolver directory where resolver files are saved. Property name is "jnetpcap.resolver.dir".

See Also:

Constant Field Values

CACHE_FILE_SUFFIX

public static final java.lang.String CACHE_FILE_SUFFIX

Suffix of a resolver file. Default is ".resolver".

See Also:

Constant Field Values

CACHE_FILE_SUFFIX_PROPERTY

public static final java.lang.String CACHE_FILE_SUFFIX_PROPERTY

Suffix of a resolver file. Property name is "jnetpcap.resolver.suffix".

See Also:

Constant Field Values

CACHE_SUB_DIR

public static final java.lang.String CACHE_SUB_DIR

If resolver directory is not explicitely defined with a property, this is the default sub directory name used in user's home directory for all resolver files. Default is ".jnp".

See Also:

Constant Field Values

CACHE_SUB_DIR_PROPERTY

public static final java.lang.String CACHE_SUB_DIR_PROPERTY

If resolver directory is not explicitely defined with a "jnetpcap.resolver.dir", this is the default sub directory name used in user's home directory for all resolver files. The property name is "jnetpcap.resolver.subdir".

See Also:

Constant Field Values

RESOURCE_SEARCH_PATH_PROPERTY

public static final java.lang.String RESOURCE_SEARCH_PATH_PROPERTY

See Also:

Constant Field Values

USER_HOME_PROPERTY

public static final java.lang.String USER_HOME_PROPERTY

System property name used to lookup user's home directory. The property name is "user.home".

See Also:

Constant Field Values

Constructor Detail

JConfig

public JConfig()

Method Detail

addListener

public static void addListener(java.beans.PropertyChangeListener listener,
                               java.lang.String defaults)

Adds listener on any property change event.

Parameters:

listener -

defaults -

addListener

public static void addListener(java.beans.PropertyChangeListener listener,
                               java.lang.String property,
                               boolean defaults)

addListener

public static void addListener(java.beans.PropertyChangeListener listener,
                               java.lang.String property,
                               int defaults)

addListener

public static void addListener(java.beans.PropertyChangeListener listener,
                               java.lang.String property,
                               long defaults)

addListener

public static void addListener(java.beans.PropertyChangeListener listener,
                               java.lang.String property,
                               java.lang.String defaults)

createSearchPath

public static JConfig.SearchPath[] createSearchPath(java.lang.String property)

getFile

public static java.io.File getFile(java.lang.String name,
                                   JConfig.SearchPath[] paths)
                            throws java.io.IOException

Parameters:

name -

paths -

Returns:

Throws:

java.io.IOException

getFile

public static java.io.File getFile(java.lang.String name,
                                   java.lang.String property)
                            throws java.io.IOException

Parameters:

name -

property -

Returns:

Throws:

java.io.IOException

getInputStream

public static java.io.InputStream getInputStream(java.lang.String name,
                                                 JConfig.SearchPath[] paths)
                                          throws java.io.IOException

Throws:

java.io.IOException

getInputStream

public static java.io.InputStream getInputStream(java.lang.String name,
                                                 java.lang.String property)
                                          throws java.io.IOException

Throws:

java.io.IOException

getProperty

public static java.lang.String getProperty(java.lang.String property)

Parameters:

property -

getExpandedProperty

public static java.lang.String getExpandedProperty(java.lang.String property)

getExpandedProperty

public static java.lang.String getExpandedProperty(java.lang.String property,
                                                   java.lang.String defaults)

getProperty

public static java.lang.String getProperty(java.lang.String property,
                                           java.lang.String defaults)

Parameters:

property -

defaults -

Returns:

getResourceInputStream

public static java.io.InputStream getResourceInputStream(java.lang.String name)
                                                  throws java.io.IOException

Throws:

java.io.IOException

getResourceURL

public static java.net.URL getResourceURL(java.lang.String name)
                                   throws java.io.IOException

Throws:

java.io.IOException

getURL

public static java.net.URL getURL(java.lang.String name,
                                  java.lang.String property)
                           throws java.io.IOException

Throws:

java.io.IOException

init

public static void init()

removeListener

public static void removeListener(java.beans.PropertyChangeListener listener)

removeListener

public static void removeListener(java.beans.PropertyChangeListener listener,
                                  java.lang.String property)

setProperty

public static java.lang.String setProperty(java.lang.String property,
                                           java.lang.String value)

Parameters:

property -

value -

getDir

public static java.io.File getDir(JConfig.SearchPath[] paths)

getDir

public static java.io.File getDir(java.lang.String property)

Parameters:

property -

Returns:

createDir

public static java.io.File createDir(java.lang.String property,
                                     java.lang.String defaults)

Parameters:

property -

defaults -

Returns:

createConfigString

public static ConfigString createConfigString(java.lang.String str)

createSearchString

public static SearchpathString createSearchString(java.lang.String str)

getTopProperties

public static java.util.Properties getTopProperties()

getUserProperties

public static java.util.Properties getUserProperties()

getGlobalVariables

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