org.jbei.ice.lib.account

Class UserApiKeys

java.lang.Object

org.jbei.ice.lib.account.UserApiKeys

public class UserApiKeys
extends Object

API keys generated by users

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
UserApiKeys(String userId)

Method Summary

Modifier and Type	Method and Description
boolean	deleteKey(long id, String secret) Deletes an api key
Results<AccessKey>	getKeys(int limit, int offset, String sortField, boolean asc, boolean getAvailable) Retrieves either list of available keys for current user or all keys.
AccessKey	requestKey(String clientId) Generates an access key using the client identifier

Methods inherited from class java.lang.Object

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

Constructor Detail

UserApiKeys

public UserApiKeys(String userId)

Method Detail

requestKey

public AccessKey requestKey(String clientId)

Generates an access key using the client identifier

Parameters:

clientId - unique client identifier.

Returns:

wrapper around created token, client_id and secret.

The api token that is generated and returned to the user is not stored and therefore cannot be retrieved. If lost, the api key record can be deleted by the user who created it (or an admin) and a new one created.

getKeys

public Results<AccessKey> getKeys(int limit,
                                  int offset,
                                  String sortField,
                                  boolean asc,
                                  boolean getAvailable)

Retrieves either list of available keys for current user or all keys. If requesting all keys then user must be an administrator

Parameters:

limit - maximum number of keys to retrieve

offset - paging parameter start

sortField - field to sort on

asc - whether the retrieve order is in ascending order

getAvailable - whether to retrieve all available keys or restrict by current user

Returns:

wrapper around list of retrieved keys including number available

Throws:

PermissionException - if getAvailable is true but user making the request does not have administrative privileges

deleteKey

public boolean deleteKey(long id,
                         String secret)

Deletes an api key

Parameters:

id - unique database identifier for the key

secret - unique key secret

Returns:

true if the key is successfully deleted. false otherwise, including if the key cannot be found

Throws:

PermissionException - if the key being deleted does not belong to user and user does not have administrative privileges