Package org.apereo.cas.web.flow

Interface SingleSignOnParticipationStrategy

All Superinterfaces:

org.springframework.core.Ordered

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SingleSignOnParticipationStrategy
extends org.springframework.core.Ordered

This is SingleSignOnParticipationStrategy.

Since:

5.2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BEAN_NAME	Default implementation bean name.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
static SingleSignOnParticipationStrategy	alwaysParticipating()	Always participating single sign on participation strategy.
default String	getName()	Returns the friendly name of this strategy.
default int	getOrder()
default org.apereo.cas.configuration.support.TriStateBoolean	isCreateCookieOnRenewedAuthentication(SingleSignOnParticipationRequest context)	Is creating single sign on session cookie on renewed authentication?
boolean	isParticipating(SingleSignOnParticipationRequest ssoRequest)	Tries to determine if this request should participate in SSO.
static SingleSignOnParticipationStrategy	neverParticipating()	Never participating single sign on participation strategy.
default boolean	supports(SingleSignOnParticipationRequest ssoRequest)	Does strategy support this request or not?

Field Details

BEAN_NAME

static final String BEAN_NAME

Default implementation bean name.

See Also:

• Constant Field Values

Method Details

alwaysParticipating

static SingleSignOnParticipationStrategy alwaysParticipating()

Always participating single sign on participation strategy.

Returns:

the single sign on participation strategy

neverParticipating

static SingleSignOnParticipationStrategy neverParticipating()

Never participating single sign on participation strategy.

Returns:

the single sign on participation strategy

isParticipating

boolean isParticipating(SingleSignOnParticipationRequest ssoRequest)
                 throws Throwable

Tries to determine if this request should participate in SSO. Services can opt out of SSO conditionally either per policy or per request parameters. Various internal processes in CAS also try to determine whether SSO should be honored for this request.

Parameters:

ssoRequest - the request

Returns:

true if authn is renewed

Throws:

Throwable - the throwable

supports

default boolean supports(SingleSignOnParticipationRequest ssoRequest)

Does strategy support this request or not?

Parameters:

ssoRequest - the context

Returns:

true/false

getOrder

default int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

isCreateCookieOnRenewedAuthentication

default org.apereo.cas.configuration.support.TriStateBoolean isCreateCookieOnRenewedAuthentication(SingleSignOnParticipationRequest context)

Is creating single sign on session cookie on renewed authentication?

Parameters:

context - the context

Returns:

true/false

getName

default String getName()

Returns the friendly name of this strategy.

Returns:

the name.

Since:

6.4.0