com.iland.core.web.rest.api

Interface ObjectStorageResource

@Path(value="/object-storage")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface ObjectStorageResource

Object Storage Public API.

Author:

Collin Snyder

Method Summary

Modifier and Type	Method and Description
UserSessionResponse	createObjectStorageUserSession(String tenantUuid) Create an object storage user session for.
TenantKeyPairResponse	createTenantKey(String tenantUuid, TenantKeyCreateRequest tenantKeyCreateRequest) Create a new access/secret key pair for a tenant.
void	deleteTenantKey(String tenantUuid, TenantKeyDeleteRequest tenantKeyDeleteRequest) Delete an access/secret key pair for a tenant
TenantsResponse	getAllObjectStorageTenantsForCompany(String companyId, String regionId, ObjectPagingParams filters) Retrieves all Object Storage Tenants for a particular company.
BucketInfoListResponse	getBucketInfoList(String tenantUuid) Get the list of bucket info for the given tenant.
TenantResponse	getTenant(String tenantUuid) Get a tenant given it's id.
TenantKeyPairSetResponse	getTenantKeysForUser(String tenantUuid, String username) Lists access/secret key pairs for an object storage tenant and user.
UserSessionResponse	renewUserSession(String tenantUuid, String sessionToken) Renew an object storage user session.
void	syncTenant(String tenantUuid) Sync the tenant.

Method Detail

createObjectStorageUserSession

@POST
 @Path(value="/{tenantUuid}/actions/create-user-session")
UserSessionResponse createObjectStorageUserSession(@PathParam(value="tenantUuid")
                                                                                                                   String tenantUuid)

Create an object storage user session for.

Parameters:

tenantUuid - String

Returns:

UserSessionResponse

renewUserSession

@POST
 @Path(value="/{tenantUuid}/actions/renew-user-session/{sessionToken}")
UserSessionResponse renewUserSession(@PathParam(value="tenantUuid")
                                                                                                                   String tenantUuid,
                                                                                                                   @PathParam(value="sessionToken")
                                                                                                                   String sessionToken)

Renew an object storage user session.

Parameters:

tenantUuid - tenant uuid

sessionToken - session token

Returns:

user session response

getAllObjectStorageTenantsForCompany

@GET
 @Path(value="/{companyId}/{regionId}/tenants")
TenantsResponse getAllObjectStorageTenantsForCompany(@PathParam(value="companyId")
                                                                                                          String companyId,
                                                                                                          @PathParam(value="regionId")
                                                                                                          String regionId,
                                                                                                          @BeanParam
                                                                                                          ObjectPagingParams filters)

Retrieves all Object Storage Tenants for a particular company.

Parameters:

companyId - String

filters - ObjectPagingParams object paging params

Returns:

TenantsResponse

getTenantKeysForUser

@GET
 @Path(value="/{tenantUuid}/keys/{username}")
TenantKeyPairSetResponse getTenantKeysForUser(@PathParam(value="tenantUuid")
                                                                                                 String tenantUuid,
                                                                                                 @PathParam(value="username")
                                                                                                 String username)

Lists access/secret key pairs for an object storage tenant and user.

Parameters:

tenantUuid - tenant uuid

username - username

Returns:

tenant keys for username

createTenantKey

@POST
 @Path(value="/{tenantUuid}/key")
TenantKeyPairResponse createTenantKey(@PathParam(value="tenantUuid")
                                                                              String tenantUuid,
                                                                              TenantKeyCreateRequest tenantKeyCreateRequest)

Create a new access/secret key pair for a tenant.

Parameters:

tenantUuid - tenant uuid

tenantKeyCreateRequest - tenant key create request

Returns:

tenant key

deleteTenantKey

@DELETE
 @Path(value="/{tenantUuid}/key")
void deleteTenantKey(@PathParam(value="tenantUuid")
                                                               String tenantUuid,
                                                               TenantKeyDeleteRequest tenantKeyDeleteRequest)

Delete an access/secret key pair for a tenant

Parameters:

tenantUuid - tenant uuid

tenantKeyDeleteRequest - tenant key delete request

getBucketInfoList

@GET
 @Path(value="/{tenantUuid}/bucket-info")
BucketInfoListResponse getBucketInfoList(@PathParam(value="tenantUuid")
                                                                                        String tenantUuid)

Get the list of bucket info for the given tenant.

Parameters:

tenantUuid - tenant uuid

Returns:

list of bucket info

getTenant

@GET
 @Path(value="/{tenantUuid}")
TenantResponse getTenant(@PathParam(value="tenantUuid")
                                                            String tenantUuid)

Get a tenant given it's id.

Parameters:

tenantUuid - tenant uuid

Returns:

a tenant response

syncTenant

@POST
 @Path(value="/{tenantUuid}/sync")
void syncTenant(@PathParam(value="tenantUuid")
                                                         String tenantUuid)

Sync the tenant.

Parameters:

tenantUuid - tenant uuid