Collaboration diagram for com.sun.jmx.examples.scandir.config.ScanManagerConfig:

Public Member Functions
ScanManagerConfig	copy (String newname)

boolean	equals (Object o)

ResultLogConfig	getInitialResultLogConfig ()

String	getName ()

DirectoryScannerConfig	getScan (String name)

DirectoryScannerConfig[]	getScanList ()

int	hashCode ()

DirectoryScannerConfig	putScan (DirectoryScannerConfig scan)

DirectoryScannerConfig	removeScan (String name)

	ScanManagerConfig ()

	ScanManagerConfig (String name)

void	setInitialResultLogConfig (ResultLogConfig initialLogConfig)

void	setName (String name)

void	setScanList (DirectoryScannerConfig[] scans)

String	toString ()

Private Member Functions
	ScanManagerConfig (String name, boolean allowsNull)

Object[]	toArray ()

Static Private Member Functions
static ScanManagerConfig	copy (String newname, ScanManagerConfig other)

Private Attributes
final Map< String, DirectoryScannerConfig >	directoryScanners

ResultLogConfig	initialResultLogConfig

String	name

Detailed Description

The ScanManagerConfig Java Bean is used to model the configuration of the {ScanManagerMXBean}. The { com.sun.jmx.examples.scandir.ScanManagerMXBean ScanManagerMXBean} will use this configuration to initialize the { com.sun.jmx.examples.scandir.ResultLogManagerMXBean ResultLogManagerMXBean} and create the { com.sun.jmx.examples.scandir.DirectoryScannerMXBean DirectoryScannerMXBeans} This class is annotated for XML binding.

Author: Sun Microsystems, 2006 - All rights reserved.

Definition at line 72 of file ScanManagerConfig.java.

Constructor & Destructor Documentation

◆ ScanManagerConfig() [1/3]

com.sun.jmx.examples.scandir.config.ScanManagerConfig.ScanManagerConfig ( )

Creates a new instance of ScanManagerConfig.

You should not use this constructor directly, but use ScanManagerConfig(String) instead.

This constructor is tagged deprecated so that the compiler will generate a warning if it is used by mistake.

Deprecated:: Use ScanManagerConfig(String) instead. This constructor is used through reflection by the XML binding framework.

Definition at line 111 of file ScanManagerConfig.java.

◆ ScanManagerConfig() [2/3]

com.sun.jmx.examples.scandir.config.ScanManagerConfig.ScanManagerConfig ( String name )

Creates a new instance of ScanManagerConfig.

Parameters

name	The name of the configuration which usually corresponds to the value of the name= key of the ObjectName of the {ScanDirConfigMXBean} which owns this configuration.

Definition at line 123 of file ScanManagerConfig.java.

References name().

Here is the call graph for this function:

◆ ScanManagerConfig() [3/3]

com.sun.jmx.examples.scandir.config.ScanManagerConfig.ScanManagerConfig	(	String	name,
		boolean	allowsNull
	)

private

Definition at line 128 of file ScanManagerConfig.java.

References name(), and com.sun.jmx.examples.scandir.config.ResultLogConfig.setMemoryMaxRecords().

Here is the call graph for this function:

Member Function Documentation

◆ copy() [1/2]

ScanManagerConfig com.sun.jmx.examples.scandir.config.ScanManagerConfig.copy ( String newname )

Creates a copy of this object, with the specified name.

Parameters

newname the name of the copy.

Returns: A copy of this object.

Definition at line 292 of file ScanManagerConfig.java.

Referenced by com.sun.jmx.examples.scandir.ScanDirConfig.load(), com.sun.jmx.examples.scandir.ScanDirConfig.preRegister(), and com.sun.jmx.examples.scandir.ScanDirConfig.setConfiguration().

Here is the caller graph for this function:

◆ copy() [2/2]

static ScanManagerConfig com.sun.jmx.examples.scandir.config.ScanManagerConfig.copy	(	String	newname,
		ScanManagerConfig	other
	)

staticprivate

Definition at line 299 of file ScanManagerConfig.java.

References com.sun.jmx.examples.scandir.config.ScanManagerConfig.name, and com.sun.jmx.examples.scandir.config.XmlConfigUtils.xmlClone().

Here is the call graph for this function:

◆ equals()

boolean com.sun.jmx.examples.scandir.config.ScanManagerConfig.equals ( Object o )

Definition at line 147 of file ScanManagerConfig.java.

References com.sun.jmx.examples.scandir.config.ScanManagerConfig.directoryScanners, and com.sun.jmx.examples.scandir.config.ScanManagerConfig.toArray().

Here is the call graph for this function:

◆ getInitialResultLogConfig()

ResultLogConfig com.sun.jmx.examples.scandir.config.ScanManagerConfig.getInitialResultLogConfig ( )

Gets the initial Result Log Configuration.

Returns: The initial Result Log Configuration.

Definition at line 275 of file ScanManagerConfig.java.

◆ getName()

