com.vmware.content.library.item

Interface Storage

All Superinterfaces:

Service, StorageTypes

All Known Implementing Classes:

StorageStub

public interface Storage
extends Service, StorageTypes

Storage is a resource that represents a specific instance of a file stored on a storage backing. Unlike File, which is abstract, storage represents concrete files on the various storage backings. A file is only represented once in File, but will be represented multiple times (once for each storage backing) in Storage. The Storage interface provides information on the storage backing and the specific location of the file in that backing to privileged users who want direct access to the file on the storage medium.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.content.library.item.StorageTypes

StorageTypes.Info

Method Summary

Methods

Modifier and Type	Method and Description
List<StorageTypes.Info>	get(String libraryItemId, String fileName) Retrieves the storage information for a specific file in a library item.
void	get(String libraryItemId, String fileName, AsyncCallback<List<StorageTypes.Info>> asyncCallback) Retrieves the storage information for a specific file in a library item.
void	get(String libraryItemId, String fileName, AsyncCallback<List<StorageTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Retrieves the storage information for a specific file in a library item.
List<StorageTypes.Info>	get(String libraryItemId, String fileName, InvocationConfig invocationConfig) Retrieves the storage information for a specific file in a library item.
List<StorageTypes.Info>	list(String libraryItemId) Lists all storage items for a given library item.
void	list(String libraryItemId, AsyncCallback<List<StorageTypes.Info>> asyncCallback) Lists all storage items for a given library item.
void	list(String libraryItemId, AsyncCallback<List<StorageTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Lists all storage items for a given library item.
List<StorageTypes.Info>	list(String libraryItemId, InvocationConfig invocationConfig) Lists all storage items for a given library item.

Method Detail

get

List<StorageTypes.Info> get(String libraryItemId,
                          String fileName)

Retrieves the storage information for a specific file in a library item.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

libraryItemId - Identifier of the library item whose storage information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

fileName - Name of the file for which the storage information should be listed.

Returns:

The List of all the storage items for the given file within the given library item.

Throws:

NotFound - if the specified library item does not exist.

NotFound - if the specified file does not exist in the given library item.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.

get

List<StorageTypes.Info> get(String libraryItemId,
                          String fileName,
                          InvocationConfig invocationConfig)

Retrieves the storage information for a specific file in a library item.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

libraryItemId - Identifier of the library item whose storage information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

fileName - Name of the file for which the storage information should be listed.

invocationConfig - Configuration for the method invocation.

Returns:

The List of all the storage items for the given file within the given library item.

Throws:

NotFound - if the specified library item does not exist.

NotFound - if the specified file does not exist in the given library item.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.

get

void get(String libraryItemId,
       String fileName,
       AsyncCallback<List<StorageTypes.Info>> asyncCallback)

Retrieves the storage information for a specific file in a library item.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
The List of all the storage items for the given file within the given library item.

Operation Errors:
NotFound - if the specified library item does not exist.
NotFound - if the specified file does not exist in the given library item.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.

Parameters:

libraryItemId - Identifier of the library item whose storage information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

fileName - Name of the file for which the storage information should be listed.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(String libraryItemId,
       String fileName,
       AsyncCallback<List<StorageTypes.Info>> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves the storage information for a specific file in a library item.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
The List of all the storage items for the given file within the given library item.

Operation Errors:
NotFound - if the specified library item does not exist.
NotFound - if the specified file does not exist in the given library item.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.

Parameters:

libraryItemId - Identifier of the library item whose storage information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

fileName - Name of the file for which the storage information should be listed.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

List<StorageTypes.Info> list(String libraryItemId)

Lists all storage items for a given library item.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

libraryItemId - Identifier of the library item whose storage information should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Returns:

The List of all storage items for a given library item.

Throws:

NotFound - if the specified library item does not exist.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.

list

List<StorageTypes.Info> list(String libraryItemId,
                           InvocationConfig invocationConfig)

Lists all storage items for a given library item.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

libraryItemId - Identifier of the library item whose storage information should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

invocationConfig - Configuration for the method invocation.

Returns:

The List of all storage items for a given library item.

Throws:

NotFound - if the specified library item does not exist.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.

list

void list(String libraryItemId,
        AsyncCallback<List<StorageTypes.Info>> asyncCallback)

Lists all storage items for a given library item.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
The List of all storage items for a given library item.

Operation Errors:
NotFound - if the specified library item does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.

Parameters:

libraryItemId - Identifier of the library item whose storage information should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(String libraryItemId,
        AsyncCallback<List<StorageTypes.Info>> asyncCallback,
        InvocationConfig invocationConfig)

Lists all storage items for a given library item.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
The List of all storage items for a given library item.

Operation Errors:
NotFound - if the specified library item does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.

Parameters:

libraryItemId - Identifier of the library item whose storage information should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.