net.shibboleth.idp.admin

Class BasicAdministrativeFlowDescriptor

java.lang.Object

net.shibboleth.idp.profile.config.AbstractProfileConfiguration

net.shibboleth.idp.admin.BasicAdministrativeFlowDescriptor

All Implemented Interfaces:

AdministrativeFlowDescriptor, AuthenticationProfileConfiguration, ProfileConfiguration, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.IdentifiedComponent

public class BasicAdministrativeFlowDescriptor
extends AbstractProfileConfiguration
implements AdministrativeFlowDescriptor

A descriptor for an administrative flow.

Administrative flows are essentially any feature intrinsic to the IdP itself and generally not exposed to external systems using security mechanisms that would involve the more traditional "relying party" machinery and security models. Examples include status reporting and service management features, or user self-service features.

Since:

3.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicAdministrativeFlowDescriptor.Logo A wrapper class to construct logo objects for exposure by UIInfo interface.

Field Summary

Fields

Modifier and Type	Field and Description
private Predicate<org.opensaml.profile.context.ProfileRequestContext>	authenticatedPredicate Whether user authentication is required.
private Function<org.opensaml.profile.context.ProfileRequestContext,Set<String>>	authenticationFlowsLookupStrategy Filters the usable authentication flows.
private org.opensaml.core.xml.XMLObjectBuilderFactory	builderFactory Builder factory for XMLObjects needed in UIInfo emulation.
private Function<org.opensaml.profile.context.ProfileRequestContext,Collection<Principal>>	defaultAuthenticationMethodsLookupStrategy Selects, and limits, the authentication flows to use for requests by supported principals.
private String	loggingId Logging ID.
private Function<org.opensaml.profile.context.ProfileRequestContext,String>	policyNameLookupStrategy Lookup strategy for access control policy to apply.
private Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>>	postAuthenticationFlowsLookupStrategy Enables post-authentication interceptor flows.
private Predicate<org.opensaml.profile.context.ProfileRequestContext>	resolveAttributesPredicate Whether attributes should be resolved in the course of the flow.
private Predicate<org.opensaml.profile.context.ProfileRequestContext>	supportsNonBrowserPredicate Whether this flow supports non-browser clients.
private org.opensaml.saml.ext.saml2mdui.UIInfo	uiInfo Expose user interface details.

Constructor Summary

Constructors

