org.apereo.cas.services

Interface RegisteredServiceAttributeReleasePolicy

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractRegisteredServiceAttributeReleasePolicy, BaseOidcScopeAttributeReleasePolicy, BaseSamlRegisteredServiceAttributeReleasePolicy, ChainingAttributeReleasePolicy, DenyAllAttributeReleasePolicy, GroovySamlRegisteredServiceAttributeReleasePolicy, GroovyScriptAttributeReleasePolicy, InCommonRSAttributeReleasePolicy, MetadataEntityAttributesAttributeReleasePolicy, MetadataRequestedAttributesAttributeReleasePolicy, OidcAddressScopeAttributeReleasePolicy, OidcCustomScopeAttributeReleasePolicy, OidcEmailScopeAttributeReleasePolicy, OidcPhoneScopeAttributeReleasePolicy, OidcProfileScopeAttributeReleasePolicy, PatternMatchingEntityIdAttributeReleasePolicy, ReturnAllAttributeReleasePolicy, ReturnAllowedAttributeReleasePolicy, ReturnMappedAttributeReleasePolicy, ReturnRestfulAttributeReleasePolicy, ScriptedRegisteredServiceAttributeReleasePolicy, WSFederationClaimsReleasePolicy

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 RegisteredServiceAttributeReleasePolicy
extends java.io.Serializable

The release policy that decides how attributes are to be released for a given service. Each policy has the ability to apply an optional filter.

Since:

4.1.0

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAttributes(Principal p, Service selectedService, RegisteredService service) Gets the attributes, having applied the filter.
default java.util.Map<java.lang.String,java.lang.Object>	getConsentableAttributes(Principal p, Service selectedService, RegisteredService service) Gets the attributes that qualify for consent.
default boolean	isAuthorizedToReleaseAuthenticationAttributes() Is authorized to release authentication attributes boolean.
default boolean	isAuthorizedToReleaseCredentialPassword() Is authorized to release credential password?
default boolean	isAuthorizedToReleaseProxyGrantingTicket() Is authorized to release proxy granting ticket?
default void	setAttributeFilter(RegisteredServiceAttributeFilter filter) Sets the attribute filter.

Method Detail

isAuthorizedToReleaseAuthenticationAttributes

default boolean isAuthorizedToReleaseAuthenticationAttributes()

Is authorized to release authentication attributes boolean.

Returns:

the boolean

isAuthorizedToReleaseCredentialPassword

default boolean isAuthorizedToReleaseCredentialPassword()

Is authorized to release credential password?

Returns:

true /false

isAuthorizedToReleaseProxyGrantingTicket

default boolean isAuthorizedToReleaseProxyGrantingTicket()

Is authorized to release proxy granting ticket?

Returns:

true /false

setAttributeFilter

default void setAttributeFilter(RegisteredServiceAttributeFilter filter)

Sets the attribute filter.

Parameters:

filter - the new attribute filter

getAttributes

java.util.Map<java.lang.String,java.lang.Object> getAttributes(Principal p,
                                                               Service selectedService,
                                                               RegisteredService service)

Gets the attributes, having applied the filter.

Parameters:

p - the principal that contains the resolved attributes

selectedService - the selected service

service - the service

Returns:

the attributes

getConsentableAttributes

default java.util.Map<java.lang.String,java.lang.Object> getConsentableAttributes(Principal p,
                                                                                  Service selectedService,
                                                                                  RegisteredService service)

Gets the attributes that qualify for consent.

Parameters:

p - the principal that contains the resolved attributes

selectedService - the selected service

service - the service

Returns:

the attributes