org.jboss.seam.security.external.saml.api

Interface SamlIdentityProviderConfigurationApi

All Superinterfaces:

EntityConfigurationApi, SamlEntityConfigurationApi

All Known Subinterfaces:

SamlIdpBeanApi

All Known Implementing Classes:

SamlIdpBean

public interface SamlIdentityProviderConfigurationApi
extends SamlEntityConfigurationApi

API for the configuration of a SAML Identity Provider

Author:

Marcel Kolsteren

Method Summary

Methods

Modifier and Type	Method and Description
List<SamlExternalServiceProvider>	getServiceProviders() Gets a list of all external service providers that have been added previously by calling SamlEntityConfigurationApi.addExternalSamlEntity(java.io.Reader).
boolean	isSingleLogoutMessagesSigned() This property indicates whether outgoing single logout messages are signed.
boolean	isWantAuthnRequestsSigned() This property indicates whether incoming authentication requests need to be signed.
boolean	isWantSingleLogoutMessagesSigned() This property indicates whether incoming single logout requests are required to have a valid signature.
void	setSingleLogoutMessagesSigned(boolean singleLogoutMessagesSigned) See isSingleLogoutMessagesSigned().
void	setWantAuthnRequestsSigned(boolean wantAuthnRequestsSigned) See isWantAuthnRequestsSigned().
void	setWantSingleLogoutMessagesSigned(boolean wantSingleLogoutMessagesSigned) See isWantSingleLogoutMessagesSigned().

Methods inherited from interface org.jboss.seam.security.external.saml.api.SamlEntityConfigurationApi

addExternalSamlEntity, getEntityId, getExternalSamlEntities, getExternalSamlEntityByEntityId, getMetaDataURL, getPreferredBinding, setEntityId, setPreferredBinding, setSigningKey

Methods inherited from interface org.jboss.seam.security.external.api.EntityConfigurationApi

getHostName, getPort, getProtocol, setHostName, setPort, setProtocol

Method Detail

isWantAuthnRequestsSigned

boolean isWantAuthnRequestsSigned()

This property indicates whether incoming authentication requests need to be signed. This property is disabled (false) by default.

Returns:

true iff the authentication requests need to be signed

setWantAuthnRequestsSigned

void setWantAuthnRequestsSigned(boolean wantAuthnRequestsSigned)

See isWantAuthnRequestsSigned().

isSingleLogoutMessagesSigned

boolean isSingleLogoutMessagesSigned()

This property indicates whether outgoing single logout messages are signed. True by default, and the advice is not to disable this property, unless you understand the security risks of doing so.

Returns:

true iff the single logout requests (sent to identity providers) are signed

setSingleLogoutMessagesSigned

void setSingleLogoutMessagesSigned(boolean singleLogoutMessagesSigned)

See isSingleLogoutMessagesSigned().

isWantSingleLogoutMessagesSigned

boolean isWantSingleLogoutMessagesSigned()

This property indicates whether incoming single logout requests are required to have a valid signature. True by default, and the advice is not to disable this property, unless you understand the security risks of doing so.

Returns:

true iff incoming single logout requests need to have a valid signature

setWantSingleLogoutMessagesSigned

void setWantSingleLogoutMessagesSigned(boolean wantSingleLogoutMessagesSigned)

See isWantSingleLogoutMessagesSigned().

getServiceProviders

List<SamlExternalServiceProvider> getServiceProviders()

Gets a list of all external service providers that have been added previously by calling SamlEntityConfigurationApi.addExternalSamlEntity(java.io.Reader).

Returns:

the list