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

Class OAuthCodeProperties

java.lang.Object

org.apereo.cas.configuration.model.support.oauth.OAuthCodeProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-support-oauth")
public class OAuthCodeProperties
extends Object
implements Serializable

This is OAuthCodeProperties.

Since:

5.2.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OAuthCodeProperties()

Method Summary

Modifier and Type	Method	Description
int	getNumberOfUses()	Number of times this code is valid and can be used.
String	getStorageName()	The storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation.
long	getTimeToKillInSeconds()	Duration in seconds where the code is valid.
boolean	isRemoveRelatedAccessTokens()	Remove the related access tokens when trying to use a code which is expired or no longer exists.
OAuthCodeProperties	setNumberOfUses(int numberOfUses)	Number of times this code is valid and can be used.
OAuthCodeProperties	setRemoveRelatedAccessTokens(boolean removeRelatedAccessTokens)	Remove the related access tokens when trying to use a code which is expired or no longer exists.
OAuthCodeProperties	setStorageName(String storageName)	The storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation.
OAuthCodeProperties	setTimeToKillInSeconds(long timeToKillInSeconds)	Duration in seconds where the code is valid.

Methods inherited from class java.lang.Object

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

Constructor Details

OAuthCodeProperties

public OAuthCodeProperties()

Method Details

getNumberOfUses

public int getNumberOfUses()

Number of times this code is valid and can be used.

getTimeToKillInSeconds

public long getTimeToKillInSeconds()

Duration in seconds where the code is valid.

getStorageName

public String getStorageName()

The storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation.

isRemoveRelatedAccessTokens

public boolean isRemoveRelatedAccessTokens()

Remove the related access tokens when trying to use a code which is expired or no longer exists.

setNumberOfUses

public OAuthCodeProperties setNumberOfUses(int numberOfUses)

Number of times this code is valid and can be used.

Returns:

this.

setTimeToKillInSeconds

public OAuthCodeProperties setTimeToKillInSeconds(long timeToKillInSeconds)

Duration in seconds where the code is valid.

Returns:

this.

setStorageName

public OAuthCodeProperties setStorageName(String storageName)

The storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation.

Returns:

this.

setRemoveRelatedAccessTokens

public OAuthCodeProperties setRemoveRelatedAccessTokens(boolean removeRelatedAccessTokens)

Remove the related access tokens when trying to use a code which is expired or no longer exists.

Returns:

this.