com.vmware.content.library.item.downloadsession

Interface File

All Superinterfaces:

FileTypes, Service

All Known Implementing Classes:

FileStub

public interface File
extends Service, FileTypes

The File interface provides methods for accessing files within a download session.

After a download session is created against a library item, the File interface can be used to retrieve all downloadable content within the library item. Since the content may not be available immediately in a downloadable form on the server side, the client will have to prepare the file and wait for the file status to become FileTypes.PrepareStatus.PREPARED.

See DownloadSession.

Nested Class Summary

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

FileTypes.EndpointType, FileTypes.Info, FileTypes.PrepareStatus

Method Summary

Methods

Modifier and Type	Method and Description
FileTypes.Info	get(java.lang.String downloadSessionId, java.lang.String fileName) Retrieves file download information for a specific file.
void	get(java.lang.String downloadSessionId, java.lang.String fileName, AsyncCallback<FileTypes.Info> asyncCallback) Retrieves file download information for a specific file.
void	get(java.lang.String downloadSessionId, java.lang.String fileName, AsyncCallback<FileTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves file download information for a specific file.
FileTypes.Info	get(java.lang.String downloadSessionId, java.lang.String fileName, InvocationConfig invocationConfig) Retrieves file download information for a specific file.
java.util.List<FileTypes.Info>	list(java.lang.String downloadSessionId) Lists the information of all the files in the library item associated with the download session.
void	list(java.lang.String downloadSessionId, AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback) Lists the information of all the files in the library item associated with the download session.
void	list(java.lang.String downloadSessionId, AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Lists the information of all the files in the library item associated with the download session.
java.util.List<FileTypes.Info>	list(java.lang.String downloadSessionId, InvocationConfig invocationConfig) Lists the information of all the files in the library item associated with the download session.
FileTypes.Info	prepare(java.lang.String downloadSessionId, java.lang.String fileName, FileTypes.EndpointType endpointType) Requests a file to be prepared for download.
void	prepare(java.lang.String downloadSessionId, java.lang.String fileName, FileTypes.EndpointType endpointType, AsyncCallback<FileTypes.Info> asyncCallback) Requests a file to be prepared for download.
void	prepare(java.lang.String downloadSessionId, java.lang.String fileName, FileTypes.EndpointType endpointType, AsyncCallback<FileTypes.Info> asyncCallback, InvocationConfig invocationConfig) Requests a file to be prepared for download.
FileTypes.Info	prepare(java.lang.String downloadSessionId, java.lang.String fileName, FileTypes.EndpointType endpointType, InvocationConfig invocationConfig) Requests a file to be prepared for download.

Method Detail

list

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

Lists the information of all the files in the library item associated with the download session.

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

Parameters:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

Returns:

The List of FileTypes.Info instances.

Throws:

NotFound - if the download session associated with downloadSessionId doesn't 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 downloadSessionId,
                                  InvocationConfig invocationConfig)

Lists the information of all the files in the library item associated with the download session.

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:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

invocationConfig - Configuration for the method invocation.

Returns:

The List of FileTypes.Info instances.

Throws:

NotFound - if the download session associated with downloadSessionId doesn't 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 downloadSessionId,
        AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback)

Lists the information of all the files in the library item associated with the download session.

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

Operation Result:
The List of FileTypes.Info instances.

Operation Errors:
NotFound - if the download session associated with downloadSessionId doesn't 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:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

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

list

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

Lists the information of all the files in the library item associated with the download session.

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 FileTypes.Info instances.

Operation Errors:
NotFound - if the download session associated with downloadSessionId doesn't 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:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

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

invocationConfig - Configuration for the method invocation.

prepare

FileTypes.Info prepare(java.lang.String downloadSessionId,
                     java.lang.String fileName,
                     FileTypes.EndpointType endpointType)

Requests a file to be prepared for download.

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

Parameters:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

fileName - Name of the file requested for download.

endpointType - Endpoint type request, one of HTTPS, DIRECT. This will determine the type of the FileTypes.Info.getDownloadEndpoint() that is generated when the file is prepared. The FileTypes.EndpointType.DIRECT is only available to users who have the ContentLibrary.ReadStorage privilege. If not specified the default is FileTypes.EndpointType.HTTPS.

Returns:

File information containing the status of the request and the download link to the file.

Throws:

NotFound - if the download session does not exist.

InvalidArgument - if there is no file with the specified fileName.

Unauthorized - if the the download session wasn't created with the ContentLibrary.ReadStorage privilege and the caller requested a FileTypes.EndpointType.DIRECT endpoint type.

prepare

