org.apereo.cas.adaptors.u2f.storage

Class BaseResourceU2FDeviceRepository

java.lang.Object

org.apereo.cas.adaptors.u2f.storage.BaseU2FDeviceRepository

org.apereo.cas.adaptors.u2f.storage.BaseResourceU2FDeviceRepository

All Implemented Interfaces:

U2FDeviceRepository

Direct Known Subclasses:

U2FGroovyResourceDeviceRepository, U2FJsonResourceDeviceRepository, U2FRestResourceDeviceRepository

public abstract class BaseResourceU2FDeviceRepository
extends BaseU2FDeviceRepository

This is BaseResourceU2FDeviceRepository.

Since:

5.2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAP_KEY_DEVICES Key in the map that indicates list of devices.

Constructor Summary

Constructors

Constructor and Description
BaseResourceU2FDeviceRepository(com.github.benmanes.caffeine.cache.LoadingCache<java.lang.String,java.lang.String> requestStorage, long expirationTime, java.util.concurrent.TimeUnit expirationTimeUnit)

Method Summary

Modifier and Type	Method and Description
void	authenticateDevice(java.lang.String username, com.yubico.u2f.data.DeviceRegistration registration) Deliver authenticated device upon successful authentication events.
void	clean() Clean up repository to remove expired records.
java.util.Collection<com.yubico.u2f.data.DeviceRegistration>	getRegisteredDevices(java.lang.String username) Gets registrations.
boolean	isDeviceRegisteredFor(java.lang.String username) Is registered ?
protected abstract java.util.Map<java.lang.String,java.util.List<U2FDeviceRegistration>>	readDevicesFromResource() Read devices from resource map.
void	registerDevice(java.lang.String username, com.yubico.u2f.data.DeviceRegistration registration) Add registration.
protected abstract void	writeDevicesBackToResource(java.util.List<U2FDeviceRegistration> list) Write devices back to resource.

Methods inherited from class org.apereo.cas.adaptors.u2f.storage.BaseU2FDeviceRepository

getDeviceAuthenticationRequest, getDeviceRegistrationRequest, requestDeviceAuthentication, requestDeviceRegistration

Methods inherited from class java.lang.Object

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

Field Detail

MAP_KEY_DEVICES

public static final java.lang.String MAP_KEY_DEVICES

Key in the map that indicates list of devices.

See Also:

Constant Field Values

Constructor Detail

BaseResourceU2FDeviceRepository

public BaseResourceU2FDeviceRepository(com.github.benmanes.caffeine.cache.LoadingCache<java.lang.String,java.lang.String> requestStorage,
                                       long expirationTime,
                                       java.util.concurrent.TimeUnit expirationTimeUnit)

Method Detail

getRegisteredDevices

public java.util.Collection<com.yubico.u2f.data.DeviceRegistration> getRegisteredDevices(java.lang.String username)

Description copied from interface: U2FDeviceRepository

Gets registrations.

Parameters:

username - the username

Returns:

the registrations

authenticateDevice

public void authenticateDevice(java.lang.String username,
                               com.yubico.u2f.data.DeviceRegistration registration)

Description copied from interface: U2FDeviceRepository

Deliver authenticated device upon successful authentication events.

Parameters:

username - the username

registration - the registration

registerDevice

public void registerDevice(java.lang.String username,
                           com.yubico.u2f.data.DeviceRegistration registration)

Description copied from interface: U2FDeviceRepository

Add registration.

Parameters:

username - the username

registration - the registration

isDeviceRegisteredFor

public boolean isDeviceRegisteredFor(java.lang.String username)

Description copied from interface: U2FDeviceRepository

Is registered ?

Parameters:

username - the username

Returns:

the boolean

clean

public void clean()

Description copied from interface: U2FDeviceRepository

Clean up repository to remove expired records.

readDevicesFromResource

protected abstract java.util.Map<java.lang.String,java.util.List<U2FDeviceRegistration>> readDevicesFromResource()
                                                                                                          throws java.lang.Exception

Read devices from resource map.

Returns:

the map

Throws:

java.lang.Exception - the exception

writeDevicesBackToResource

protected abstract void writeDevicesBackToResource(java.util.List<U2FDeviceRegistration> list)
                                            throws java.lang.Exception

Write devices back to resource. (It overrides all devices saved before)

Parameters:

list - the list of devices to write

Throws:

java.lang.Exception - the exception