Package net.shibboleth.idp.cas.config

Class AbstractProtocolConfiguration

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.profile.config.AbstractProfileConfiguration

net.shibboleth.idp.profile.config.AbstractConditionalProfileConfiguration

net.shibboleth.idp.cas.config.AbstractProtocolConfiguration

All Implemented Interfaces:

ConditionalProfileConfiguration, ProfileConfiguration, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

LoginConfiguration, ProxyConfiguration, ValidateConfiguration

public abstract class AbstractProtocolConfiguration
extends AbstractConditionalProfileConfiguration
implements InitializableComponent

Base class for CAS protocol configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static Duration	DEFAULT_TICKET_VALIDITY_PERIOD	Default ticket validity.
private SecurityConfiguration	defaultSecurityConfiguration	Holds default security config object to use.
static String	PROTOCOL_URI	CAS base protocol URI.
private Predicate<ProfileRequestContext>	resolveAttributesPredicate	Whether attributes should be resolved in the course of the profile.
private Function<ProfileRequestContext,Duration>	ticketValidityPeriodLookupStrategy	Lookup function to supply ticketValidityPeriod property.

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

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Constructor	Description
AbstractProtocolConfiguration(String profileId)	Creates a new configuration instance.

Method Summary

Modifier and Type	Method	Description
protected abstract int	getDefaultTicketLength()	Get default ticket length.
protected abstract String	getDefaultTicketPrefix()	Get default ticket prefix.
SecurityConfiguration	getSecurityConfiguration(ProfileRequestContext profileRequestContext)
Duration	getTicketValidityPeriod(ProfileRequestContext profileRequestContext)	Get ticket validity period.
boolean	isResolveAttributes(ProfileRequestContext profileRequestContext)	Get whether attributes should be resolved during the profile (defaults to true).
void	setResolveAttributes(boolean flag)	Set whether attributes should be resolved during the profile.
void	setResolveAttributesPredicate(Predicate<ProfileRequestContext> condition)	Set a condition to determine whether attributes should be resolved during the profile.
void	setTicketValidityPeriod(Duration ticketTTL)	Sets the ticket validity period.
void	setTicketValidityPeriodLookupStrategy(Function<ProfileRequestContext,Duration> strategy)	Set a lookup strategy for the ticket validity period.

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

getActivationCondition, setActivationCondition

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

equals, getDisallowedFeatures, getInboundInterceptorFlows, getOutboundInterceptorFlows, hashCode, isFeatureDisallowed, setDisallowedFeatures, setDisallowedFeaturesLookupStrategy, setInboundFlowsLookupStrategy, setInboundInterceptorFlows, setOutboundFlowsLookupStrategy, setOutboundInterceptorFlows, setSecurityConfiguration, setSecurityConfigurationLookupStrategy

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.idp.profile.config.ProfileConfiguration

getInboundInterceptorFlows, getOutboundInterceptorFlows

Field Detail

PROTOCOL_URI

@Nonnull
@NotEmpty
public static final String PROTOCOL_URI

CAS base protocol URI.

See Also:

Constant Field Values

DEFAULT_TICKET_VALIDITY_PERIOD

@Nonnull
public static final Duration DEFAULT_TICKET_VALIDITY_PERIOD

Default ticket validity.

ticketValidityPeriodLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Duration> ticketValidityPeriodLookupStrategy

Lookup function to supply ticketValidityPeriod property.

resolveAttributesPredicate

@Nonnull
private Predicate<ProfileRequestContext> resolveAttributesPredicate

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

defaultSecurityConfiguration

@Nonnull
private final SecurityConfiguration defaultSecurityConfiguration

Holds default security config object to use.

Constructor Detail

AbstractProtocolConfiguration

public AbstractProtocolConfiguration(@Nonnull @NotEmpty
                                     String profileId)

Creates a new configuration instance.

Parameters:

profileId - Unique profile identifier

Method Detail

getSecurityConfiguration

@Nullable
public SecurityConfiguration getSecurityConfiguration(@Nullable
                                                      ProfileRequestContext profileRequestContext)

Specified by:

getSecurityConfiguration in interface ProfileConfiguration

Overrides:

getSecurityConfiguration in class AbstractProfileConfiguration

getTicketValidityPeriod

@Nonnull
public Duration getTicketValidityPeriod(@Nullable
                                        ProfileRequestContext profileRequestContext)

Get ticket validity period.

Parameters:

profileRequestContext - current profile request context

Returns:

ticket validity period

setTicketValidityPeriod

public void setTicketValidityPeriod(@Nonnull
                                    Duration ticketTTL)

Sets the ticket validity period.

Parameters:

ticketTTL - ticket validity period

setTicketValidityPeriodLookupStrategy

public void setTicketValidityPeriodLookupStrategy(@Nonnull
                                                  Function<ProfileRequestContext,Duration> strategy)

Set a lookup strategy for the ticket validity period.

Parameters:

strategy - lookup strategy

Since:

3.3.0

isResolveAttributes

public boolean isResolveAttributes(@Nullable
                                   ProfileRequestContext profileRequestContext)

Get whether attributes should be resolved during the profile (defaults to true).

Parameters:

profileRequestContext - current profile request context

Returns:

true iff attributes should be resolved

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<ProfileRequestContext> condition)

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

Parameters:

condition - condition to set

Since:

3.3.0

getDefaultTicketPrefix

@Nonnull
@NotEmpty
protected abstract String getDefaultTicketPrefix()

Get default ticket prefix.

Returns:

prefix

getDefaultTicketLength

protected abstract int getDefaultTicketLength()

Get default ticket length.

Returns:

length