com.vmware.content.library.item

Interface DownloadSession

All Superinterfaces:

DownloadSessionTypes, Service

All Known Implementing Classes:

DownloadSessionStub

public interface DownloadSession
extends Service, DownloadSessionTypes

The DownloadSession interface manipulates download sessions, which are used to download content from the Content Library Service.

A download session is an object that tracks the download of content (that is, downloading content from the Content Library Service) and acts as a lease to keep the download links available.

The File interface provides access to the download links.

Field Summary

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

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(String downloadSessionId) Cancels the download session.
void	cancel(String downloadSessionId, AsyncCallback<Void> asyncCallback) Cancels the download session.
void	cancel(String downloadSessionId, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Cancels the download session.
void	cancel(String downloadSessionId, InvocationConfig invocationConfig) Cancels the download session.
String	create(String clientToken, DownloadSessionModel createSpec) Creates a new download session.
void	create(String clientToken, DownloadSessionModel createSpec, AsyncCallback<String> asyncCallback) Creates a new download session.
void	create(String clientToken, DownloadSessionModel createSpec, AsyncCallback<String> asyncCallback, InvocationConfig invocationConfig) Creates a new download session.
String	create(String clientToken, DownloadSessionModel createSpec, InvocationConfig invocationConfig) Creates a new download session.
void	delete(String downloadSessionId) Deletes a download session.
void	delete(String downloadSessionId, AsyncCallback<Void> asyncCallback) Deletes a download session.
void	delete(String downloadSessionId, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Deletes a download session.
void	delete(String downloadSessionId, InvocationConfig invocationConfig) Deletes a download session.
void	fail(String downloadSessionId, String clientErrorMessage) Terminates the download session with a client specified error message.
void	fail(String downloadSessionId, String clientErrorMessage, AsyncCallback<Void> asyncCallback) Terminates the download session with a client specified error message.
void	fail(String downloadSessionId, String clientErrorMessage, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Terminates the download session with a client specified error message.
void	fail(String downloadSessionId, String clientErrorMessage, InvocationConfig invocationConfig) Terminates the download session with a client specified error message.
DownloadSessionModel	get(String downloadSessionId) Gets the download session with the specified identifier, including the most up-to-date status information for the session.
void	get(String downloadSessionId, AsyncCallback<DownloadSessionModel> asyncCallback) Gets the download session with the specified identifier, including the most up-to-date status information for the session.
void	get(String downloadSessionId, AsyncCallback<DownloadSessionModel> asyncCallback, InvocationConfig invocationConfig) Gets the download session with the specified identifier, including the most up-to-date status information for the session.
DownloadSessionModel	get(String downloadSessionId, InvocationConfig invocationConfig) Gets the download session with the specified identifier, including the most up-to-date status information for the session.
void	keepAlive(String downloadSessionId, Long progress) Keeps a download session alive.
void	keepAlive(String downloadSessionId, Long progress, AsyncCallback<Void> asyncCallback) Keeps a download session alive.
void	keepAlive(String downloadSessionId, Long progress, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Keeps a download session alive.
void	keepAlive(String downloadSessionId, Long progress, InvocationConfig invocationConfig) Keeps a download session alive.
List<String>	list(String libraryItemId) Lists the identifiers of the download sessions created by the calling user.
void	list(String libraryItemId, AsyncCallback<List<String>> asyncCallback) Lists the identifiers of the download sessions created by the calling user.
void	list(String libraryItemId, AsyncCallback<List<String>> asyncCallback, InvocationConfig invocationConfig) Lists the identifiers of the download sessions created by the calling user.
List<String>	list(String libraryItemId, InvocationConfig invocationConfig) Lists the identifiers of the download sessions created by the calling user.

Method Detail

create

String create(String clientToken,
            DownloadSessionModel createSpec)

Creates a new download session.

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

Parameters:

clientToken - A unique token generated by the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.

createSpec - Specification for the new download session to be created.

Returns:

Identifier of the new download session being created. The return value will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

Throws:

InvalidArgument - if the session specification is not valid.

InvalidArgument - format.

NotFound - if the library item targeted by the download 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 property DownloadSessionModel.getLibraryItemId() requires ContentLibrary.DownloadSession.

create

String create(String clientToken,
            DownloadSessionModel createSpec,
            InvocationConfig invocationConfig)

Creates a new 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:

clientToken - A unique token generated by the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.

createSpec - Specification for the new download session to be created.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the new download session being created. The return value will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

Throws:

InvalidArgument - if the session specification is not valid.

InvalidArgument - format.

NotFound - if the library item targeted by the download 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 property DownloadSessionModel.getLibraryItemId() requires ContentLibrary.DownloadSession.

create

void create(String clientToken,
          DownloadSessionModel createSpec,
          AsyncCallback<String> asyncCallback)

Creates a new download session.

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

Operation Result:
Identifier of the new download session being created. The return value will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

Operation Errors:
InvalidArgument - if the session specification is not valid.
InvalidArgument - format.
NotFound - if the library item targeted by the download 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 property DownloadSessionModel.getLibraryItemId() requires ContentLibrary.DownloadSession.

Parameters:

clientToken - A unique token generated by the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.

createSpec - Specification for the new download session to be created.

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

create

void create(String clientToken,
          DownloadSessionModel createSpec,
          AsyncCallback<String> asyncCallback,
          InvocationConfig invocationConfig)

Creates a new 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:
Identifier of the new download session being created. The return value will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

Operation Errors:
InvalidArgument - if the session specification is not valid.
InvalidArgument - format.
NotFound - if the library item targeted by the download 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 property DownloadSessionModel.getLibraryItemId() requires ContentLibrary.DownloadSession.

Parameters:

clientToken - A unique token generated by the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.

createSpec - Specification for the new download session to be created.

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

invocationConfig - Configuration for the method invocation.

get

DownloadSessionModel get(String downloadSessionId)

Gets the download session with the specified identifier, including the most up-to-date status information for the session.

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

Parameters:

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

Returns:

The DownloadSessionModel instance with the given downloadSessionId.

Throws:

NotFound - if no download session with the given downloadSessionId exists.

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

• Method execution requires System.Anonymous.

get

DownloadSessionModel get(String downloadSessionId,
                       InvocationConfig invocationConfig)

Gets the download session with the specified identifier, including the most up-to-date status information for the 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 to retrieve. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

invocationConfig - Configuration for the method invocation.

Returns:

The DownloadSessionModel instance with the given downloadSessionId.

Throws:

NotFound - if no download session with the given downloadSessionId exists.

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

• Method execution requires System.Anonymous.

get

void get(String downloadSessionId,
       AsyncCallback<DownloadSessionModel> asyncCallback)

Gets the download session with the specified identifier, including the most up-to-date status information for the session.

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

Operation Result:
The DownloadSessionModel instance with the given downloadSessionId.

Operation Errors:
NotFound - if no download session with the given downloadSessionId exists.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

downloadSessionId - Identifier of the download session to retrieve. 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.

get

void get(String downloadSessionId,
       AsyncCallback<DownloadSessionModel> asyncCallback,
       InvocationConfig invocationConfig)

Gets the download session with the specified identifier, including the most up-to-date status information for the 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 DownloadSessionModel instance with the given downloadSessionId.

Operation Errors:
NotFound - if no download session with the given downloadSessionId exists.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

downloadSessionId - Identifier of the download session to retrieve. 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.

list

List<String> list(String libraryItemId)

Lists the identifiers of the download sessions created by the calling user. Optionally may filter by library item.

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

Parameters:

libraryItemId - Library item identifier on which to filter results. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. If not specified all download session identifiers are listed.

Returns:

The List of identifiers of all download sessions created by the calling user. The return value will contain identifiers for the resource type: com.vmware.content.library.item.DownloadSession.

Throws:

NotFound - if a library item identifier is given for an item which does not exist.

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

• The resource com.vmware.content.library.item.DownloadSession referenced by the parameter libraryItemId requires ContentLibrary.DownloadSession.

list

List<String> list(String libraryItemId,
                InvocationConfig invocationConfig)

Lists the identifiers of the download sessions created by the calling user. Optionally may filter by 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 - Library item identifier on which to filter results. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. If not specified all download session identifiers are listed.

invocationConfig - Configuration for the method invocation.

Returns:

The List of identifiers of all download sessions created by the calling user. The return value will contain identifiers for the resource type: com.vmware.content.library.item.DownloadSession.

Throws:

NotFound - if a library item identifier is given for an item which does not exist.

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

• The resource com.vmware.content.library.item.DownloadSession referenced by the parameter libraryItemId requires ContentLibrary.DownloadSession.

list

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

Lists the identifiers of the download sessions created by the calling user. Optionally may filter by library item.

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

Operation Result:
The List of identifiers of all download sessions created by the calling user. The return value will contain identifiers for the resource type: com.vmware.content.library.item.DownloadSession.

Operation Errors:
NotFound - if a library item identifier is given for an item which does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.item.DownloadSession referenced by the parameter libraryItemId requires ContentLibrary.DownloadSession.

Parameters:

libraryItemId - Library item identifier on which to filter results. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. If not specified all download session identifiers are listed.

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

list

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

Lists the identifiers of the download sessions created by the calling user. Optionally may filter by 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 identifiers of all download sessions created by the calling user. The return value will contain identifiers for the resource type: com.vmware.content.library.item.DownloadSession.

Operation Errors:
NotFound - if a library item identifier is given for an item which does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.item.DownloadSession referenced by the parameter libraryItemId requires ContentLibrary.DownloadSession.

Parameters:

libraryItemId - Library item identifier on which to filter results. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. If not specified all download session identifiers are listed.

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

invocationConfig - Configuration for the method invocation.

keepAlive

void keepAlive(String downloadSessionId,
             Long progress)

Keeps a download session alive. This operation is allowed only if the session is in the DownloadSessionModel.State.ACTIVE state.

If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this method enables a client to specifically extend the lifetime of an active download session.

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

Parameters:

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

progress - Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See DownloadSessionModel.getClientProgress(). If not specified the progress is not updated.

Throws:

NotFound - if no download session with the given identifier exists.

NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

keepAlive

void keepAlive(String downloadSessionId,
             Long progress,
             InvocationConfig invocationConfig)

Keeps a download session alive. This operation is allowed only if the session is in the DownloadSessionModel.State.ACTIVE state.

If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this method enables a client to specifically extend the lifetime of an active 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 whose lifetime should be extended. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

progress - Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See DownloadSessionModel.getClientProgress(). If not specified the progress is not updated.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if no download session with the given identifier exists.

NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

keepAlive

void keepAlive(String downloadSessionId,
             Long progress,
             AsyncCallback<Void> asyncCallback)

Keeps a download session alive. This operation is allowed only if the session is in the DownloadSessionModel.State.ACTIVE state.

If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this method enables a client to specifically extend the lifetime of an active download session.

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

Operation Errors:
NotFound - if no download session with the given identifier exists.
NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

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

progress - Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See DownloadSessionModel.getClientProgress(). If not specified the progress is not updated.

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

keepAlive

void keepAlive(String downloadSessionId,
             Long progress,
             AsyncCallback<Void> asyncCallback,
             InvocationConfig invocationConfig)

Keeps a download session alive. This operation is allowed only if the session is in the DownloadSessionModel.State.ACTIVE state.

If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this method enables a client to specifically extend the lifetime of an active 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 Errors:
NotFound - if no download session with the given identifier exists.
NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

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

progress - Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See DownloadSessionModel.getClientProgress(). If not specified the progress is not updated.

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

invocationConfig - Configuration for the method invocation.

cancel

void cancel(String downloadSessionId)

Cancels the download session. This method will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.

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

Parameters:

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

Throws:

NotFound - if no download session with the given identifier exists.

NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

cancel

void cancel(String downloadSessionId,
          InvocationConfig invocationConfig)

Cancels the download session. This method will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.

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 - Identifer of the download session that should be canceled. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if no download session with the given identifier exists.

NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

cancel

void cancel(String downloadSessionId,
          AsyncCallback<Void> asyncCallback)

Cancels the download session. This method will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.

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

Operation Errors:
NotFound - if no download session with the given identifier exists.
NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

downloadSessionId - Identifer of the download session that should be canceled. 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.

cancel

void cancel(String downloadSessionId,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Cancels the download session. This method will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.

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

Operation Errors:
NotFound - if no download session with the given identifier exists.
NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

downloadSessionId - Identifer of the download session that should be canceled. 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.

delete

void delete(String downloadSessionId)

Deletes a download session. This removes the session and all information associated with it.

Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item.

Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.

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

Parameters:

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

Throws:

NotFound - if the download session does not exist.

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

• Method execution requires System.Anonymous.

delete

void delete(String downloadSessionId,
          InvocationConfig invocationConfig)

Deletes a download session. This removes the session and all information associated with it.

Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item.

Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.

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 to be deleted. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the download session does not exist.

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

• Method execution requires System.Anonymous.

delete

void delete(String downloadSessionId,
          AsyncCallback<Void> asyncCallback)

Deletes a download session. This removes the session and all information associated with it.

Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item.

Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.

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

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

• Method execution requires System.Anonymous.

Parameters:

downloadSessionId - Identifier of the download session to be deleted. 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.

delete

void delete(String downloadSessionId,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Deletes a download session. This removes the session and all information associated with it.

Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item.

Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.

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

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

• Method execution requires System.Anonymous.

Parameters:

downloadSessionId - Identifier of the download session to be deleted. 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.

fail

void fail(String downloadSessionId,
        String clientErrorMessage)

Terminates the download session with a client specified error message.

This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.

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

Parameters:

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

clientErrorMessage - Client side error message. This can be useful in providing some extra details about the client side failure. Note that the message won't be translated to the user's locale.

Throws:

NotFound - if the download session does not exist.

NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

fail

void fail(String downloadSessionId,
        String clientErrorMessage,
        InvocationConfig invocationConfig)

Terminates the download session with a client specified error message.

This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.

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 to fail. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

clientErrorMessage - Client side error message. This can be useful in providing some extra details about the client side failure. Note that the message won't be translated to the user's locale.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the download session does not exist.

NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

fail

void fail(String downloadSessionId,
        String clientErrorMessage,
        AsyncCallback<Void> asyncCallback)

Terminates the download session with a client specified error message.

This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.

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

Operation Errors:
NotFound - if the download session does not exist.
NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

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

clientErrorMessage - Client side error message. This can be useful in providing some extra details about the client side failure. Note that the message won't be translated to the user's locale.

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

fail

void fail(String downloadSessionId,
        String clientErrorMessage,
        AsyncCallback<Void> asyncCallback,
        InvocationConfig invocationConfig)

Terminates the download session with a client specified error message.

This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.

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

Operation Errors:
NotFound - if the download session does not exist.
NotAllowedInCurrentState - if the download session is not in the DownloadSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

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

clientErrorMessage - Client side error message. This can be useful in providing some extra details about the client side failure. Note that the message won't be translated to the user's locale.

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

invocationConfig - Configuration for the method invocation.