org.jbei.ice.storage.hibernate.dao

Class ApiKeyDAO

java.lang.Object

org.jbei.ice.storage.hibernate.HibernateRepository<ApiKey>

org.jbei.ice.storage.hibernate.dao.ApiKeyDAO

All Implemented Interfaces:

IRepository<ApiKey>

public class ApiKeyDAO
extends HibernateRepository<ApiKey>

Data Accessor object for retrieving ApiKey objects

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
ApiKeyDAO()

Method Summary

Modifier and Type	Method and Description
ApiKey	get(long id)
List<ApiKey>	getAllApiKeys(String sort, int limit, int start, boolean asc) Retrieves all available api keys restricted by the paging parameters
long	getApiKeysCount(String userId) Retrieves the maximum number of api keys that can be retrieved for a specified user
List<ApiKey>	getApiKeysForUser(String userId, String sort, int limit, int start, boolean asc) Retrieves list of available api keys for specified user, using the paging parameters
Optional<ApiKey>	getByClientId(String clientId) Retrieves an api key by client id.

Methods inherited from class org.jbei.ice.storage.hibernate.HibernateRepository

create, currentSession, delete, get, getBuilder, update

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiKeyDAO

public ApiKeyDAO()

Method Detail

get

public ApiKey get(long id)

getApiKeysForUser

public List<ApiKey> getApiKeysForUser(String userId,
                                      String sort,
                                      int limit,
                                      int start,
                                      boolean asc)

Retrieves list of available api keys for specified user, using the paging parameters

Parameters:

userId - unique identifier for user whose keys are being retrieved

sort - sort field

limit - paging limit

start - paging start

asc - sort field ascending

Returns:

list of available matching keys

getAllApiKeys

public List<ApiKey> getAllApiKeys(String sort,
                                  int limit,
                                  int start,
                                  boolean asc)

Retrieves all available api keys restricted by the paging parameters

Parameters:

sort - sort field

limit - paging limit

start - paging start

asc - sort field ascending

Returns:

list of available matching keys

getApiKeysCount

public long getApiKeysCount(String userId)

Retrieves the maximum number of api keys that can be retrieved for a specified user

Parameters:

userId - unique user identifier

Returns:

number of available api keys that match the restrictions

getByClientId

public Optional<ApiKey> getByClientId(String clientId)

Retrieves an api key by client id. If one exists it is expected that the client id + the creator id uniquely retrieves it. In other words, the same user cannot have two api keys for the same client

Parameters:

clientId - client identifier for api key

Returns:

container that may or may not contain the found key

Throws:

DAOException - if more that one api key is found or there is a problem accessing the database