Package net.shibboleth.idp.cas.config

Class LoginConfiguration

  • All Implemented Interfaces:
    net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration, net.shibboleth.idp.profile.config.ConditionalProfileConfiguration, net.shibboleth.idp.profile.config.ProfileConfiguration, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent
    public class LoginConfiguration
extends AbstractProtocolConfiguration
implements net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration
    CAS protocol configuration that applies to the /login URI.

    • Field Detail

      • DEFAULT_TICKET_PREFIX

        @Nonnull
@NotEmpty
public static final String DEFAULT_TICKET_PREFIX
        Default ticket prefix.
        See Also:
        Constant Field Values

      • DEFAULT_TICKET_LENGTH

        public static final int DEFAULT_TICKET_LENGTH
        Default ticket length (random part).
        See Also:
        Constant Field Values

      • authenticationFlowsLookupStrategy

        @Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,​Set<String>> authenticationFlowsLookupStrategy
        Lookup function to supply authenticationFlows property.

      • postAuthenticationFlowsLookupStrategy

        @Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,​Collection<String>> postAuthenticationFlowsLookupStrategy
        Lookup function to supply postAuthenticationFlows property.

      • defaultAuthenticationContextsLookupStrategy

        @Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,​Collection<net.shibboleth.idp.saml.authn.principal.AuthnContextClassRefPrincipal>> defaultAuthenticationContextsLookupStrategy
        Lookup function to supply defaultAuthenticationContexts property.

      • forceAuthnPredicate

        @Nonnull
private Predicate<org.opensaml.profile.context.ProfileRequestContext> forceAuthnPredicate
        Whether to mandate forced authentication for the request.

      • proxyCountLookupStrategy

        @Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,​Integer> proxyCountLookupStrategy
        Lookup function to supply proxyCount property.

    • Constructor Detail

      • LoginConfiguration

        public LoginConfiguration()
        Creates a new instance.

    • Method Detail

      • getDefaultAuthenticationMethods

        @Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<Principal> getDefaultAuthenticationMethods​(@Nullable
                                                       org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
        Specified by:
        getDefaultAuthenticationMethods in interface net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration

      • setDefaultAuthenticationMethods

        public void setDefaultAuthenticationMethods​(@Nullable @NonnullElements
                                            Collection<net.shibboleth.idp.saml.authn.principal.AuthnContextClassRefPrincipal> contexts)
        Set the default authentication contexts to use, expressed as custom principals.
        Parameters:
        contexts - default authentication contexts to use

      • setDefaultAuthenticationMethodsLookupStrategy

        public void setDefaultAuthenticationMethodsLookupStrategy​(@Nonnull
                                                          Function<org.opensaml.profile.context.ProfileRequestContext,​Collection<net.shibboleth.idp.saml.authn.principal.AuthnContextClassRefPrincipal>> strategy)
        Set a lookup strategy for the default authentication contexts to use.
        Parameters:
        strategy - lookup strategy

      • getAuthenticationFlows

        @Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Set<String> getAuthenticationFlows​(@Nullable
                                          org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
        Specified by:
        getAuthenticationFlows in interface net.shibboleth.idp.authn.config.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​(@Nonnull
                                                 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​(@Nullable
                                               org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
        Specified by:
        getPostAuthenticationFlows in interface net.shibboleth.idp.authn.config.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​(@Nonnull
                                                     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

      • isForceAuthn

        public boolean isForceAuthn​(@Nullable
                            org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
        Specified by:
        isForceAuthn in interface net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration

      • setForceAuthn

        public void setForceAuthn​(boolean flag)
        Set whether a fresh user presence proof should be required for this request.
        Parameters:
        flag - flag to set

      • setForceAuthnPredicate

        public void setForceAuthnPredicate​(@Nonnull
                                   Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)
        Set a condition to determine whether a fresh user presence proof should be required for this request.
        Parameters:
        condition - condition to set

      • getProxyCount

        @Nullable
public Integer getProxyCount​(@Nullable
                             org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
        Specified by:
        getProxyCount in interface net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration

      • setProxyCount

        public void setProxyCount​(@Nullable @NonNegative
                          Integer count)
        Sets the maximum number of times an assertion may be proxied outbound and/or the maximum number of hops between the relying party and a proxied authentication authority inbound.
        Parameters:
        count - proxy count
        Since:
        4.0.0

      • setProxyCountLookupStrategy

        public void setProxyCountLookupStrategy​(@Nonnull
                                        Function<org.opensaml.profile.context.ProfileRequestContext,​Integer> strategy)
        Set a lookup strategy for the maximum number of times an assertion may be proxied outbound and/or the maximum number of hops between the relying party and a proxied authentication authority inbound.
        Parameters:
        strategy - lookup strategy
        Since:
        4.0.0