Package net.shibboleth.idp.module
Class AbstractIdPModule
- java.lang.Object
-
- net.shibboleth.idp.module.AbstractIdPModule
-
- All Implemented Interfaces:
IdPModule
,Component
,IdentifiedComponent
- Direct Known Subclasses:
PropertyDrivenIdPModule
public abstract class AbstractIdPModule extends Object implements IdPModule
IdPModule
base class implementing basic file management.- Since:
- 4.1.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
AbstractIdPModule.BasicModuleResource
Models a specific resource managed by a module.-
Nested classes/interfaces inherited from interface net.shibboleth.idp.module.IdPModule
IdPModule.ModuleResource, IdPModule.ResourceResult
-
-
Field Summary
Fields Modifier and Type Field Description private org.slf4j.Logger
log
Class logger.private Collection<AbstractIdPModule.BasicModuleResource>
moduleResources
Module resources.
-
Constructor Summary
Constructors Constructor Description AbstractIdPModule()
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<IdPModule.ModuleResource,IdPModule.ResourceResult>
disable(ModuleContext moduleContext, boolean clean)
Disable the module.Map<IdPModule.ModuleResource,IdPModule.ResourceResult>
enable(ModuleContext moduleContext)
Enable the module.boolean
equals(Object obj)
Collection<IdPModule.ModuleResource>
getResources()
Gets resources managed by this module.int
hashCode()
boolean
isEnabled(ModuleContext moduleContext)
Gets whether the module is enabled.void
setResources(Collection<AbstractIdPModule.BasicModuleResource> resources)
Sets the module resources to manage.String
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent
getId
-
Methods inherited from interface net.shibboleth.idp.module.IdPModule
getDescription, getName, getOwnerId, getURL, isHttpClientRequired
-
-
-
-
Field Detail
-
log
@Nonnull private org.slf4j.Logger log
Class logger.
-
moduleResources
@Nonnull @NonnullElements private Collection<AbstractIdPModule.BasicModuleResource> moduleResources
Module resources.
-
-
Method Detail
-
getResources
@Nonnull @NonnullElements @NotLive @Unmodifiable public Collection<IdPModule.ModuleResource> getResources()
Gets resources managed by this module.- Specified by:
getResources
in interfaceIdPModule
- Returns:
- resources managed by this module
-
setResources
public void setResources(@Nullable @NonnullElements Collection<AbstractIdPModule.BasicModuleResource> resources)
Sets the module resources to manage.- Parameters:
resources
- resources to manage
-
isEnabled
public boolean isEnabled(@Nonnull ModuleContext moduleContext)
Gets whether the module is enabled.The status of "enabled" is meant to reflect whether a deployer has previously or implicitly enabled the module, not necessarily whether the module is fully or properly configured or in use.
-
enable
@Nonnull @NonnullElements public Map<IdPModule.ModuleResource,IdPModule.ResourceResult> enable(@Nonnull ModuleContext moduleContext) throws ModuleException
Enable the module.This operation MUST be idempotent.
- Specified by:
enable
in interfaceIdPModule
- Parameters:
moduleContext
- module context- Returns:
- summary of resource results
- Throws:
ModuleException
- if not successful
-
disable
@Nonnull @NonnullElements public Map<IdPModule.ModuleResource,IdPModule.ResourceResult> disable(@Nonnull ModuleContext moduleContext, boolean clean) throws ModuleException
Disable the module.This operation MUST be idempotent with respect to the value of the input parameter.
- Specified by:
disable
in interfaceIdPModule
- Parameters:
moduleContext
- module contextclean
- if true, the module should attempt to fully remove traces of previous use in a potentially destructive fashion- Returns:
- summary of resource results
- Throws:
ModuleException
- if not successful
-
-