Constructor and Description
BasicAdministrativeFlowDescriptor(String id) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<String>	getAuthenticationFlows()
List<Principal>	getDefaultAuthenticationMethods()
List<String>	getInboundInterceptorFlows()
String	getLoggingId() Get a logging ID to use when auditing this profile.
List<String>	getNameIDFormatPrecedence()
List<String>	getOutboundInterceptorFlows()
String	getPolicyName() Get the access control policy for this flow.
List<String>	getPostAuthenticationFlows()
SecurityConfiguration	getSecurityConfiguration()
org.opensaml.saml.ext.saml2mdui.UIInfo	getUIInfo() Get the user interface details for this profile.
int	hashCode()
boolean	isAuthenticated() Get whether user authentication is required (default is false).
boolean	isNonBrowserSupported() Get whether this flow supports non-browser clients (default is true).
boolean	resolveAttributes() Get whether to resolve attributes during the profile (default is false).
void	setAuthenticated(boolean flag) Set whether user authentication is required (default is false).
void	setAuthenticatedPredicate(Predicate<org.opensaml.profile.context.ProfileRequestContext> condition) Set condition to determine whether user authentication is required (default is false).
void	setAuthenticationFlows(Collection<String> flows) Set the authentication flows to use.
void	setAuthenticationFlowsLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,Set<String>> strategy) Set a lookup strategy for the authentication flows to use.
void	setDefaultAuthenticationMethods(Collection<Principal> methods) Set the default authentication methods to use, expressed as custom principals.
void	setDefaultAuthenticationMethodsLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,Collection<Principal>> strategy) Set a lookup strategy for the authentication methods to use, expressed as custom principals.
void	setDescriptions(Collection<net.shibboleth.utilities.java.support.primitive.LangBearingString> descriptions) Set the Description objects to expose via getUIInfo() via a utility class.
void	setDisplayNames(Collection<net.shibboleth.utilities.java.support.primitive.LangBearingString> displayNames) Set the DisplayName objects to expose via getUIInfo() via a utility class.
void	setInformationURLs(Collection<net.shibboleth.utilities.java.support.primitive.LangBearingString> urls) Set the InformationURL objects to expose via getUIInfo() via a utility class.
void	setLoggingId(String id) Set a logging ID to use when auditing this profile.
void	setLogos(Collection<BasicAdministrativeFlowDescriptor.Logo> logos) Set the Logo objects to expose via getUIInfo() via a utility class.
void	setNonBrowserSupported(boolean isSupported) Set whether this flow supports non-browser clients (default is true).
void	setNonBrowserSupportedPredicate(Predicate<org.opensaml.profile.context.ProfileRequestContext> condition) Set condition to determine whether this flow supports non-browser clients.
void	setPolicyName(String name) Set an explicit access control policy name to apply.
void	setPolicyNameLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,String> strategy) Set a lookup strategy to use to obtain the access control policy for this flow.
void	setPostAuthenticationFlows(Collection<String> flows) Set the ordered collection of post-authentication interceptor flows to enable.
void	setPostAuthenticationFlowsLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> strategy) Set a lookup strategy for the post-authentication interceptor flows to enable.
void	setPrivacyStatementURLs(Collection<net.shibboleth.utilities.java.support.primitive.LangBearingString> urls) Set the PrivacyStatementURL objects to expose via getUIInfo() via a utility class.
void	setResolveAttributes(boolean flag) Set whether attributes should be resolved during the profile.
void	setResolveAttributesPredicate(Predicate<org.opensaml.profile.context.ProfileRequestContext> condition) Set a condition to determine whether attributes should be resolved during the profile.
String	toString()

Methods inherited from class net.shibboleth.idp.profile.config.AbstractProfileConfiguration

getDisallowedFeatures, getId, getIndirectProperty, getProfileRequestContext, isFeatureDisallowed, setDisallowedFeatures, setDisallowedFeaturesLookupStrategy, setInboundFlowsLookupStrategy, setInboundInterceptorFlows, setOutboundFlowsLookupStrategy, setOutboundInterceptorFlows, setSecurityConfiguration, setSecurityConfigurationLookupStrategy, setServletRequest

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

Field Detail

loggingId

@Nullable
private String loggingId

Logging ID.

supportsNonBrowserPredicate

private Predicate<org.opensaml.profile.context.ProfileRequestContext> supportsNonBrowserPredicate

Whether this flow supports non-browser clients.

authenticatedPredicate

private Predicate<org.opensaml.profile.context.ProfileRequestContext> authenticatedPredicate

Whether user authentication is required.

uiInfo

@Nonnull
private final org.opensaml.saml.ext.saml2mdui.UIInfo uiInfo

Expose user interface details.

policyNameLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,String> policyNameLookupStrategy

Lookup strategy for access control policy to apply.

resolveAttributesPredicate

@Nonnull
private Predicate<org.opensaml.profile.context.ProfileRequestContext> resolveAttributesPredicate

Whether attributes should be resolved in the course of the flow.

defaultAuthenticationMethodsLookupStrategy

@Nullable
private Function<org.opensaml.profile.context.ProfileRequestContext,Collection<Principal>> defaultAuthenticationMethodsLookupStrategy

Selects, and limits, the authentication flows to use for requests by supported principals.

authenticationFlowsLookupStrategy

@Nullable
private Function<org.opensaml.profile.context.ProfileRequestContext,Set<String>> authenticationFlowsLookupStrategy

Filters the usable authentication flows.

postAuthenticationFlowsLookupStrategy

@Nullable
private Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> postAuthenticationFlowsLookupStrategy

Enables post-authentication interceptor flows.

builderFactory

@Nonnull
private final org.opensaml.core.xml.XMLObjectBuilderFactory builderFactory

