org.duracloud.durastore.rest
Class SpaceResource

java.lang.Object
  org.duracloud.durastore.rest.SpaceResource

public class SpaceResource
extends java.lang.Object

Provides interaction with spaces

Author:

Bill Branan

Field Summary

protected static org.slf4j.Logger

log

Constructor Summary

SpaceResource()

Method Summary

static void	addSpace(java.lang.String spaceID, java.lang.String spaceAccess, java.util.Map<java.lang.String,java.lang.String> userMetadata, java.lang.String storeID) Adds a space.
static void	deleteSpace(java.lang.String spaceID, java.lang.String storeID) Deletes a space, removing all included content.
static java.lang.String	getSpaceContents(java.lang.String spaceID, java.lang.String storeID, java.lang.String prefix, long maxResults, java.lang.String marker) Gets a listing of the contents of a space.
static java.util.Map<java.lang.String,java.lang.String>	getSpaceMetadata(java.lang.String spaceID, java.lang.String storeID) Gets the metadata of a space.
static java.lang.String	getSpaces(java.lang.String storeID) Provides a listing of all spaces for a customer.
static void	updateSpaceMetadata(java.lang.String spaceID, java.lang.String spaceAccess, java.util.Map<java.lang.String,java.lang.String> userMetadata, java.lang.String storeID) Updates the metadata of a space.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

Constructor Detail

SpaceResource

public SpaceResource()

Method Detail

getSpaces

public static java.lang.String getSpaces(java.lang.String storeID)
                                  throws ResourceException

Provides a listing of all spaces for a customer. Open spaces are always included in the list, closed spaces are included based on user authorization.

Parameters:

storeID -

Returns:

XML listing of spaces

Throws:

ResourceException

getSpaceMetadata

public static java.util.Map<java.lang.String,java.lang.String> getSpaceMetadata(java.lang.String spaceID,
                                                                                java.lang.String storeID)
                                                                         throws ResourceException

Gets the metadata of a space.

Parameters:

spaceID -

storeID -

Returns:

Map of space metadata

Throws:

ResourceException

getSpaceContents

public static java.lang.String getSpaceContents(java.lang.String spaceID,
                                                java.lang.String storeID,
                                                java.lang.String prefix,
                                                long maxResults,
                                                java.lang.String marker)
                                         throws ResourceException

Gets a listing of the contents of a space.

Parameters:

spaceID -

storeID -

prefix -

maxResults -

marker -

Returns:

XML listing of space contents

Throws:

ResourceException

addSpace

public static void addSpace(java.lang.String spaceID,
                            java.lang.String spaceAccess,
                            java.util.Map<java.lang.String,java.lang.String> userMetadata,
                            java.lang.String storeID)
                     throws ResourceException,
                            InvalidIdException

Adds a space.

Parameters:

spaceID -

spaceAccess -

userMetadata -

storeID -

Throws:

ResourceException

InvalidIdException

updateSpaceMetadata

public static void updateSpaceMetadata(java.lang.String spaceID,
                                       java.lang.String spaceAccess,
                                       java.util.Map<java.lang.String,java.lang.String> userMetadata,
                                       java.lang.String storeID)
                                throws ResourceException

Updates the metadata of a space.

Parameters:

spaceID -

spaceAccess -

userMetadata -

storeID -

Throws:

ResourceException

deleteSpace

public static void deleteSpace(java.lang.String spaceID,
                               java.lang.String storeID)
                        throws ResourceException

Deletes a space, removing all included content.

Parameters:

spaceID -

storeID -

Throws:

ResourceException