org.apereo.cas.services

Class AbstractRegisteredServiceAttributeReleasePolicy

java.lang.Object

org.apereo.cas.services.AbstractRegisteredServiceAttributeReleasePolicy

All Implemented Interfaces:

java.io.Serializable, RegisteredServiceAttributeReleasePolicy

Direct Known Subclasses:

BaseOidcScopeAttributeReleasePolicy, DenyAllAttributeReleasePolicy, GroovyScriptAttributeReleasePolicy, ReturnAllAttributeReleasePolicy, ReturnAllowedAttributeReleasePolicy, ReturnMappedAttributeReleasePolicy, ScriptedRegisteredServiceAttributeReleasePolicy, WSFederationClaimsReleasePolicy

public abstract class AbstractRegisteredServiceAttributeReleasePolicy
extends java.lang.Object
implements RegisteredServiceAttributeReleasePolicy

Abstract release policy for attributes, provides common shared settings such as loggers and attribute filter config. Subclasses are to provide the behavior for attribute retrieval.

Since:

4.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractRegisteredServiceAttributeReleasePolicy()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
RegisteredServiceAttributeFilter	getAttributeFilter()
java.util.Map<java.lang.String,java.lang.Object>	getAttributes(Principal principal, Service selectedService, RegisteredService registeredService) Gets the attributes, having applied the filter.
protected abstract java.util.Map<java.lang.String,java.lang.Object>	getAttributesInternal(Principal principal, java.util.Map<java.lang.String,java.lang.Object> attributes, RegisteredService service) Gets the attributes internally from the implementation.
PrincipalAttributesRepository	getPrincipalAttributesRepository()
java.lang.String	getPrincipalIdAttribute()
protected java.util.Map<java.lang.String,java.lang.Object>	getReleasedByDefaultAttributes(Principal p, java.util.Map<java.lang.String,java.lang.Object> attributes) Determines a default bundle of attributes that may be released to all services without the explicit mapping for each service.
int	hashCode()
protected void	insertPrincipalIdAsAttributeIfNeeded(Principal principal, java.util.Map<java.lang.String,java.lang.Object> attributesToRelease, Service service, RegisteredService registeredService) Release principal id as attribute if needed.
boolean	isAuthorizedToReleaseCredentialPassword() Is authorized to release credential password?
boolean	isAuthorizedToReleaseProxyGrantingTicket() Is authorized to release proxy granting ticket?
boolean	isExcludeDefaultAttributes()
protected java.util.Map<java.lang.String,java.lang.Object>	returnFinalAttributesCollection(java.util.Map<java.lang.String,java.lang.Object> attributesToRelease, RegisteredService service) Return the final attributes collection.
void	setAttributeFilter(RegisteredServiceAttributeFilter filter) Sets the attribute filter.
void	setAuthorizedToReleaseCredentialPassword(boolean authorizedToReleaseCredentialPassword)
void	setAuthorizedToReleaseProxyGrantingTicket(boolean authorizedToReleaseProxyGrantingTicket)
void	setExcludeDefaultAttributes(boolean excludeDefaultAttributes)
void	setPrincipalAttributesRepository(PrincipalAttributesRepository repository)
void	setPrincipalIdAttribute(java.lang.String principalIdAttribute)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRegisteredServiceAttributeReleasePolicy

public AbstractRegisteredServiceAttributeReleasePolicy()

Method Detail

setAttributeFilter

public void setAttributeFilter(RegisteredServiceAttributeFilter filter)

Description copied from interface: RegisteredServiceAttributeReleasePolicy

Sets the attribute filter.

Specified by:

setAttributeFilter in interface RegisteredServiceAttributeReleasePolicy

Parameters:

filter - the new attribute filter

setPrincipalAttributesRepository

public void setPrincipalAttributesRepository(PrincipalAttributesRepository repository)

getPrincipalAttributesRepository

public PrincipalAttributesRepository getPrincipalAttributesRepository()

getAttributeFilter

public RegisteredServiceAttributeFilter getAttributeFilter()

getPrincipalIdAttribute

public java.lang.String getPrincipalIdAttribute()

setPrincipalIdAttribute

public void setPrincipalIdAttribute(java.lang.String principalIdAttribute)

isAuthorizedToReleaseCredentialPassword

public boolean isAuthorizedToReleaseCredentialPassword()

Description copied from interface: RegisteredServiceAttributeReleasePolicy

Is authorized to release credential password?

Specified by:

isAuthorizedToReleaseCredentialPassword in interface RegisteredServiceAttributeReleasePolicy

Returns:

true /false

isAuthorizedToReleaseProxyGrantingTicket

public boolean isAuthorizedToReleaseProxyGrantingTicket()

Description copied from interface: RegisteredServiceAttributeReleasePolicy

Is authorized to release proxy granting ticket?

Specified by:

isAuthorizedToReleaseProxyGrantingTicket in interface RegisteredServiceAttributeReleasePolicy

Returns:

true /false

setAuthorizedToReleaseCredentialPassword

public void setAuthorizedToReleaseCredentialPassword(boolean authorizedToReleaseCredentialPassword)

setAuthorizedToReleaseProxyGrantingTicket

public void setAuthorizedToReleaseProxyGrantingTicket(boolean authorizedToReleaseProxyGrantingTicket)

isExcludeDefaultAttributes

public boolean isExcludeDefaultAttributes()

setExcludeDefaultAttributes

public void setExcludeDefaultAttributes(boolean excludeDefaultAttributes)

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes(Principal principal,
                                                                      Service selectedService,
                                                                      RegisteredService registeredService)

Description copied from interface: RegisteredServiceAttributeReleasePolicy

Gets the attributes, having applied the filter.

Specified by:

getAttributes in interface RegisteredServiceAttributeReleasePolicy

Parameters:

principal - the principal that contains the resolved attributes

selectedService - the selected service

registeredService - the service

Returns:

the attributes

insertPrincipalIdAsAttributeIfNeeded

protected void insertPrincipalIdAsAttributeIfNeeded(Principal principal,
                                                    java.util.Map<java.lang.String,java.lang.Object> attributesToRelease,
                                                    Service service,
                                                    RegisteredService registeredService)

Release principal id as attribute if needed.

Parameters:

principal - the principal

attributesToRelease - the attributes to release

service - the service

registeredService - the registered service

returnFinalAttributesCollection

protected java.util.Map<java.lang.String,java.lang.Object> returnFinalAttributesCollection(java.util.Map<java.lang.String,java.lang.Object> attributesToRelease,
                                                                                           RegisteredService service)

Return the final attributes collection. Subclasses may override this minute to impose last minute rules.

Parameters:

attributesToRelease - the attributes to release

service - the service

Returns:

the map

getReleasedByDefaultAttributes

protected java.util.Map<java.lang.String,java.lang.Object> getReleasedByDefaultAttributes(Principal p,
                                                                                          java.util.Map<java.lang.String,java.lang.Object> attributes)

Determines a default bundle of attributes that may be released to all services without the explicit mapping for each service.

Parameters:

p - the principal

attributes - the attributes

Returns:

the released by default attributes

getAttributesInternal

protected abstract java.util.Map<java.lang.String,java.lang.Object> getAttributesInternal(Principal principal,
                                                                                          java.util.Map<java.lang.String,java.lang.Object> attributes,
                                                                                          RegisteredService service)

Gets the attributes internally from the implementation.

Parameters:

principal - the principal

attributes - the principal attributes

service - the service

Returns:

the attributes allowed for release

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object