Package org.rostore.client

Class ApiKeys

java.lang.Object
org.rostore.client.ApiKeys
public class ApiKeys extends Object
Class is used to access and modify the api keys on the storage.

  • Constructor Details

  • Method Details

    • listApiKeys

      public StringKeyList listApiKeys(String continuationKey)
      Lists all api keys.

      The returning object is not complete. Check the StringKeyList.isMore() if this is the case.

      Use StringKeyList.getContinuationKey() to the the continuationKey for the next call to get the next pack of keys.

      Parameters:
      continuationKey - is either continuation key to get the next package or null for the first call
      Returns:
      the object is not complete, to check if more data is available use StringKeyList.isMore()

    • post

      public VersionedObject<String,org.rostore.entity.apikey.ApiKeyPermissions> post(VersionedObject<String,org.rostore.entity.apikey.ApiKeyPermissions> apiKeyPermissions)
      Creates a new api-key and associate the permissions with it
      Parameters:
      apiKeyPermissions - the api-key and associated permissions
      Returns:
      versioned object containing permissions

    • get

      public VersionedObject<String,org.rostore.entity.apikey.ApiKeyPermissions> get(String key)
      Get the api-key permissions by the key
      Parameters:
      key - the api-key
      Returns:
      versioned object containing permissions

    • put

      public VersionedObject<String,org.rostore.entity.apikey.ApiKeyPermissions> put(VersionedObject<String,org.rostore.entity.apikey.ApiKeyPermissions> apiKeyPermissions)
      Updates given api-key
      Parameters:
      apiKeyPermissions - object to update
      Returns:
      the updated version