Package net.shibboleth.idp.module.impl

Class PluginIdPModule

java.lang.Object

net.shibboleth.profile.module.AbstractModule

net.shibboleth.profile.module.PropertyDrivenModule

net.shibboleth.idp.module.PropertyDrivenIdPModule

net.shibboleth.idp.module.impl.PluginIdPModule

All Implemented Interfaces:

IdPModule, Module, Component, IdentifiedComponent

public class PluginIdPModule
extends PropertyDrivenIdPModule

Implementation base class for IdPModule that is shipped in a plugin produced by the Shibboleth Project ourselves and for which the documentation will be in the wiki in a fixed location. TODO: Make abstract in V6 and make all constructors protected.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.profile.module.AbstractModule

AbstractModule.BasicModuleResource

Nested classes/interfaces inherited from interface net.shibboleth.profile.module.Module

Module.ModuleResource, Module.ResourceResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODULE_URL_BASE	Documentation base URL.

Fields inherited from class net.shibboleth.profile.module.PropertyDrivenModule

DEFAULT_RESOURCE, MODULE_DESC_PROPERTY, MODULE_DEST_PROPERTY, MODULE_EXEC_PROPERTY, MODULE_LANGS_PROPERTY, MODULE_NAME_PROPERTY, MODULE_NONWINDOWS_PROPERTY, MODULE_OPTIONAL_PROPERTY, MODULE_PLUGIN_PROPERTY, MODULE_POSTDISABLE_PROPERTY, MODULE_POSTENABLE_PROPERTY, MODULE_REPLACE_PROPERTY, MODULE_SRC_PROPERTY, MODULE_URL_PROPERTY, MODULE_WINDOWS_PROPERTY

Fields inherited from interface net.shibboleth.idp.module.IdPModule

IDPNEW_EXT_BASE, IDPSAVE_EXT

Constructor Summary

Constructors

Modifier	Constructor	Description
	PluginIdPModule(Class<? extends IdPModule> claz)	Deprecated, for removal: This API element is subject to removal in a future version.
protected	PluginIdPModule(String version, Class<? extends IdPModule> claz)	Constructor for concrete modules.

Method Summary

Modifier and Type	Method	Description
protected void	load()	The override prepends a known documentation prefix to all module URLs.

Methods inherited from class net.shibboleth.idp.module.PropertyDrivenIdPModule

getNewExtension, getSaveExtension

Methods inherited from class net.shibboleth.profile.module.PropertyDrivenModule

disable, enable, getDescription, getId, getName, getOwnerId, getURL, isHttpClientRequired, setURL

Methods inherited from class net.shibboleth.profile.module.AbstractModule

equals, getResources, hashCode, isEnabled, setResources, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.profile.module.Module

disable, enable, getDescription, getName, getOwnerId, getResources, getURL, isEnabled, isHttpClientRequired

Field Details

MODULE_URL_BASE

@Nonnull
@NotEmpty
public static final String MODULE_URL_BASE

Documentation base URL.

See Also:

• Constant Field Values

Constructor Details

PluginIdPModule

@Deprecated(forRemoval=true,
            since="5.1.0")
public PluginIdPModule(@Nonnull
 Class<? extends IdPModule> claz)
                throws IOException,
ModuleException

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor.

Parameters:

claz - implementation class of the module

Throws:

IOException - if an I/O error occurs

ModuleException - if a generic error occurs

PluginIdPModule

protected PluginIdPModule(@Nullable
 String version,
 @Nonnull
 Class<? extends IdPModule> claz)
                   throws IOException,
ModuleException

Constructor for concrete modules.

Parameters:

version - version of plugin

claz - implementation class of the module

Throws:

IOException - if an I/O error occurs

ModuleException - if a generic error occurs

Since:

5.1.0

Method Details

load

protected void load()
             throws ModuleException

The override prepends a known documentation prefix to all module URLs.

Overrides:

load in class PropertyDrivenModule

Throws:

ModuleException