net.shibboleth.idp.attribute.consent.storage

Interface Storage

All Known Implementing Classes:

CacheStorage, JDBCStorage

public interface Storage

Storage interface for user consent.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsAttributeRelease(String userId, String relyingPartyId, String attributeId) Checks if the storage contains a attribute release for a specific user, relying party and attribute.
boolean	containsUser(String userId) Checks if the storage contains a user.
void	createAttributeRelease(String userId, String relyingPartyId, AttributeRelease attributeRelease) Creates an attribute releases for a specific user and relying party.
void	createUser(User user) Creates a user.
void	deleteAttributeReleases(String userId, String relyingPartyId) Deletes the attribute releases from the storage for a specific user and relying party.
Collection<AttributeRelease>	readAttributeReleases(String userId, String relyingPartyId) Reads the attribute releases from the storage for a specific user and relying party.
User	readUser(String userId) Reads a user from the storage.
void	updateAttributeRelease(String userId, String relyingPartyId, AttributeRelease attributeRelease) Updates the attribute releases for a specific user and relying party.
void	updateUser(User user) Updates a user.

Method Detail

containsUser

boolean containsUser(String userId)

Checks if the storage contains a user.

Parameters:

userId - The user id.

Returns:

Returns true if the storage contains the user, false otherwise.

readUser

User readUser(String userId)

Reads a user from the storage.

Parameters:

userId - The user id.

Returns:

Returns the user for the given user id or null if user is not available.

updateUser

void updateUser(User user)

Updates a user.

Parameters:

user - The user.

createUser

void createUser(User user)

Creates a user.

Parameters:

user - The user.

readAttributeReleases

Collection<AttributeRelease> readAttributeReleases(String userId,
                                                 String relyingPartyId)

Reads the attribute releases from the storage for a specific user and relying party.

Parameters:

userId - The user id.

relyingPartyId - The relying party id.

Returns:

Returns a collection of attribute releases, might be empty but never null.

deleteAttributeReleases

void deleteAttributeReleases(String userId,
                           String relyingPartyId)

Deletes the attribute releases from the storage for a specific user and relying party.

Parameters:

userId - The user id.

relyingPartyId - The relying party id.

containsAttributeRelease

boolean containsAttributeRelease(String userId,
                               String relyingPartyId,
                               String attributeId)

Checks if the storage contains a attribute release for a specific user, relying party and attribute.

Parameters:

userId - The user id.

relyingPartyId - The relying party id.

attributeId - attribute id.

Returns:

Returns true if the storage contains the attribute release, false otherwise.

updateAttributeRelease

void updateAttributeRelease(String userId,
                          String relyingPartyId,
                          AttributeRelease attributeRelease)

Updates the attribute releases for a specific user and relying party.

Parameters:

userId - The user id.

relyingPartyId - The relying party id.

attributeRelease - The attribute release.

createAttributeRelease

void createAttributeRelease(String userId,
                          String relyingPartyId,
                          AttributeRelease attributeRelease)

Creates an attribute releases for a specific user and relying party.

Parameters:

userId - The user id.

relyingPartyId - The relying party id.

attributeRelease - The attribute release.