Package org.apereo.cas.configuration.model.support.aup

Class AcceptableUsagePolicyCoreProperties

java.lang.Object

org.apereo.cas.configuration.model.support.aup.AcceptableUsagePolicyCoreProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-aup-webflow")
public class AcceptableUsagePolicyCoreProperties
extends Object
implements Serializable, CasFeatureModule

This is AcceptableUsagePolicyCoreProperties.

Since:

5.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

CasFeatureModule.FeatureCatalog

Constructor Summary

Constructors

Constructor	Description
AcceptableUsagePolicyCoreProperties()

Method Summary

Modifier and Type	Method	Description
String	getAupAttributeName()	AUP attribute to choose in order to determine whether policy has been accepted or not.
String	getAupPolicyTermsAttributeName()	AUP attribute to choose whose single value dictates how CAS should fetch the policy terms from the relevant message bundles.
boolean	isAupOmitIfAttributeMissing()	By default, the policy status is considered as denied when the attribute aupAttributeName is not found.
boolean	isEnabled()	Allows AUP to be turned off on startup.
AcceptableUsagePolicyCoreProperties	setAupAttributeName(String aupAttributeName)	AUP attribute to choose in order to determine whether policy has been accepted or not.
AcceptableUsagePolicyCoreProperties	setAupOmitIfAttributeMissing(boolean aupOmitIfAttributeMissing)	By default, the policy status is considered as denied when the attribute aupAttributeName is not found.
AcceptableUsagePolicyCoreProperties	setAupPolicyTermsAttributeName(String aupPolicyTermsAttributeName)	AUP attribute to choose whose single value dictates how CAS should fetch the policy terms from the relevant message bundles.
AcceptableUsagePolicyCoreProperties	setEnabled(boolean enabled)	Allows AUP to be turned off on startup.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

isDefined, isUndefined

Constructor Details

AcceptableUsagePolicyCoreProperties

public AcceptableUsagePolicyCoreProperties()

Method Details

isEnabled

public boolean isEnabled()

Allows AUP to be turned off on startup.

getAupAttributeName

public String getAupAttributeName()

AUP attribute to choose in order to determine whether policy has been accepted or not. The attribute is expected to contain a boolean value where true indicates policy has been accepted and false indicates otherwise. The attribute is fetched for the principal from configured sources and compared for the right match to determine policy status. If the attribute is not found, the policy status is considered as denied.

getAupPolicyTermsAttributeName

public String getAupPolicyTermsAttributeName()

AUP attribute to choose whose single value dictates how CAS should fetch the policy terms from the relevant message bundles.

isAupOmitIfAttributeMissing

public boolean isAupOmitIfAttributeMissing()

By default, the policy status is considered as denied when the attribute aupAttributeName is not found. If set to true, the policy status in those cases is considered as accepted.

setEnabled

public AcceptableUsagePolicyCoreProperties setEnabled(boolean enabled)

Allows AUP to be turned off on startup.

Returns:

this.

setAupAttributeName

public AcceptableUsagePolicyCoreProperties setAupAttributeName(String aupAttributeName)

AUP attribute to choose in order to determine whether policy has been accepted or not. The attribute is expected to contain a boolean value where true indicates policy has been accepted and false indicates otherwise. The attribute is fetched for the principal from configured sources and compared for the right match to determine policy status. If the attribute is not found, the policy status is considered as denied.

Returns:

this.

setAupPolicyTermsAttributeName

public AcceptableUsagePolicyCoreProperties setAupPolicyTermsAttributeName(String aupPolicyTermsAttributeName)

AUP attribute to choose whose single value dictates how CAS should fetch the policy terms from the relevant message bundles.

Returns:

this.

setAupOmitIfAttributeMissing

public AcceptableUsagePolicyCoreProperties setAupOmitIfAttributeMissing(boolean aupOmitIfAttributeMissing)

By default, the policy status is considered as denied when the attribute aupAttributeName is not found. If set to true, the policy status in those cases is considered as accepted.

Returns:

this.