Package net.shibboleth.idp.module

Class PropertyDrivenIdPModule

java.lang.Object
net.shibboleth.profile.module.AbstractModule
net.shibboleth.profile.module.PropertyDrivenModule
net.shibboleth.idp.module.PropertyDrivenIdPModule
All Implemented Interfaces:
IdPModule, net.shibboleth.profile.module.Module, Component, IdentifiedComponent
public class PropertyDrivenIdPModule extends net.shibboleth.profile.module.PropertyDrivenModule implements IdPModule
Implementation of IdPModule relying on Java Properties.
Since:
4.1.0

  • Nested Class Summary

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

    net.shibboleth.profile.module.AbstractModule.BasicModuleResource

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

    net.shibboleth.profile.module.Module.ModuleResource, net.shibboleth.profile.module.Module.ResourceResult

  • Field Summary

    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
    Constructor
    Description
    PropertyDrivenIdPModule(InputStream inputStream)
    Constructor.
    PropertyDrivenIdPModule(Class<? extends IdPModule> claz)
    Constructor.
    PropertyDrivenIdPModule(Properties properties)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getNewExtension()
    String
    getSaveExtension()

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

    disable, enable, getDescription, getId, getName, getOwnerId, getURL, isHttpClientRequired, load, 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

  • Constructor Details

    • PropertyDrivenIdPModule

      public PropertyDrivenIdPModule(@Nonnull Class<? extends IdPModule> claz) throws IOException, net.shibboleth.profile.module.ModuleException
      Constructor.
      Parameters:
      claz - type of object used to locate default module.properties resource
      Throws:
      IOException - if unable to read file
      net.shibboleth.profile.module.ModuleException - if the module is not in a valid state

    • PropertyDrivenIdPModule

      public PropertyDrivenIdPModule(@Nonnull InputStream inputStream) throws IOException, net.shibboleth.profile.module.ModuleException
      Constructor.
      Parameters:
      inputStream - property stream
      Throws:
      IOException - if unable to read file
      net.shibboleth.profile.module.ModuleException - if the module is not in a valid state

    • PropertyDrivenIdPModule

      public PropertyDrivenIdPModule(@Nonnull Properties properties) throws net.shibboleth.profile.module.ModuleException
      Constructor.
      Parameters:
      properties - property set
      Throws:
      net.shibboleth.profile.module.ModuleException - if the module is not in a valid state

  • Method Details

    • getSaveExtension

      @Nonnull public String getSaveExtension()
      Specified by:
      getSaveExtension in interface IdPModule
      Specified by:
      getSaveExtension in interface net.shibboleth.profile.module.Module

    • getNewExtension

      @Nonnull public String getNewExtension()
      Specified by:
      getNewExtension in interface IdPModule
      Specified by:
      getNewExtension in interface net.shibboleth.profile.module.Module