String com.sun.jmx.examples.scandir.config.ScanManagerConfig.getName ( )

Gets the name of this configuration. The name of the configuration usually corresponds to the value of the

name=

key of the

ObjectName

of the {ScanDirConfigMXBean} which owns this configuration. The name of this configuration.

Definition at line 173 of file ScanManagerConfig.java.

References name().

Referenced by com.sun.jmx.examples.scandir.ScanDirConfig.guessConfigName(), com.sun.jmx.examples.scandir.ScanDirConfig.load(), com.sun.jmx.examples.scandir.ScanDirConfig.preRegister(), and com.sun.jmx.examples.scandir.ScanDirConfig.setConfiguration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScan()

DirectoryScannerConfig com.sun.jmx.examples.scandir.config.ScanManagerConfig.getScan ( String name )

Get a directory scanner by its name.

Parameters

name	The name of the directory scanner. This is the value returned by {}. The named DirectoryScannerConfig

Definition at line 233 of file ScanManagerConfig.java.

References name().

Referenced by com.sun.jmx.examples.scandir.ScanDirConfigTest.testAddDirectoryScanner(), and com.sun.jmx.examples.scandir.DirectoryScannerTest.testGetRootDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScanList()

DirectoryScannerConfig [] com.sun.jmx.examples.scandir.config.ScanManagerConfig.getScanList ( )

Gets the list of Directory Scanner configured by this configuration. From each element in this list, the ScanManagerMXBean will create, initialize, and register a {}. The list of Directory Scanner configured by this configuration.

Definition at line 207 of file ScanManagerConfig.java.

◆ hashCode()

int com.sun.jmx.examples.scandir.config.ScanManagerConfig.hashCode ( )

Definition at line 157 of file ScanManagerConfig.java.

References name().

Here is the call graph for this function:

◆ putScan()

DirectoryScannerConfig com.sun.jmx.examples.scandir.config.ScanManagerConfig.putScan ( DirectoryScannerConfig scan )

Adds a directory scanner to the list.

If a directory scanner configuration by that name already exists in the list, it will be replaced by the given scan.

Parameters

scan	The DirectoryScannerConfig to add to the list.

Returns: The replaced
DirectoryScannerConfig

, or
null

if there was no
DirectoryScannerConfig

by that name in the list.

Definition at line 248 of file ScanManagerConfig.java.

Referenced by com.sun.jmx.examples.scandir.ScanDirConfig.addDirectoryScanner(), com.sun.jmx.examples.scandir.ScanDirConfigTest.testGetXmlConfigString(), com.sun.jmx.examples.scandir.ScanDirConfigTest.testLoad(), com.sun.jmx.examples.scandir.config.XmlConfigUtilsTest.testReadFromFile(), com.sun.jmx.examples.scandir.ScanDirConfigTest.testSave(), and com.sun.jmx.examples.scandir.config.XmlConfigUtilsTest.testWriteToFile().

Here is the caller graph for this function:

◆ removeScan()

DirectoryScannerConfig com.sun.jmx.examples.scandir.config.ScanManagerConfig.removeScan ( String name )

Removes the named directory scanner from the list.

Parameters

name	The name of the directory scanner. This is the value returned by {}. The removed DirectoryScannerConfig , or null if there was no directory scanner by that name in the list.

Definition at line 266 of file ScanManagerConfig.java.

References name().

Referenced by com.sun.jmx.examples.scandir.ScanDirConfig.removeDirectoryScanner(), com.sun.jmx.examples.scandir.ScanDirConfigTest.testAddNotificationListener(), com.sun.jmx.examples.scandir.ScanDirConfigTest.testLoad(), and com.sun.jmx.examples.scandir.ScanDirConfigTest.testSave().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setInitialResultLogConfig()

void com.sun.jmx.examples.scandir.config.ScanManagerConfig.setInitialResultLogConfig ( ResultLogConfig initialLogConfig )

Sets the initial Result Log Configuration.

Parameters

initialLogConfig The initial Result Log Configuration.

Definition at line 283 of file ScanManagerConfig.java.

Referenced by com.sun.jmx.examples.scandir.ScanManager.applyCurrentResultLogConfig().

Here is the caller graph for this function:

◆ setName()

void com.sun.jmx.examples.scandir.config.ScanManagerConfig.setName ( String name )

Sets the name of this configuration. The name of the configuration usually corresponds to the value of the

name=

key of the

ObjectName

of the {ScanDirConfigMXBean} which owns this configuration. Once set this value cannot change.

Parameters

name	The name of this configuration.

Definition at line 187 of file ScanManagerConfig.java.

References name().

Here is the call graph for this function:

◆ setScanList()

void com.sun.jmx.examples.scandir.config.ScanManagerConfig.setScanList ( DirectoryScannerConfig[] scans )

Sets the list of Directory Scanner configured by this configuration. From each element in this list, the ScanManagerMXBean will create, initialize, and register a {}. scans The list of Directory Scanner configured by this configuration.

Definition at line 219 of file ScanManagerConfig.java.