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

Class JdbcAcceptableUsagePolicyProperties

java.lang.Object

org.apereo.cas.configuration.model.support.jpa.AbstractJpaProperties

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

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-aup-jdbc")
public class JdbcAcceptableUsagePolicyProperties
extends AbstractJpaProperties

This is JdbcAcceptableUsagePolicyProperties.

Since:

6.2.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
JdbcAcceptableUsagePolicyProperties()

Method Summary

Modifier and Type	Method	Description
String	getAupColumn()	The column to store the AUP attribute.
String	getPrincipalIdAttribute()	The profile attribute to extract the value for the principalIdColumn used in the WHERE clause of sqlUpdate.
String	getPrincipalIdColumn()	The column to identify the principal.
String	getSqlSelect()	The query template to search for the AUP attribute.
String	getSqlUpdate()	The query template to update the AUP attribute.
String	getTableName()	The table name in the database that holds the AUP attribute to update for the user.
JdbcAcceptableUsagePolicyProperties	setAupColumn(String aupColumn)	The column to store the AUP attribute.
JdbcAcceptableUsagePolicyProperties	setPrincipalIdAttribute(String principalIdAttribute)	The profile attribute to extract the value for the principalIdColumn used in the WHERE clause of sqlUpdate.
JdbcAcceptableUsagePolicyProperties	setPrincipalIdColumn(String principalIdColumn)	The column to identify the principal.
JdbcAcceptableUsagePolicyProperties	setSqlSelect(String sqlSelect)	The query template to search for the AUP attribute.
JdbcAcceptableUsagePolicyProperties	setSqlUpdate(String sqlUpdate)	The query template to update the AUP attribute.
JdbcAcceptableUsagePolicyProperties	setTableName(String tableName)	The table name in the database that holds the AUP attribute to update for the user.

Methods inherited from class org.apereo.cas.configuration.model.support.jpa.AbstractJpaProperties

getBatchSize, getConnectionTimeout, getDataSourceName, getDdlAuto, getDefaultCatalog, getDefaultSchema, getDialect, getDriverClass, getFailFastTimeout, getFetchSize, getHealthQuery, getIdleTimeout, getIsolationLevelName, getLeakThreshold, getPassword, getPhysicalNamingStrategyClassName, getPool, getPropagationBehaviorName, getProperties, getUrl, getUser, isAutocommit, isGenerateStatistics, isIsolateInternalQueries, isReadOnly, setAutocommit, setBatchSize, setConnectionTimeout, setDataSourceName, setDdlAuto, setDefaultCatalog, setDefaultSchema, setDialect, setDriverClass, setFailFastTimeout, setFetchSize, setGenerateStatistics, setHealthQuery, setIdleTimeout, setIsolateInternalQueries, setIsolationLevelName, setLeakThreshold, setPassword, setPhysicalNamingStrategyClassName, setPool, setPropagationBehaviorName, setProperties, setReadOnly, setUrl, setUser

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

JdbcAcceptableUsagePolicyProperties

public JdbcAcceptableUsagePolicyProperties()

Method Details

getTableName

public String getTableName()

The table name in the database that holds the AUP attribute to update for the user.

getAupColumn

public String getAupColumn()

The column to store the AUP attribute. May differ from the profile attribute defined by AcceptableUsagePolicyCoreProperties.getAupAttributeName(). SQL query can be further customized by setting sqlUpdate.

getPrincipalIdColumn

public String getPrincipalIdColumn()

The column to identify the principal. SQL query can be further customized by setting sqlUpdate.

getPrincipalIdAttribute

public String getPrincipalIdAttribute()

The profile attribute to extract the value for the principalIdColumn used in the WHERE clause of sqlUpdate. If empty, the principal ID will be used.

getSqlUpdate

public String getSqlUpdate()

The query template to update the AUP attribute. %s placeholders represent tableName, aupColumn, principalIdColumn settings.

getSqlSelect

public String getSqlSelect()

The query template to search for the AUP attribute. %s placeholders represent aupColumn, tableName, principalIdColumn settings.

setTableName

public JdbcAcceptableUsagePolicyProperties setTableName(String tableName)

The table name in the database that holds the AUP attribute to update for the user.

Returns:

this.

setAupColumn

public JdbcAcceptableUsagePolicyProperties setAupColumn(String aupColumn)

The column to store the AUP attribute. May differ from the profile attribute defined by AcceptableUsagePolicyCoreProperties.getAupAttributeName(). SQL query can be further customized by setting sqlUpdate.

Returns:

this.

setPrincipalIdColumn

public JdbcAcceptableUsagePolicyProperties setPrincipalIdColumn(String principalIdColumn)

The column to identify the principal. SQL query can be further customized by setting sqlUpdate.

Returns:

this.

setPrincipalIdAttribute

public JdbcAcceptableUsagePolicyProperties setPrincipalIdAttribute(String principalIdAttribute)

The profile attribute to extract the value for the principalIdColumn used in the WHERE clause of sqlUpdate. If empty, the principal ID will be used.

Returns:

this.

setSqlUpdate

public JdbcAcceptableUsagePolicyProperties setSqlUpdate(String sqlUpdate)

The query template to update the AUP attribute. %s placeholders represent tableName, aupColumn, principalIdColumn settings.

Returns:

this.

setSqlSelect

public JdbcAcceptableUsagePolicyProperties setSqlSelect(String sqlSelect)

The query template to search for the AUP attribute. %s placeholders represent aupColumn, tableName, principalIdColumn settings.

Returns:

this.