Package com.identityworksllc.iiq.common.plugin

Class ExtendedPluginContextHelper

java.lang.Object

com.identityworksllc.iiq.common.plugin.ExtendedPluginContextHelper

All Implemented Interfaces:

CommonExtendedPluginContext

public class ExtendedPluginContextHelper
extends Object
implements CommonExtendedPluginContext

A helper class intended to be used by anybody implementing CommonExtendedPluginConfig.

It will retrieve values first from the configured Configuration object, then from the plugin settings.

You should construct a new instance of this class for each retrieval. Do not cache them or your SailPointContext will go stale.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExtendedPluginContextHelper.ConfigurationNameProvider

Constructor Summary

Constructors

Constructor	Description
ExtendedPluginContextHelper(String pluginName, sailpoint.api.SailPointContext context, sailpoint.plugin.PluginContext pluginContext, ExtendedPluginContextHelper.ConfigurationNameProvider nameProvider)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	getConfigurationBool(String settingName)	Gets the configuration setting from the default plugin Configuration object or else from the plugin settings
int	getConfigurationInt(String settingName)	Gets the configuration setting from the default plugin Configuration object or else from the plugin settings
<T> T	getConfigurationObject(String settingName)	Gets the given configuration setting as an Object
String	getConfigurationString(String settingName)	Gets the configuration setting from the default plugin Configuration object or else from the plugin settings

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedPluginContextHelper

public ExtendedPluginContextHelper(String pluginName,
                                   sailpoint.api.SailPointContext context,
                                   sailpoint.plugin.PluginContext pluginContext,
                                   ExtendedPluginContextHelper.ConfigurationNameProvider nameProvider)

Constructor

Parameters:

pluginName - The plugin name

context - The Sailpoint context

pluginContext - The plugin context class

Method Detail

getConfigurationBool

public boolean getConfigurationBool(String settingName)

Description copied from interface: CommonExtendedPluginContext

Gets the configuration setting from the default plugin Configuration object or else from the plugin settings

Specified by:

getConfigurationBool in interface CommonExtendedPluginContext

Parameters:

settingName - The setting to retrieve

Returns:

The setting value

getConfigurationInt

public int getConfigurationInt(String settingName)

Description copied from interface: CommonExtendedPluginContext

Gets the configuration setting from the default plugin Configuration object or else from the plugin settings

Specified by:

getConfigurationInt in interface CommonExtendedPluginContext

Parameters:

settingName - The setting to retrieve

Returns:

The setting value

getConfigurationObject

public <T> T getConfigurationObject(String settingName)

Description copied from interface: CommonExtendedPluginContext

Gets the given configuration setting as an Object

Specified by:

getConfigurationObject in interface CommonExtendedPluginContext

Parameters:

settingName - The setting to retrieve as an Object

Returns:

The object

getConfigurationString

public String getConfigurationString(String settingName)

Description copied from interface: CommonExtendedPluginContext

Gets the configuration setting from the default plugin Configuration object or else from the plugin settings

Specified by:

getConfigurationString in interface CommonExtendedPluginContext

Parameters:

settingName - The setting to retrieve

Returns:

The setting value