org.apereo.cas.otp.repository.token

Interface OneTimeTokenRepository

All Known Implementing Classes:

BaseOneTimeTokenRepository, CachingOneTimeTokenRepository

public interface OneTimeTokenRepository

This is OneTimeTokenRepository.

Since:

5.1.0

Method Summary

Modifier and Type	Method and Description
void	clean() Clean expired/invalid tokens from the repository.
default boolean	exists(java.lang.String uid, java.lang.Integer otp) Determine if the otp for user exists in repository.
OneTimeToken	get(java.lang.String uid, java.lang.Integer opt) Get one time token.
void	store(OneTimeToken token) Store token/code in the repository, marking it as invalid to be reused again.

Method Detail

clean

void clean()

Clean expired/invalid tokens from the repository. Clean up is likely run via a scheduler.

store

void store(OneTimeToken token)

Store token/code in the repository, marking it as invalid to be reused again.

Parameters:

token - the token

exists

default boolean exists(java.lang.String uid,
                       java.lang.Integer otp)

Determine if the otp for user exists in repository.

Parameters:

uid - the uid

otp - the otp

Returns:

true /false.

get

OneTimeToken get(java.lang.String uid,
                 java.lang.Integer opt)

Get one time token.

Parameters:

uid - the uid

opt - the opt

Returns:

the one time token