Package net.shibboleth.sp.saml.conf

Class SAMLModule

java.lang.Object

net.shibboleth.profile.module.AbstractModule

net.shibboleth.profile.module.PropertyDrivenModule

net.shibboleth.idp.module.PropertyDrivenIdPModule

net.shibboleth.idp.module.impl.PluginIdPModule

net.shibboleth.sp.saml.conf.SAMLModule

All Implemented Interfaces:

IdPModule, Module, Component, IdentifiedComponent

public final class SAMLModule
extends PluginIdPModule

IdPModule implementation.

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	DEFAULT_ENCRYPTION_CERT_FILENAME	Default value of property naming encryption cert.
static final String	DEFAULT_ENCRYPTION_KEY_FILENAME	Default value of property naming encryption key.
static final String	DEFAULT_SIGNING_CERT_FILENAME	Default value of property naming signing cert.
static final String	DEFAULT_SIGNING_KEY_FILENAME	Default value of property naming signing key.
private org.slf4j.Logger	log	Class logger.

Fields inherited from class net.shibboleth.idp.module.impl.PluginIdPModule

MODULE_URL_BASE

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
SAMLModule()	Constructor.

Method Summary

Modifier and Type	Method	Description
Map<Module.ModuleResource,Module.ResourceResult>	enable(ModuleContext moduleContext)
private void	generateKeyPair(Path keyFile, Path crtFile)	Generate a keypair.

Methods inherited from class net.shibboleth.idp.module.impl.PluginIdPModule

load

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

getNewExtension, getSaveExtension

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

disable, 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

DEFAULT_SIGNING_KEY_FILENAME

@Nonnull
public static final String DEFAULT_SIGNING_KEY_FILENAME

Default value of property naming signing key.

See Also:

• Constant Field Values

DEFAULT_SIGNING_CERT_FILENAME

@Nonnull
public static final String DEFAULT_SIGNING_CERT_FILENAME

Default value of property naming signing cert.

See Also:

• Constant Field Values

DEFAULT_ENCRYPTION_KEY_FILENAME

@Nonnull
public static final String DEFAULT_ENCRYPTION_KEY_FILENAME

Default value of property naming encryption key.

See Also:

• Constant Field Values

DEFAULT_ENCRYPTION_CERT_FILENAME

@Nonnull
public static final String DEFAULT_ENCRYPTION_CERT_FILENAME

Default value of property naming encryption cert.

See Also:

• Constant Field Values

log

@Nonnull
private org.slf4j.Logger log

Class logger.

Constructor Details

SAMLModule

public SAMLModule()
           throws IOException,
ModuleException

Constructor.

Throws:

ModuleException - on error

IOException - on error

Method Details

enable

@Nonnull
public Map<Module.ModuleResource,Module.ResourceResult> enable(@Nonnull
 ModuleContext moduleContext)
                                                        throws ModuleException

Specified by:

enable in interface Module

Overrides:

enable in class PropertyDrivenModule

Throws:

ModuleException

generateKeyPair

private void generateKeyPair(@Nonnull
 Path keyFile,
 @Nonnull
 Path crtFile)
                      throws ModuleException

Generate a keypair.

Parameters:

keyFile - where to put the key file

crtFile - where to put the crt file

Throws:

ModuleException - if the generator fails