Builder factory for XMLObjects needed in UIInfo emulation.

Constructor Detail

BasicAdministrativeFlowDescriptor

public BasicAdministrativeFlowDescriptor(@Nonnull@NotEmpty@ParameterName(name="id")
                                 String id)

Constructor.

Parameters:

id - profile Id

Method Detail

getLoggingId

@Nullable
public String getLoggingId()

Get a logging ID to use when auditing this profile.

Specified by:

getLoggingId in interface AdministrativeFlowDescriptor

Returns:

logging ID

setLoggingId

public void setLoggingId(@Nullable
                String id)

Set a logging ID to use when auditing this profile.

Parameters:

id - logging ID

isNonBrowserSupported

public boolean isNonBrowserSupported()

Get whether this flow supports non-browser clients (default is true).

Specified by:

isNonBrowserSupported in interface AdministrativeFlowDescriptor

Returns:

whether this flow supports non-browser clients

setNonBrowserSupported

public void setNonBrowserSupported(boolean isSupported)

Set whether this flow supports non-browser clients (default is true).

Parameters:

isSupported - whether this flow supports non-browser clients

setNonBrowserSupportedPredicate

public void setNonBrowserSupportedPredicate(@Nonnull
                                   Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)

Set condition to determine whether this flow supports non-browser clients.

Parameters:

condition - condition to apply

isAuthenticated

public boolean isAuthenticated()

Get whether user authentication is required (default is false).

Specified by:

isAuthenticated in interface AdministrativeFlowDescriptor

Returns:

whether user authentication is required

setAuthenticated

public void setAuthenticated(boolean flag)

Set whether user authentication is required (default is false).

Parameters:

flag - flag to set

setAuthenticatedPredicate

public void setAuthenticatedPredicate(@Nonnull
                             Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)

Set condition to determine whether user authentication is required (default is false).

Parameters:

condition - condition to apply

getUIInfo

@Nonnull
public org.opensaml.saml.ext.saml2mdui.UIInfo getUIInfo()

Get the user interface details for this profile.

Specified by:

getUIInfo in interface AdministrativeFlowDescriptor

Returns:

user interface details

setDisplayNames

public void setDisplayNames(@Nonnull@NonnullElements
                   Collection<net.shibboleth.utilities.java.support.primitive.LangBearingString> displayNames)

Set the DisplayName objects to expose via getUIInfo() via a utility class.

Parameters:

displayNames - utility class collection of language-annotated strings

setDescriptions

public void setDescriptions(@Nonnull@NonnullElements
                   Collection<net.shibboleth.utilities.java.support.primitive.LangBearingString> descriptions)

Set the Description objects to expose via getUIInfo() via a utility class.

Parameters:

descriptions - utility class collection of language-annotated strings

setLogos

public void setLogos(@Nonnull@NonnullElements
            Collection<BasicAdministrativeFlowDescriptor.Logo> logos)

Set the Logo objects to expose via getUIInfo() via a utility class.

Parameters:

logos - utility class collection of logo metadata

setInformationURLs

public void setInformationURLs(@Nonnull@NonnullElements
                      Collection<net.shibboleth.utilities.java.support.primitive.LangBearingString> urls)

Set the InformationURL objects to expose via getUIInfo() via a utility class.

Parameters:

urls - utility class collection of language-annotated strings

setPrivacyStatementURLs

public void setPrivacyStatementURLs(@Nonnull@NonnullElements
                           Collection<net.shibboleth.utilities.java.support.primitive.LangBearingString> urls)

Set the PrivacyStatementURL objects to expose via getUIInfo() via a utility class.

Parameters:

urls - utility class collection of language-annotated strings

getPolicyName

@Nullable
public String getPolicyName()

Get the access control policy for this flow.

Specified by:

getPolicyName in interface AdministrativeFlowDescriptor

Returns:

name of access control policy

setPolicyNameLookupStrategy

public void setPolicyNameLookupStrategy(@Nonnull
                               Function<org.opensaml.profile.context.ProfileRequestContext,String> strategy)

