com.vmware.content.library.item

Interface UpdateSession

All Superinterfaces:

Service, UpdateSessionTypes

All Known Implementing Classes:

UpdateSessionStub

public interface UpdateSession
extends Service, UpdateSessionTypes

The UpdateSession interface manipulates sessions that are used to upload content into the Content Library Service, and/or to remove files from a library item.

An update session is a resource which tracks changes to content. An update session is created with a set of files that are intended to be uploaded to a specific ItemModel, or removed from an item. The session object can be used to track the uploads and inspect the changes that are being made to the item by that upload. It can also serve as a channel to check on the result of the upload, and status messages such as errors and warnings for the upload.

Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

The management of the files within the session is done through the File interface.

Field Summary

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

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(java.lang.String updateSessionId) Cancels the update session and sets its state to UpdateSessionModel.State.CANCELED.
void	cancel(java.lang.String updateSessionId, AsyncCallback<java.lang.Void> asyncCallback) Cancels the update session and sets its state to UpdateSessionModel.State.CANCELED.
void	cancel(java.lang.String updateSessionId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Cancels the update session and sets its state to UpdateSessionModel.State.CANCELED.
void	cancel(java.lang.String updateSessionId, InvocationConfig invocationConfig) Cancels the update session and sets its state to UpdateSessionModel.State.CANCELED.
void	complete(java.lang.String updateSessionId) Completes the update session.
void	complete(java.lang.String updateSessionId, AsyncCallback<java.lang.Void> asyncCallback) Completes the update session.
void	complete(java.lang.String updateSessionId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Completes the update session.
void	complete(java.lang.String updateSessionId, InvocationConfig invocationConfig) Completes the update session.
java.lang.String	create(java.lang.String clientToken, UpdateSessionModel createSpec) Creates a new update session.
void	create(java.lang.String clientToken, UpdateSessionModel createSpec, AsyncCallback<java.lang.String> asyncCallback) Creates a new update session.
void	create(java.lang.String clientToken, UpdateSessionModel createSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a new update session.
java.lang.String	create(java.lang.String clientToken, UpdateSessionModel createSpec, InvocationConfig invocationConfig) Creates a new update session.
void	delete(java.lang.String updateSessionId) Deletes an update session.
void	delete(java.lang.String updateSessionId, AsyncCallback<java.lang.Void> asyncCallback) Deletes an update session.
void	delete(java.lang.String updateSessionId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes an update session.
void	delete(java.lang.String updateSessionId, InvocationConfig invocationConfig) Deletes an update session.
void	fail(java.lang.String updateSessionId, java.lang.String clientErrorMessage) Terminates the update session with a client specified error message.
void	fail(java.lang.String updateSessionId, java.lang.String clientErrorMessage, AsyncCallback<java.lang.Void> asyncCallback) Terminates the update session with a client specified error message.
void	fail(java.lang.String updateSessionId, java.lang.String clientErrorMessage, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Terminates the update session with a client specified error message.
void	fail(java.lang.String updateSessionId, java.lang.String clientErrorMessage, InvocationConfig invocationConfig) Terminates the update session with a client specified error message.
UpdateSessionModel	get(java.lang.String updateSessionId) Gets the update session with the specified identifier, including the most up-to-date status information for the session.
void	get(java.lang.String updateSessionId, AsyncCallback<UpdateSessionModel> asyncCallback) Gets the update session with the specified identifier, including the most up-to-date status information for the session.
void	get(java.lang.String updateSessionId, AsyncCallback<UpdateSessionModel> asyncCallback, InvocationConfig invocationConfig) Gets the update session with the specified identifier, including the most up-to-date status information for the session.
UpdateSessionModel	get(java.lang.String updateSessionId, InvocationConfig invocationConfig) Gets the update session with the specified identifier, including the most up-to-date status information for the session.
void	keepAlive(java.lang.String updateSessionId, java.lang.Long clientProgress) Keeps an update session alive.
void	keepAlive(java.lang.String updateSessionId, java.lang.Long clientProgress, AsyncCallback<java.lang.Void> asyncCallback) Keeps an update session alive.
void	keepAlive(java.lang.String updateSessionId, java.lang.Long clientProgress, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Keeps an update session alive.
void	keepAlive(java.lang.String updateSessionId, java.lang.Long clientProgress, InvocationConfig invocationConfig) Keeps an update session alive.
java.util.List<java.lang.String>	list(java.lang.String libraryItemId) Lists the identifiers of the update session created by the calling user.
void	list(java.lang.String libraryItemId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Lists the identifiers of the update session created by the calling user.
void	list(java.lang.String libraryItemId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Lists the identifiers of the update session created by the calling user.
java.util.List<java.lang.String>	list(java.lang.String libraryItemId, InvocationConfig invocationConfig) Lists the identifiers of the update session created by the calling user.
void	update(java.lang.String updateSessionId, UpdateSessionModel updateSpec) Updates the properties of an update session.
void	update(java.lang.String updateSessionId, UpdateSessionModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback) Updates the properties of an update session.
void	update(java.lang.String updateSessionId, UpdateSessionModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the properties of an update session.
void	update(java.lang.String updateSessionId, UpdateSessionModel updateSpec, InvocationConfig invocationConfig) Updates the properties of an update session.

Method Detail

create

java.lang.String create(java.lang.String clientToken,
                      UpdateSessionModel createSpec)

Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

Content Library Service allows only one single update session to be active for a specific library item.

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

Parameters:

clientToken - 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 update session to be created.

Returns:

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

Throws:

InvalidArgument - if the session specification is not valid.

InvalidArgument - if the clientToken does not conform to the UUID format.

InvalidElementType - if the update session is being created on a subscribed library item.

NotFound - if the item targeted for update does not exist.

ResourceBusy - if there is another update session on the same 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 property UpdateSessionModel.getLibraryItemId() requires ContentLibrary.UpdateSession.

create

java.lang.String create(java.lang.String clientToken,
                      UpdateSessionModel createSpec,
                      InvocationConfig invocationConfig)

Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

Content Library Service allows only one single update session to be active for a specific 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:

clientToken - 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 update session to be created.

invocationConfig - Configuration for the method invocation.

Returns:

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

Throws:

InvalidArgument - if the session specification is not valid.

InvalidArgument - if the clientToken does not conform to the UUID format.

InvalidElementType - if the update session is being created on a subscribed library item.

NotFound - if the item targeted for update does not exist.

ResourceBusy - if there is another update session on the same 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 property UpdateSessionModel.getLibraryItemId() requires ContentLibrary.UpdateSession.

create

void create(java.lang.String clientToken,
          UpdateSessionModel createSpec,
          AsyncCallback<java.lang.String> asyncCallback)

Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

Content Library Service allows only one single update session to be active for a specific library item.

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

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

Operation Errors:
InvalidArgument - if the session specification is not valid.
InvalidArgument - if the clientToken does not conform to the UUID format.
InvalidElementType - if the update session is being created on a subscribed library item.
NotFound - if the item targeted for update does not exist.
ResourceBusy - if there is another update session on the same 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 property UpdateSessionModel.getLibraryItemId() requires ContentLibrary.UpdateSession.

Parameters:

clientToken - 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 update session to be created.

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

create

void create(java.lang.String clientToken,
          UpdateSessionModel createSpec,
          AsyncCallback<java.lang.String> asyncCallback,
          InvocationConfig invocationConfig)

Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

Content Library Service allows only one single update session to be active for a specific 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:
Identifier of the new update session being created. The return value will be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

Operation Errors:
InvalidArgument - if the session specification is not valid.
InvalidArgument - if the clientToken does not conform to the UUID format.
InvalidElementType - if the update session is being created on a subscribed library item.
NotFound - if the item targeted for update does not exist.
ResourceBusy - if there is another update session on the same 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 property UpdateSessionModel.getLibraryItemId() requires ContentLibrary.UpdateSession.

Parameters:

clientToken - 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 update session to be created.

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

invocationConfig - Configuration for the method invocation.

get

UpdateSessionModel get(java.lang.String updateSessionId)

Gets the update 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:

updateSessionId - Identifier of the update session to retrieve. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

Returns:

The UpdateSessionModel instance with the given updateSessionId.

Throws:

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

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

• Method execution requires System.Anonymous.

get

UpdateSessionModel get(java.lang.String updateSessionId,
                     InvocationConfig invocationConfig)

Gets the update 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:

updateSessionId - Identifier of the update session to retrieve. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

invocationConfig - Configuration for the method invocation.

Returns:

The UpdateSessionModel instance with the given updateSessionId.

Throws:

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

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

• Method execution requires System.Anonymous.

get

void get(java.lang.String updateSessionId,
       AsyncCallback<UpdateSessionModel> asyncCallback)

Gets the update 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 UpdateSessionModel instance with the given updateSessionId.

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

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifier of the update session to retrieve. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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

get

void get(java.lang.String updateSessionId,
       AsyncCallback<UpdateSessionModel> asyncCallback,
       InvocationConfig invocationConfig)

Gets the update 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 UpdateSessionModel instance with the given updateSessionId.

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

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifier of the update session to retrieve. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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

invocationConfig - Configuration for the method invocation.

list

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

Lists the identifiers of the update session 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 - Optional library item identifier on which to filter results. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. If not specified the results are not filtered.

Returns:

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

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.UpdateSession referenced by the parameter libraryItemId requires ContentLibrary.UpdateSession.

list

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

Lists the identifiers of the update session 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 - Optional library item identifier on which to filter results. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. If not specified the results are not filtered.

invocationConfig - Configuration for the method invocation.

Returns:

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

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.UpdateSession referenced by the parameter libraryItemId requires ContentLibrary.UpdateSession.

list

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

Lists the identifiers of the update session 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 update sessions created by the calling user. The return value will contain identifiers for the resource type: com.vmware.content.library.item.UpdateSession.

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.UpdateSession referenced by the parameter libraryItemId requires ContentLibrary.UpdateSession.

Parameters:

libraryItemId - Optional library item identifier on which to filter results. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. If not specified the results are not filtered.

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

list

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

Lists the identifiers of the update session 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 update sessions created by the calling user. The return value will contain identifiers for the resource type: com.vmware.content.library.item.UpdateSession.

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.UpdateSession referenced by the parameter libraryItemId requires ContentLibrary.UpdateSession.

Parameters:

libraryItemId - Optional library item identifier on which to filter results. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. If not specified the results are not filtered.

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

invocationConfig - Configuration for the method invocation.

complete

void complete(java.lang.String updateSessionId)

Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done.

This method requires the session to be in the UpdateSessionModel.State.ACTIVE state.

Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the File.validate(java.lang.String) method.

Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

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

Parameters:

updateSessionId - Identifier of the update session that should be completed. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

Throws:

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

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state, or if some of the files that will be uploaded by the client aren't received correctly.

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

• Method execution requires System.Anonymous.

complete

void complete(java.lang.String updateSessionId,
            InvocationConfig invocationConfig)

Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done.

This method requires the session to be in the UpdateSessionModel.State.ACTIVE state.

Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the File.validate(java.lang.String) method.

Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

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:

updateSessionId - Identifier of the update session that should be completed. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state, or if some of the files that will be uploaded by the client aren't received correctly.

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

• Method execution requires System.Anonymous.

complete

void complete(java.lang.String updateSessionId,
            AsyncCallback<java.lang.Void> asyncCallback)

Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done.

This method requires the session to be in the UpdateSessionModel.State.ACTIVE state.

Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the File.validate(java.lang.String) method.

Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

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

Operation Errors:
NotFound - if no update session with the given identifier exists.
NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state, or if some of the files that will be uploaded by the client aren't received correctly.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifier of the update session that should be completed. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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

complete

void complete(java.lang.String updateSessionId,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done.

This method requires the session to be in the UpdateSessionModel.State.ACTIVE state.

Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the File.validate(java.lang.String) method.

Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

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 update session with the given identifier exists.
NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state, or if some of the files that will be uploaded by the client aren't received correctly.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifier of the update session that should be completed. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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

invocationConfig - Configuration for the method invocation.

keepAlive

void keepAlive(java.lang.String updateSessionId,
             java.lang.Long clientProgress)

Keeps an update session alive.

If there is no activity for an update session after a period of time, the update session will expire, then be deleted. The update 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 the update session.

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

Parameters:

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

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

Throws:

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

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

keepAlive

void keepAlive(java.lang.String updateSessionId,
             java.lang.Long clientProgress,
             InvocationConfig invocationConfig)

Keeps an update session alive.

If there is no activity for an update session after a period of time, the update session will expire, then be deleted. The update 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 the update 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:

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

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

invocationConfig - Configuration for the method invocation.

Throws:

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

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

keepAlive

void keepAlive(java.lang.String updateSessionId,
             java.lang.Long clientProgress,
             AsyncCallback<java.lang.Void> asyncCallback)

Keeps an update session alive.

If there is no activity for an update session after a period of time, the update session will expire, then be deleted. The update 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 the update session.

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

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

• Method execution requires System.Anonymous.

Parameters:

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

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

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

keepAlive

void keepAlive(java.lang.String updateSessionId,
             java.lang.Long clientProgress,
             AsyncCallback<java.lang.Void> asyncCallback,
             InvocationConfig invocationConfig)

Keeps an update session alive.

If there is no activity for an update session after a period of time, the update session will expire, then be deleted. The update 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 the update 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 update session with the given identifier exists.
NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

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

clientProgress - Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See UpdateSessionModel.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(java.lang.String updateSessionId)

Cancels the update session and sets its state to UpdateSessionModel.State.CANCELED. This method will free up any temporary resources currently associated with the session.

This method is not allowed if the session has been already completed.

Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.

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

Parameters:

updateSessionId - Identifier of the update session that should be canceled. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

Throws:

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

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

cancel

void cancel(java.lang.String updateSessionId,
          InvocationConfig invocationConfig)

Cancels the update session and sets its state to UpdateSessionModel.State.CANCELED. This method will free up any temporary resources currently associated with the session.

This method is not allowed if the session has been already completed.

Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.

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:

updateSessionId - Identifier of the update session that should be canceled. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

cancel

void cancel(java.lang.String updateSessionId,
          AsyncCallback<java.lang.Void> asyncCallback)

Cancels the update session and sets its state to UpdateSessionModel.State.CANCELED. This method will free up any temporary resources currently associated with the session.

This method is not allowed if the session has been already completed.

Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.

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

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

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifier of the update session that should be canceled. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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

cancel

void cancel(java.lang.String updateSessionId,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Cancels the update session and sets its state to UpdateSessionModel.State.CANCELED. This method will free up any temporary resources currently associated with the session.

This method is not allowed if the session has been already completed.

Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.

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 update session with the given identifier exists.
NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifier of the update session that should be canceled. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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

invocationConfig - Configuration for the method invocation.

fail

void fail(java.lang.String updateSessionId,
        java.lang.String clientErrorMessage)

Terminates the update session with a client specified error message.

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

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

Parameters:

updateSessionId - Identifier of the update session to fail. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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 update session does not exist.

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

fail

void fail(java.lang.String updateSessionId,
        java.lang.String clientErrorMessage,
        InvocationConfig invocationConfig)

Terminates the update session with a client specified error message.

This is useful in transmitting client side failures (for example, not being able to access 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:

updateSessionId - Identifier of the update session to fail. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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 update session does not exist.

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

fail

void fail(java.lang.String updateSessionId,
        java.lang.String clientErrorMessage,
        AsyncCallback<java.lang.Void> asyncCallback)

Terminates the update session with a client specified error message.

This is useful in transmitting client side failures (for example, not being able to access 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 update session does not exist.
NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifier of the update session to fail. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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(java.lang.String updateSessionId,
        java.lang.String clientErrorMessage,
        AsyncCallback<java.lang.Void> asyncCallback,
        InvocationConfig invocationConfig)

Terminates the update session with a client specified error message.

This is useful in transmitting client side failures (for example, not being able to access 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 update session does not exist.
NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifier of the update session to fail. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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.

delete

void delete(java.lang.String updateSessionId)

Deletes an update session. This removes the session and all information associated with it.

Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item.

Update sessions for which there is no upload activity or which are complete will automatically be deleted after a period of time.

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

Parameters:

updateSessionId - Identifer of the update session to delete. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

Throws:

NotFound - if the update session does not exist.

NotAllowedInCurrentState - if the update session is in the UpdateSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

delete

void delete(java.lang.String updateSessionId,
          InvocationConfig invocationConfig)

Deletes an update session. This removes the session and all information associated with it.

Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item.

Update sessions for which there is no upload activity or which are complete will automatically be 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:

updateSessionId - Identifer of the update session to delete. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the update session does not exist.

NotAllowedInCurrentState - if the update session is in the UpdateSessionModel.State.ACTIVE state.

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

• Method execution requires System.Anonymous.

delete

void delete(java.lang.String updateSessionId,
          AsyncCallback<java.lang.Void> asyncCallback)

Deletes an update session. This removes the session and all information associated with it.

Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item.

Update sessions for which there is no upload activity or which are complete will automatically be 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 update session does not exist.
NotAllowedInCurrentState - if the update session is in the UpdateSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifer of the update session to delete. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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

delete

void delete(java.lang.String updateSessionId,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Deletes an update session. This removes the session and all information associated with it.

Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item.

Update sessions for which there is no upload activity or which are complete will automatically be 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 update session does not exist.
NotAllowedInCurrentState - if the update session is in the UpdateSessionModel.State.ACTIVE state.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifer of the update session to delete. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String updateSessionId,
          UpdateSessionModel updateSpec)

Updates the properties of an update session.

This is an incremental update to the update session. Any property in the UpdateSessionModel class that is null will not be modified.

This method will only update the property UpdateSessionModel.getWarningBehavior() of the update session. This will not, for example, update the UpdateSessionModel.getLibraryItemId() or UpdateSessionModel.getState() of an update session.

This method requires the session to be in the UpdateSessionModel.State.ACTIVE state.

. This method was added in vSphere API 6.7 U1.

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

Parameters:

updateSessionId - Identifer of the update session that should be updated. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

updateSpec - Specification for the new property values to be set on the update session.

Throws:

NotFound - if the update session does not exist.

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.

InvalidArgument - if the update session specification is not valid.

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

• Method execution requires System.Anonymous.

update

void update(java.lang.String updateSessionId,
          UpdateSessionModel updateSpec,
          InvocationConfig invocationConfig)

Updates the properties of an update session.

This is an incremental update to the update session. Any property in the UpdateSessionModel class that is null will not be modified.

This method will only update the property UpdateSessionModel.getWarningBehavior() of the update session. This will not, for example, update the UpdateSessionModel.getLibraryItemId() or UpdateSessionModel.getState() of an update session.

This method requires the session to be in the UpdateSessionModel.State.ACTIVE state.

. This method was added in vSphere API 6.7 U1.

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:

updateSessionId - Identifer of the update session that should be updated. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

updateSpec - Specification for the new property values to be set on the update session.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the update session does not exist.

NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.

InvalidArgument - if the update session specification is not valid.

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

• Method execution requires System.Anonymous.

update

void update(java.lang.String updateSessionId,
          UpdateSessionModel updateSpec,
          AsyncCallback<java.lang.Void> asyncCallback)

Updates the properties of an update session.

This is an incremental update to the update session. Any property in the UpdateSessionModel class that is null will not be modified.

This method will only update the property UpdateSessionModel.getWarningBehavior() of the update session. This will not, for example, update the UpdateSessionModel.getLibraryItemId() or UpdateSessionModel.getState() of an update session.

This method requires the session to be in the UpdateSessionModel.State.ACTIVE state.

. This method was added in vSphere API 6.7 U1.

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

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

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifer of the update session that should be updated. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

updateSpec - Specification for the new property values to be set on the update session.

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

update

void update(java.lang.String updateSessionId,
          UpdateSessionModel updateSpec,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Updates the properties of an update session.

This is an incremental update to the update session. Any property in the UpdateSessionModel class that is null will not be modified.

This method will only update the property UpdateSessionModel.getWarningBehavior() of the update session. This will not, for example, update the UpdateSessionModel.getLibraryItemId() or UpdateSessionModel.getState() of an update session.

This method requires the session to be in the UpdateSessionModel.State.ACTIVE state.

. This method was added in vSphere API 6.7 U1.

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 update session does not exist.
NotAllowedInCurrentState - if the update session is not in the UpdateSessionModel.State.ACTIVE state.
InvalidArgument - if the update session specification is not valid.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Anonymous.

Parameters:

updateSessionId - Identifer of the update session that should be updated. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

updateSpec - Specification for the new property values to be set on the update session.

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

invocationConfig - Configuration for the method invocation.