oracle.ifs.admin.tools.fingerprint

Class FingerprintPlugin

java.lang.Object

oracle.ifs.admin.tools.fingerprint.FingerprintPlugin

Direct Known Subclasses:

ClassObjectInstanceCountPlugin, FolderStructurePlugin, LibraryObjectPlugin, SqlPlugin

public abstract class FingerprintPlugin
extends Object

Abstract base class for all plugin implementations.

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
FingerprintPlugin()

Method Summary

Modifier and Type	Method and Description
abstract void	execute(FingerprintContext context) Executes the plugin.
protected String	getConfiguration(String name) Gets a configuration property that must exist or an exception will be thrown.
protected String	getConfiguration(String name, String defaultValue) Gets a configuration property with a defaulted value.
protected String	getName() Returns the name of the plugin.
protected void	setConfiguration(Map config) Sets the plugin configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

FingerprintPlugin

public FingerprintPlugin()

Method Detail

getName

protected final String getName()

Returns the name of the plugin.

Returns:

the name of the plugin

(Unpublished)

setConfiguration

protected void setConfiguration(Map config)

Sets the plugin configuration.

Parameters:

config - the configuration

(Unpublished)

getConfiguration

protected String getConfiguration(String name,
                                  String defaultValue)

Gets a configuration property with a defaulted value.

Parameters:

name - the name of the configuration property

defaultValue - the default value to return if the configuration property is not set

Returns:

the value of the configuration property or the default value

(Unpublished)

getConfiguration

protected String getConfiguration(String name)

Gets a configuration property that must exist or an exception will be thrown.

Parameters:

name - the configuration property name

Returns:

the value of the configuration property

Throws:

RuntimeException - id the configuration property is not set

(Unpublished)

execute

public abstract void execute(FingerprintContext context)
                      throws Exception

Executes the plugin.

Parameters:

context - the context

Throws:

Exception - if the operation fails

(Unpublished)