Set a lookup strategy to use to obtain the access control policy for this flow.

Parameters:

strategy - lookup strategy

setPolicyName

public void setPolicyName(@Nonnull@NotEmpty
                 String name)

Set an explicit access control policy name to apply.

Parameters:

name - policy name

resolveAttributes

public boolean resolveAttributes()

Get whether to resolve attributes during the profile (default is false).

Specified by:

resolveAttributes in interface AdministrativeFlowDescriptor

Returns:

whether to resolve attributes during the profile

setResolveAttributes

public void setResolveAttributes(boolean flag)

Set whether attributes should be resolved during the profile.

Parameters:

flag - flag to set

setResolveAttributesPredicate

public void setResolveAttributesPredicate(@Nonnull
                                 Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)

Set a condition to determine whether attributes should be resolved during the profile.

Parameters:

condition - condition to set

getInboundInterceptorFlows

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<String> getInboundInterceptorFlows()

Specified by:

getInboundInterceptorFlows in interface ProfileConfiguration

Overrides:

getInboundInterceptorFlows in class AbstractProfileConfiguration

getOutboundInterceptorFlows

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<String> getOutboundInterceptorFlows()

Specified by:

getOutboundInterceptorFlows in interface ProfileConfiguration

Overrides:

getOutboundInterceptorFlows in class AbstractProfileConfiguration

getSecurityConfiguration

@Nullable
public SecurityConfiguration getSecurityConfiguration()

Specified by:

getSecurityConfiguration in interface ProfileConfiguration

Overrides:

getSecurityConfiguration in class AbstractProfileConfiguration

getDefaultAuthenticationMethods

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<Principal> getDefaultAuthenticationMethods()

Specified by:

getDefaultAuthenticationMethods in interface AuthenticationProfileConfiguration

setDefaultAuthenticationMethods

public void setDefaultAuthenticationMethods(@Nullable@NonnullElements
                                   Collection<Principal> methods)

Set the default authentication methods to use, expressed as custom principals.

Parameters:

methods - default authentication methods to use

setDefaultAuthenticationMethodsLookupStrategy

public void setDefaultAuthenticationMethodsLookupStrategy(@Nullable
                                                 Function<org.opensaml.profile.context.ProfileRequestContext,Collection<Principal>> strategy)

Set a lookup strategy for the authentication methods to use, expressed as custom principals.

Parameters:

strategy - lookup strategy

getAuthenticationFlows

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Set<String> getAuthenticationFlows()

Specified by:

getAuthenticationFlows in interface AuthenticationProfileConfiguration

setAuthenticationFlows

public void setAuthenticationFlows(@Nullable@NonnullElements
                          Collection<String> flows)

Set the authentication flows to use.

Parameters:

flows - flow identifiers to use

setAuthenticationFlowsLookupStrategy

public void setAuthenticationFlowsLookupStrategy(@Nullable
                                        Function<org.opensaml.profile.context.ProfileRequestContext,Set<String>> strategy)

Set a lookup strategy for the authentication flows to use.

Parameters:

strategy - lookup strategy

getPostAuthenticationFlows

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<String> getPostAuthenticationFlows()

Specified by:

getPostAuthenticationFlows in interface AuthenticationProfileConfiguration

setPostAuthenticationFlows

public void setPostAuthenticationFlows(@Nullable@NonnullElements
                              Collection<String> flows)

Set the ordered collection of post-authentication interceptor flows to enable.

Parameters:

flows - flow identifiers to enable

setPostAuthenticationFlowsLookupStrategy

public void setPostAuthenticationFlowsLookupStrategy(@Nullable
                                            Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> strategy)

Set a lookup strategy for the post-authentication interceptor flows to enable.

Parameters:

strategy - lookup strategy

getNameIDFormatPrecedence

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<String> getNameIDFormatPrecedence()

Specified by:

getNameIDFormatPrecedence in interface AuthenticationProfileConfiguration

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractProfileConfiguration

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractProfileConfiguration

toString

public String toString()

Overrides:

toString in class Object