net.shibboleth.idp.tou.storage

Interface Storage

All Known Implementing Classes:

CacheStorage, JDBCStorage

public interface Storage

Storage interface for terms of use.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsToUAcceptance(String userId, String version) Checks if the storage contains a terms of use acceptance for a specific user.
void	createToUAcceptance(String userId, TOUAcceptance touAcceptance) Creates a terms of use acceptance.
TOUAcceptance	readToUAcceptance(String userId, String version) Reads a terms of use acceptance.
void	updateToUAcceptance(String userId, TOUAcceptance touAcceptance) Updates a terms of use acceptance.

Method Detail

createToUAcceptance

void createToUAcceptance(String userId,
                       TOUAcceptance touAcceptance)

Creates a terms of use acceptance.

Parameters:

userId - The user id.

touAcceptance - terms of use acceptance.

updateToUAcceptance

void updateToUAcceptance(String userId,
                       TOUAcceptance touAcceptance)

Updates a terms of use acceptance.

Parameters:

userId - The user id.

touAcceptance - terms of use acceptance.

readToUAcceptance

TOUAcceptance readToUAcceptance(String userId,
                              String version)

Reads a terms of use acceptance.

Parameters:

userId - The user id.

version - Terms of use version.

Returns:

Returns a terms of use acceptance, might be empty but never null.

containsToUAcceptance

boolean containsToUAcceptance(String userId,
                            String version)

Checks if the storage contains a terms of use acceptance for a specific user.

Parameters:

userId - The user id.

version - Terms of use version.

Returns:

Returns true if the storage contains the terms of use acceptance, false otherwise.