com.vmware.content.library.item

Interface File

All Superinterfaces:

FileTypes, Service

All Known Implementing Classes:

FileStub

public interface File
extends Service, FileTypes

The File interface can be used to query for information on the files within a library item. Files are objects which are added to a library item through the UpdateSession and File interfaces.

Nested Class Summary

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

FileTypes.ChecksumAlgorithm, FileTypes.ChecksumInfo, FileTypes.Info

Field Summary

Fields inherited from interface com.vmware.content.library.item.FileTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
FileTypes.Info	get(java.lang.String libraryItemId, java.lang.String name) Retrieves the information for a single file in a library item by its name.
void	get(java.lang.String libraryItemId, java.lang.String name, AsyncCallback<FileTypes.Info> asyncCallback) Retrieves the information for a single file in a library item by its name.
void	get(java.lang.String libraryItemId, java.lang.String name, AsyncCallback<FileTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves the information for a single file in a library item by its name.
FileTypes.Info	get(java.lang.String libraryItemId, java.lang.String name, InvocationConfig invocationConfig) Retrieves the information for a single file in a library item by its name.
java.util.List<FileTypes.Info>	list(java.lang.String libraryItemId) Lists all of the files that are stored within a given library item.
void	list(java.lang.String libraryItemId, AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback) Lists all of the files that are stored within a given library item.
void	list(java.lang.String libraryItemId, AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Lists all of the files that are stored within a given library item.
java.util.List<FileTypes.Info>	list(java.lang.String libraryItemId, InvocationConfig invocationConfig) Lists all of the files that are stored within a given library item.

Method Detail

get

FileTypes.Info get(java.lang.String libraryItemId,
                   java.lang.String name)

Retrieves the information for a single file in a library item by its name.

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

Parameters:

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

name - Name of the file in the library item whose information should be returned.

Returns:

The FileTypes.Info object with information on the specified file.

Throws:

NotFound - if libraryItemId refers to a library item that does not exist.

NotFound - if name refers to a file that does not exist in the 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 System.Read.

get

FileTypes.Info get(java.lang.String libraryItemId,
                   java.lang.String name,
                   InvocationConfig invocationConfig)

Retrieves the information for a single file in a library item by its name.

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 file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

name - Name of the file in the library item whose information should be returned.

invocationConfig - Configuration for the method invocation.

Returns:

The FileTypes.Info object with information on the specified file.

Throws:

NotFound - if libraryItemId refers to a library item that does not exist.

NotFound - if name refers to a file that does not exist in the 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 System.Read.

get

void get(java.lang.String libraryItemId,
         java.lang.String name,
         AsyncCallback<FileTypes.Info> asyncCallback)

Retrieves the information for a single file in a library item by its name.

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

Invocation Result:
The FileTypes.Info object with information on the specified file.

Operation Errors:
NotFound - if libraryItemId refers to a library item that does not exist.
NotFound - if name refers to a file that does not exist in the 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 System.Read.

Parameters:

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

name - Name of the file in the library item whose information should be returned.

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

get

void get(java.lang.String libraryItemId,
         java.lang.String name,
         AsyncCallback<FileTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Retrieves the information for a single file in a library item by its name.

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

Invocation Result:
The FileTypes.Info object with information on the specified file.

Operation Errors:
NotFound - if libraryItemId refers to a library item that does not exist.
NotFound - if name refers to a file that does not exist in the 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 System.Read.

Parameters:

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

name - Name of the file in the library item whose information should be returned.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<FileTypes.Info> list(java.lang.String libraryItemId)

Lists all of the files that are stored within 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 files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Returns:

The List of all of the files that are stored within the given library item.

Throws:

NotFound - if libraryItemId refers to a library item that 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 System.Read.

list

java.util.List<FileTypes.Info> list(java.lang.String libraryItemId,
                                    InvocationConfig invocationConfig)

Lists all of the files that are stored within 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 files 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 of the files that are stored within the given library item.

Throws:

NotFound - if libraryItemId refers to a library item that 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 System.Read.

list

void list(java.lang.String libraryItemId,
          AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback)

Lists all of the files that are stored within a given library item.

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

Invocation Result:
The List of all of the files that are stored within the given library item.

Operation Errors:
NotFound - if libraryItemId refers to a library item that 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 System.Read.

Parameters:

libraryItemId - Identifier of the library item whose files 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(java.lang.String libraryItemId,
          AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback,
          InvocationConfig invocationConfig)

Lists all of the files that are stored within 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.

Invocation Result:
The List of all of the files that are stored within the given library item.

Operation Errors:
NotFound - if libraryItemId refers to a library item that 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 System.Read.

Parameters:

libraryItemId - Identifier of the library item whose files 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.