FileTypes.Info prepare(java.lang.String downloadSessionId,
                     java.lang.String fileName,
                     FileTypes.EndpointType endpointType,
                     InvocationConfig invocationConfig)

Requests a file to be prepared for download.

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:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

fileName - Name of the file requested for download.

endpointType - Endpoint type request, one of HTTPS, DIRECT. This will determine the type of the FileTypes.Info.getDownloadEndpoint() that is generated when the file is prepared. The FileTypes.EndpointType.DIRECT is only available to users who have the ContentLibrary.ReadStorage privilege. If not specified the default is FileTypes.EndpointType.HTTPS.

invocationConfig - Configuration for the method invocation.

Returns:

File information containing the status of the request and the download link to the file.

Throws:

NotFound - if the download session does not exist.

InvalidArgument - if there is no file with the specified fileName.

Unauthorized - if the the download session wasn't created with the ContentLibrary.ReadStorage privilege and the caller requested a FileTypes.EndpointType.DIRECT endpoint type.

prepare

void prepare(java.lang.String downloadSessionId,
           java.lang.String fileName,
           FileTypes.EndpointType endpointType,
           AsyncCallback<FileTypes.Info> asyncCallback)

Requests a file to be prepared for download.

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

Operation Result:
File information containing the status of the request and the download link to the file.

Operation Errors:
NotFound - if the download session does not exist.
InvalidArgument - if there is no file with the specified fileName.
Unauthorized - if the the download session wasn't created with the ContentLibrary.ReadStorage privilege and the caller requested a FileTypes.EndpointType.DIRECT endpoint type.

Parameters:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

fileName - Name of the file requested for download.

endpointType - Endpoint type request, one of HTTPS, DIRECT. This will determine the type of the FileTypes.Info.getDownloadEndpoint() that is generated when the file is prepared. The FileTypes.EndpointType.DIRECT is only available to users who have the ContentLibrary.ReadStorage privilege. If not specified the default is FileTypes.EndpointType.HTTPS.

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

prepare

void prepare(java.lang.String downloadSessionId,
           java.lang.String fileName,
           FileTypes.EndpointType endpointType,
           AsyncCallback<FileTypes.Info> asyncCallback,
           InvocationConfig invocationConfig)

Requests a file to be prepared for download.

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:
File information containing the status of the request and the download link to the file.

Operation Errors:
NotFound - if the download session does not exist.
InvalidArgument - if there is no file with the specified fileName.
Unauthorized - if the the download session wasn't created with the ContentLibrary.ReadStorage privilege and the caller requested a FileTypes.EndpointType.DIRECT endpoint type.

Parameters:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

fileName - Name of the file requested for download.

endpointType - Endpoint type request, one of HTTPS, DIRECT. This will determine the type of the FileTypes.Info.getDownloadEndpoint() that is generated when the file is prepared. The FileTypes.EndpointType.DIRECT is only available to users who have the ContentLibrary.ReadStorage privilege. If not specified the default is FileTypes.EndpointType.HTTPS.

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

invocationConfig - Configuration for the method invocation.

get

FileTypes.Info get(java.lang.String downloadSessionId,
                 java.lang.String fileName)

Retrieves file download information for a specific file.

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

Parameters:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

fileName - Name of the file requested.

Returns:

The FileTypes.Info instance containing the status of the file and its download link if available.

Throws:

NotFound - if the download session associated with downloadSessionId does not exist.

InvalidArgument - if there is no file with the specified fileName.

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 downloadSessionId,
                 java.lang.String fileName,
                 InvocationConfig invocationConfig)

Retrieves file download information for a specific file.

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:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

fileName - Name of the file requested.

invocationConfig - Configuration for the method invocation.

Returns:

The FileTypes.Info instance containing the status of the file and its download link if available.

Throws:

NotFound - if the download session associated with downloadSessionId does not exist.

InvalidArgument - if there is no file with the specified fileName.

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 downloadSessionId,
       java.lang.String fileName,
       AsyncCallback<FileTypes.Info> asyncCallback)

Retrieves file download information for a specific file.

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

Operation Result:
The FileTypes.Info instance containing the status of the file and its download link if available.

Operation Errors:
NotFound - if the download session associated with downloadSessionId does not exist.
InvalidArgument - if there is no file with the specified fileName.
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:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

fileName - Name of the file requested.

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

get

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

Retrieves file download information for a specific file.

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 FileTypes.Info instance containing the status of the file and its download link if available.

Operation Errors:
NotFound - if the download session associated with downloadSessionId does not exist.
InvalidArgument - if there is no file with the specified fileName.
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:

downloadSessionId - Identifier of the download session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

fileName - Name of the file requested.

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

invocationConfig - Configuration for the method invocation.