Package org.apereo.cas.configuration.model.core.authentication

Class AuthenticationAttributeReleaseProperties

java.lang.Object

org.apereo.cas.configuration.model.core.authentication.AuthenticationAttributeReleaseProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-support-validation",
                automated=true)
public class AuthenticationAttributeReleaseProperties
extends Object
implements Serializable

Authentication attribute release properties.

Since:

5.2.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationAttributeReleaseProperties()

Method Summary

Modifier and Type	Method	Description
List<String>	getNeverRelease()	List of authentication attributes that should never be released.
List<String>	getOnlyRelease()	List of authentication attributes that should be the only ones released.
boolean	isEnabled()	Whether authentication or protocol attributes should be released to clients.
AuthenticationAttributeReleaseProperties	setEnabled(boolean enabled)	Whether authentication or protocol attributes should be released to clients.
AuthenticationAttributeReleaseProperties	setNeverRelease(List<String> neverRelease)	List of authentication attributes that should never be released.
AuthenticationAttributeReleaseProperties	setOnlyRelease(List<String> onlyRelease)	List of authentication attributes that should be the only ones released.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AuthenticationAttributeReleaseProperties

public AuthenticationAttributeReleaseProperties()

Method Details

isEnabled

public boolean isEnabled()

Whether authentication or protocol attributes should be released to clients. This flag specifically address non-principal attributes, or otherwise attributes that carry metadata about the authentication event itself that are not strictly tied to a principal or person data. The change here should consider such attributes regardless of the specific protocol or authentication flow (CAS, OIDC, etc).

getNeverRelease

public List<String> getNeverRelease()

List of authentication attributes that should never be released.

getOnlyRelease

public List<String> getOnlyRelease()

List of authentication attributes that should be the only ones released. An empty list indicates all attributes should be released.

setEnabled

public AuthenticationAttributeReleaseProperties setEnabled(boolean enabled)

Whether authentication or protocol attributes should be released to clients. This flag specifically address non-principal attributes, or otherwise attributes that carry metadata about the authentication event itself that are not strictly tied to a principal or person data. The change here should consider such attributes regardless of the specific protocol or authentication flow (CAS, OIDC, etc).

Returns:

this.

setNeverRelease

public AuthenticationAttributeReleaseProperties setNeverRelease(List<String> neverRelease)

List of authentication attributes that should never be released.

Returns:

this.

setOnlyRelease

public AuthenticationAttributeReleaseProperties setOnlyRelease(List<String> onlyRelease)

List of authentication attributes that should be the only ones released. An empty list indicates all attributes should be released.

Returns:

this.