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:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule
CasFeatureModule.FeatureCatalog
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAUP attribute to choose in order to determine whether policy has been accepted or not.AUP attribute to choose whose single value dictates how CAS should fetch the policy terms from the relevant message bundles.boolean
By default, the policy status is considered as denied when the attributeaupAttributeName
is not found.boolean
Allows AUP to be turned off on startup.setAupAttributeName
(String aupAttributeName) AUP attribute to choose in order to determine whether policy has been accepted or not.setAupOmitIfAttributeMissing
(boolean aupOmitIfAttributeMissing) By default, the policy status is considered as denied when the attributeaupAttributeName
is not found.setAupPolicyTermsAttributeName
(String aupPolicyTermsAttributeName) AUP attribute to choose whose single value dictates how CAS should fetch the policy terms from the relevant message bundles.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
AUP attribute to choose in order to determine whether policy has been accepted or not. The attribute is expected to contain a boolean value wheretrue
indicates policy has been accepted andfalse
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
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 attributeaupAttributeName
is not found. If set totrue
, the policy status in those cases is considered as accepted. -
setEnabled
Allows AUP to be turned off on startup.- Returns:
this
.
-
setAupAttributeName
AUP attribute to choose in order to determine whether policy has been accepted or not. The attribute is expected to contain a boolean value wheretrue
indicates policy has been accepted andfalse
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 attributeaupAttributeName
is not found. If set totrue
, the policy status in those cases is considered as accepted.- Returns:
this
.
-