Package net.shibboleth.idp.plugin

Class AbstractIdPPlugin

java.lang.Object

net.shibboleth.idp.plugin.AbstractIdPPlugin

All Implemented Interfaces:

IdPPlugin

Direct Known Subclasses:

PropertyDrivenIdPPlugin

public abstract class AbstractIdPPlugin
extends Object
implements IdPPlugin

A base class implementing IdPPlugin that defaults common settings.

Since:

4.1.0

Field Summary

Fields

Modifier and Type	Field	Description
private Set<IdPModule>	disableModules	Modules to disable on removal.
private Set<IdPModule>	enableModules	Modules to enable on install.

Constructor Summary

Constructors

Constructor	Description
AbstractIdPPlugin()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Set<IdPModule>	getDisableOnRemoval()	Get the modules to disable after plugin removal.
Set<IdPModule>	getEnableOnInstall()	Get the modules to enable after plugin installation or upgrade.
String	getLicenseFileLocation()	Return the classpath location of the license file to emit when --license is specified.
int	getPatchVersion()	Return The patch version, (as defined by the Java Product Version Policy.
String	getPluginId()	Return the unique identifier for the plugin.
Set<String>	getRequiredModules()	Get the IDs of any IdPModules required for installation of this plugin.
int	hashCode()
protected void	setDisableOnRemoval(Set<IdPModule> modules)	Set the modules to disable on removal.
protected void	setEnableOnInstall(Set<IdPModule> modules)	Set the modules to enable on install.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.shibboleth.idp.plugin.IdPPlugin

getMajorVersion, getMinorVersion, getUpdateURLs

Field Detail

enableModules

@Nonnull
@NonnullElements
private Set<IdPModule> enableModules

Modules to enable on install.

disableModules

@Nonnull
@NonnullElements
private Set<IdPModule> disableModules

Modules to disable on removal.

Constructor Detail

AbstractIdPPlugin

public AbstractIdPPlugin()

Constructor.

Method Detail

getPluginId

@Nonnull
@NotEmpty
public String getPluginId()

Return the unique identifier for the plugin. This name MUST be

• renderable in all file systems (for instance alphanumerics, '-' and '.' only)
• unique. This is best done using java module guidance

For instance org.example.plugins.myplugin

Specified by:

getPluginId in interface IdPPlugin

Returns:

The id of this plugin.

getPatchVersion

@Nonnegative
public int getPatchVersion()

Return The patch version, (as defined by the Java Product Version Policy.

Specified by:

getPatchVersion in interface IdPPlugin

Returns:

The patch version.

getRequiredModules

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public Set<String> getRequiredModules()

Get the IDs of any IdPModules required for installation of this plugin.

Specified by:

getRequiredModules in interface IdPPlugin

Returns:

module IDs that are required

getEnableOnInstall

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public Set<IdPModule> getEnableOnInstall()

Get the modules to enable after plugin installation or upgrade.

Specified by:

getEnableOnInstall in interface IdPPlugin

Returns:

modules to enable

getLicenseFileLocation

public String getLicenseFileLocation()

Return the classpath location of the license file to emit when --license is specified.

Specified by:

getLicenseFileLocation in interface IdPPlugin

Returns:

the location

setEnableOnInstall

protected void setEnableOnInstall(@Nonnull @NonnullElements
                                  Set<IdPModule> modules)

Set the modules to enable on install.

Parameters:

modules - modules to enable

getDisableOnRemoval

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public Set<IdPModule> getDisableOnRemoval()

Get the modules to disable after plugin removal.

Specified by:

getDisableOnRemoval in interface IdPPlugin

Returns:

modules to disable

setDisableOnRemoval

protected void setDisableOnRemoval(@Nonnull @NonnullElements
                                   Set<IdPModule> modules)

Set the modules to disable on removal.

Parameters:

modules - modules to disable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object