com.vmware.content.library.item.updatesession

Interface File

All Superinterfaces:

FileTypes, Service

All Known Implementing Classes:

FileStub

public interface File
extends Service, FileTypes

The File interface provides methods for accessing files within an update session.

After an update session is created against a library item, the File interface can be used to make changes to the underlying library item metadata as well as the content of the files. The following changes can be made:

• deleting an existing file within the library item. This deletes both the metadata and the content.
• updating an existing file with new content.
• adding a new file to the library item.

The above changes are not applied or visible until the session is completed. See UpdateSession.

Nested Class Summary

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

FileTypes.AddSpec, FileTypes.Info, FileTypes.SourceType, FileTypes.ValidationError, FileTypes.ValidationResult

Method Summary

Methods

Modifier and Type	Method and Description
FileTypes.Info	add(String updateSessionId, FileTypes.AddSpec fileSpec) Requests file content to be changed (either created, or updated).
void	add(String updateSessionId, FileTypes.AddSpec fileSpec, AsyncCallback<FileTypes.Info> asyncCallback) Requests file content to be changed (either created, or updated).
void	add(String updateSessionId, FileTypes.AddSpec fileSpec, AsyncCallback<FileTypes.Info> asyncCallback, InvocationConfig invocationConfig) Requests file content to be changed (either created, or updated).
FileTypes.Info	add(String updateSessionId, FileTypes.AddSpec fileSpec, InvocationConfig invocationConfig) Requests file content to be changed (either created, or updated).
FileTypes.Info	get(String updateSessionId, String fileName) Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
void	get(String updateSessionId, String fileName, AsyncCallback<FileTypes.Info> asyncCallback) Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
void	get(String updateSessionId, String fileName, AsyncCallback<FileTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
FileTypes.Info	get(String updateSessionId, String fileName, InvocationConfig invocationConfig) Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
List<FileTypes.Info>	list(String updateSessionId) Lists all files in the library item associated with the update session.
void	list(String updateSessionId, AsyncCallback<List<FileTypes.Info>> asyncCallback) Lists all files in the library item associated with the update session.
void	list(String updateSessionId, AsyncCallback<List<FileTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Lists all files in the library item associated with the update session.
List<FileTypes.Info>	list(String updateSessionId, InvocationConfig invocationConfig) Lists all files in the library item associated with the update session.
void	remove(String updateSessionId, String fileName) Requests a file to be removed.
void	remove(String updateSessionId, String fileName, AsyncCallback<Void> asyncCallback) Requests a file to be removed.
void	remove(String updateSessionId, String fileName, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Requests a file to be removed.
void	remove(String updateSessionId, String fileName, InvocationConfig invocationConfig) Requests a file to be removed.
FileTypes.ValidationResult	validate(String updateSessionId) Validates the files in the update session with the referenced identifier and ensures all necessary files are received.
void	validate(String updateSessionId, AsyncCallback<FileTypes.ValidationResult> asyncCallback) Validates the files in the update session with the referenced identifier and ensures all necessary files are received.
void	validate(String updateSessionId, AsyncCallback<FileTypes.ValidationResult> asyncCallback, InvocationConfig invocationConfig) Validates the files in the update session with the referenced identifier and ensures all necessary files are received.
FileTypes.ValidationResult	validate(String updateSessionId, InvocationConfig invocationConfig) Validates the files in the update session with the referenced identifier and ensures all necessary files are received.

Method Detail

validate

FileTypes.ValidationResult validate(String updateSessionId)

Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this method will return its name in the FileTypes.ValidationResult.getMissingFiles() set. The user can add the missing files and try re-validating. For other type of errors, FileTypes.ValidationResult.getInvalidFiles() will contain the list of invalid files.

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

Parameters:

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

Returns:

A validation result containing missing files or invalid files and the reason why they are invalid.

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.

validate

FileTypes.ValidationResult validate(String updateSessionId,
                                  InvocationConfig invocationConfig)

Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this method will return its name in the FileTypes.ValidationResult.getMissingFiles() set. The user can add the missing files and try re-validating. For other type of errors, FileTypes.ValidationResult.getInvalidFiles() will contain the list of invalid files.

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

invocationConfig - Configuration for the method invocation.

Returns:

A validation result containing missing files or invalid files and the reason why they are invalid.

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.

validate

void validate(String updateSessionId,
            AsyncCallback<FileTypes.ValidationResult> asyncCallback)

Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this method will return its name in the FileTypes.ValidationResult.getMissingFiles() set. The user can add the missing files and try re-validating. For other type of errors, FileTypes.ValidationResult.getInvalidFiles() will contain the list of invalid files.

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

Operation Result:
A validation result containing missing files or invalid files and the reason why they are invalid.

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.

Parameters:

updateSessionId - Identifier of the update session to validate. 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.

validate

void validate(String updateSessionId,
            AsyncCallback<FileTypes.ValidationResult> asyncCallback,
            InvocationConfig invocationConfig)

Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this method will return its name in the FileTypes.ValidationResult.getMissingFiles() set. The user can add the missing files and try re-validating. For other type of errors, FileTypes.ValidationResult.getInvalidFiles() will contain the list of invalid files.

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:
A validation result containing missing files or invalid files and the reason why they are invalid.

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.

Parameters:

updateSessionId - Identifier of the update session to validate. 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.

add

FileTypes.Info add(String updateSessionId,
                 FileTypes.AddSpec fileSpec)

Requests file content to be changed (either created, or updated). Depending on the source type of the file, this method will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this method will be used to update the content of the existing file.

When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move.

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

Parameters:

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

fileSpec - Specification for the file that needs to be added or updated. This includes whether the client wants to push the content or have the server pull it.

Returns:

An FileTypes.Info class containing upload links as well as server side state tracking the transfer of the file.

Throws:

InvalidArgument - if the fileSpec is invalid.

NotFound - if the update session doesn't exist.

Unauthorized - if the caller doesn't have ContentLibrary.ReadStorage privilege on the library item of the update session and source type FileTypes.SourceType.PULL is requested for a file or datastore source endpoint (that is, not HTTP or HTTPs based endpoint).

add

FileTypes.Info add(String updateSessionId,
                 FileTypes.AddSpec fileSpec,
                 InvocationConfig invocationConfig)

Requests file content to be changed (either created, or updated). Depending on the source type of the file, this method will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this method will be used to update the content of the existing file.

When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move.

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

fileSpec - Specification for the file that needs to be added or updated. This includes whether the client wants to push the content or have the server pull it.

invocationConfig - Configuration for the method invocation.

Returns:

An FileTypes.Info class containing upload links as well as server side state tracking the transfer of the file.

Throws:

InvalidArgument - if the fileSpec is invalid.

NotFound - if the update session doesn't exist.

Unauthorized - if the caller doesn't have ContentLibrary.ReadStorage privilege on the library item of the update session and source type FileTypes.SourceType.PULL is requested for a file or datastore source endpoint (that is, not HTTP or HTTPs based endpoint).

add

void add(String updateSessionId,
       FileTypes.AddSpec fileSpec,
       AsyncCallback<FileTypes.Info> asyncCallback)

Requests file content to be changed (either created, or updated). Depending on the source type of the file, this method will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this method will be used to update the content of the existing file.

When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move.

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

Operation Result:
An FileTypes.Info class containing upload links as well as server side state tracking the transfer of the file.

Operation Errors:
InvalidArgument - if the fileSpec is invalid.
NotFound - if the update session doesn't exist.
Unauthorized - if the caller doesn't have ContentLibrary.ReadStorage privilege on the library item of the update session and source type FileTypes.SourceType.PULL is requested for a file or datastore source endpoint (that is, not HTTP or HTTPs based endpoint).

Parameters:

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

fileSpec - Specification for the file that needs to be added or updated. This includes whether the client wants to push the content or have the server pull it.

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

add

void add(String updateSessionId,
       FileTypes.AddSpec fileSpec,
       AsyncCallback<FileTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Requests file content to be changed (either created, or updated). Depending on the source type of the file, this method will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this method will be used to update the content of the existing file.

When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move.

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:
An FileTypes.Info class containing upload links as well as server side state tracking the transfer of the file.

Operation Errors:
InvalidArgument - if the fileSpec is invalid.
NotFound - if the update session doesn't exist.
Unauthorized - if the caller doesn't have ContentLibrary.ReadStorage privilege on the library item of the update session and source type FileTypes.SourceType.PULL is requested for a file or datastore source endpoint (that is, not HTTP or HTTPs based endpoint).

Parameters:

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

fileSpec - Specification for the file that needs to be added or updated. This includes whether the client wants to push the content or have the server pull it.

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

invocationConfig - Configuration for the method invocation.

remove

void remove(String updateSessionId,
          String fileName)

Requests a file to be removed. The file will only be effectively removed when the update session is completed.

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

Parameters:

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

fileName - Name of the file to be removed.

Throws:

NotFound - if the update session doesn't exist.

InvalidArgument - if the file doesn't exist in the library item associated with the update session.

remove

void remove(String updateSessionId,
          String fileName,
          InvocationConfig invocationConfig)

Requests a file to be removed. The file will only be effectively removed when the update session is completed.

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

fileName - Name of the file to be removed.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the update session doesn't exist.

InvalidArgument - if the file doesn't exist in the library item associated with the update session.

remove

void remove(String updateSessionId,
          String fileName,
          AsyncCallback<Void> asyncCallback)

Requests a file to be removed. The file will only be effectively removed when the update session is completed.

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

Operation Errors:
NotFound - if the update session doesn't exist.
InvalidArgument - if the file doesn't exist in the library item associated with the update session.

Parameters:

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

fileName - Name of the file to be removed.

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

remove

void remove(String updateSessionId,
          String fileName,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Requests a file to be removed. The file will only be effectively removed when the update session is completed.

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 doesn't exist.
InvalidArgument - if the file doesn't exist in the library item associated with the update session.

Parameters:

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

fileName - Name of the file to be removed.

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

invocationConfig - Configuration for the method invocation.

list

List<FileTypes.Info> list(String updateSessionId)

Lists all files in the library item associated with 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. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

Returns:

The List of the files in the library item associated with the update session. This List may be empty if the caller has removed all the files as part of this session (in which case completing the update session will result in an empty library item).

Throws:

NotFound - if the update session doesn't exist.

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

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

list

List<FileTypes.Info> list(String updateSessionId,
                        InvocationConfig invocationConfig)

Lists all files in the library item associated with 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. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.

invocationConfig - Configuration for the method invocation.

Returns:

The List of the files in the library item associated with the update session. This List may be empty if the caller has removed all the files as part of this session (in which case completing the update session will result in an empty library item).

Throws:

NotFound - if the update session doesn't exist.

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

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

list

void list(String updateSessionId,
        AsyncCallback<List<FileTypes.Info>> asyncCallback)

Lists all files in the library item associated with the update session.

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

Operation Result:
The List of the files in the library item associated with the update session. This List may be empty if the caller has removed all the files as part of this session (in which case completing the update session will result in an empty library item).

Operation Errors:
NotFound - if the update session doesn't exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

Parameters:

updateSessionId - Identifier of the update session. 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.

list

void list(String updateSessionId,
        AsyncCallback<List<FileTypes.Info>> asyncCallback,
        InvocationConfig invocationConfig)

Lists all files in the library item associated with 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 Result:
The List of the files in the library item associated with the update session. This List may be empty if the caller has removed all the files as part of this session (in which case completing the update session will result in an empty library item).

Operation Errors:
NotFound - if the update session doesn't exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

Parameters:

updateSessionId - Identifier of the update session. 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.

get

FileTypes.Info get(String updateSessionId,
                 String fileName)

Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.

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

Parameters:

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

fileName - Name of the file.

Returns:

Information about the file.

Throws:

NotFound - if the update session doesn't exist.

InvalidArgument - if the file doesn't exist in the library item associated with the update session.

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

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

get

FileTypes.Info get(String updateSessionId,
                 String fileName,
                 InvocationConfig invocationConfig)

Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.

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

fileName - Name of the file.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the file.

Throws:

NotFound - if the update session doesn't exist.

InvalidArgument - if the file doesn't exist in the library item associated with the update session.

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

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

get

void get(String updateSessionId,
       String fileName,
       AsyncCallback<FileTypes.Info> asyncCallback)

Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.

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

Operation Result:
Information about the file.

Operation Errors:
NotFound - if the update session doesn't exist.
InvalidArgument - if the file doesn't exist in the library item associated with the update session.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

Parameters:

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

fileName - Name of the file.

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

get

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

Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.

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:
Information about the file.

Operation Errors:
NotFound - if the update session doesn't exist.
InvalidArgument - if the file doesn't exist in the library item associated with the update session.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

Parameters:

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

fileName - Name of the file.

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

invocationConfig - Configuration for the method invocation.