Package com.iland.core.web.rest.api

Interface ObjectStorageResource

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

Object Storage Public API.

Author:

Collin Snyder

Method Summary

Modifier and Type	Method	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 Details

createObjectStorageUserSession

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

Create an object storage user session for.

Parameters:

tenantUuid - String

Returns:

UserSessionResponse

renewUserSession

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

Renew an object storage user session.

Parameters:

tenantUuid - tenant uuid

sessionToken - session token

Returns:

user session response

getAllObjectStorageTenantsForCompany

@GET
@Path("/{companyId}/{regionId}/tenants")
TenantsResponse getAllObjectStorageTenantsForCompany(@PathParam("companyId")
 String companyId,
 @PathParam("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("/{tenantUuid}/keys/{username}")
TenantKeyPairSetResponse getTenantKeysForUser(@PathParam("tenantUuid")
 String tenantUuid,
 @PathParam("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("/{tenantUuid}/key")
TenantKeyPairResponse createTenantKey(@PathParam("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("/{tenantUuid}/key")
void deleteTenantKey(@PathParam("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("/{tenantUuid}/bucket-info")
BucketInfoListResponse getBucketInfoList(@PathParam("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("/{tenantUuid}")
TenantResponse getTenant(@PathParam("tenantUuid")
 String tenantUuid)

Get a tenant given it's id.

Parameters:

tenantUuid - tenant uuid

Returns:

a tenant response

syncTenant

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

Sync the tenant.

Parameters:

tenantUuid - tenant uuid