Package net.shibboleth.idp.module.impl

Class PluginIdPModule

java.lang.Object

net.shibboleth.idp.module.AbstractIdPModule

net.shibboleth.idp.module.PropertyDrivenIdPModule

net.shibboleth.idp.module.impl.PluginIdPModule

All Implemented Interfaces:

IdPModule, 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.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.idp.module.IdPModule

IdPModule.ModuleResource, IdPModule.ResourceResult

Field Summary

Fields

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

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

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

Constructor Summary

Constructors

Constructor	Description
PluginIdPModule(Class<? extends IdPModule> claz)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	load()	Load module information from properties.

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

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

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

equals, getResources, hashCode, isEnabled, setResources, toString

Methods inherited from class java.lang.Object

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

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

public PluginIdPModule(@Nonnull
 Class<? extends IdPModule> claz)
                throws IOException,
ModuleException

Constructor.

Parameters:

claz - implementation class of the module

Throws:

IOException - if an I/O error occurs

ModuleException - if a generic error occurs

Method Details

load

protected void load()
             throws ModuleException

Load module information from properties. The override prepends a known documentation prefix to all module URLs.

Overrides:

load in class PropertyDrivenIdPModule

Throws:

ModuleException - on errors