com.vmware.content

Interface LocalLibrary

All Superinterfaces:

LocalLibraryTypes, Service

All Known Implementing Classes:

LocalLibraryStub

public interface LocalLibrary
extends Service, LocalLibraryTypes

The LocalLibrary interface manages local libraries.

The LocalLibrary interface provides support for creating and maintaining local library instances. A local library may also use the Library interface to manage general library functionality.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String clientToken, LibraryModel createSpec) Creates a new local library.
void	create(java.lang.String clientToken, LibraryModel createSpec, AsyncCallback<java.lang.String> asyncCallback) Creates a new local library.
void	create(java.lang.String clientToken, LibraryModel createSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a new local library.
java.lang.String	create(java.lang.String clientToken, LibraryModel createSpec, InvocationConfig invocationConfig) Creates a new local library.
void	delete(java.lang.String libraryId) Deletes the specified local library.
void	delete(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback) Deletes the specified local library.
void	delete(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the specified local library.
void	delete(java.lang.String libraryId, InvocationConfig invocationConfig) Deletes the specified local library.
LibraryModel	get(java.lang.String libraryId) Returns a given local library.
void	get(java.lang.String libraryId, AsyncCallback<LibraryModel> asyncCallback) Returns a given local library.
void	get(java.lang.String libraryId, AsyncCallback<LibraryModel> asyncCallback, InvocationConfig invocationConfig) Returns a given local library.
LibraryModel	get(java.lang.String libraryId, InvocationConfig invocationConfig) Returns a given local library.
java.util.List<java.lang.String>	list() Returns the identifiers of all local libraries in the Content Library.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns the identifiers of all local libraries in the Content Library.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers of all local libraries in the Content Library.
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Returns the identifiers of all local libraries in the Content Library.
void	update(java.lang.String libraryId, LibraryModel updateSpec) Updates the properties of a local library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback) Updates the properties of a local library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the properties of a local library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, InvocationConfig invocationConfig) Updates the properties of a local library.

Method Detail

create

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

Creates a new local library.

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

Parameters:

clientToken - A unique token generated on 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 local library.

Returns:

Identifier of the newly created LibraryModel. The return value will be an identifier for the resource type: com.vmware.content.Library.

Throws:

InvalidArgument - if the createSpec is not valid.

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

Unsupported - if using multiple storage backings.

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

• Method execution requires ContentLibrary.CreateLocalLibrary.

create

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

Creates a new local library.

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 on 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 local library.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the newly created LibraryModel. The return value will be an identifier for the resource type: com.vmware.content.Library.

Throws:

InvalidArgument - if the createSpec is not valid.

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

Unsupported - if using multiple storage backings.

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

• Method execution requires ContentLibrary.CreateLocalLibrary.

create

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

Creates a new local library.

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

Operation Result:
Identifier of the newly created LibraryModel. The return value will be an identifier for the resource type: com.vmware.content.Library.

Operation Errors:
InvalidArgument - if the createSpec is not valid.
InvalidArgument - if the clientToken does not conform to the UUID format.
Unsupported - if using multiple storage backings.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.CreateLocalLibrary.

Parameters:

clientToken - A unique token generated on 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 local library.

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

create

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

Creates a new local library.

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 newly created LibraryModel. The return value will be an identifier for the resource type: com.vmware.content.Library.

Operation Errors:
InvalidArgument - if the createSpec is not valid.
InvalidArgument - if the clientToken does not conform to the UUID format.
Unsupported - if using multiple storage backings.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.CreateLocalLibrary.

Parameters:

clientToken - A unique token generated on 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 local library.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String libraryId)

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

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

Parameters:

libraryId - Identifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library.

Throws:

InvalidElementType - if the library specified by libraryId is not a local library.

NotFound - if the library specified by libraryId does not exist.

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

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary.

delete

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

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

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:

libraryId - Identifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Throws:

InvalidElementType - if the library specified by libraryId is not a local library.

NotFound - if the library specified by libraryId does not exist.

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

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary.

delete

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

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

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

Operation Errors:
InvalidElementType - if the library specified by libraryId is not a local library.
NotFound - if the library specified by libraryId does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary.

Parameters:

libraryId - Identifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library.

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

delete

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

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

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:
InvalidElementType - if the library specified by libraryId is not a local library.
NotFound - if the library specified by libraryId does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary.

Parameters:

libraryId - Identifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library.

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

invocationConfig - Configuration for the method invocation.

get

LibraryModel get(java.lang.String libraryId)

Returns a given local library.

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

Parameters:

libraryId - Identifier of the local library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

Returns:

The LibraryModel instance associated with libraryId.

Throws:

NotFound - if the library specified by libraryId does not exist.

InvalidElementType - if the library specified by libraryId is not a local library.

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

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

get

LibraryModel get(java.lang.String libraryId,
               InvocationConfig invocationConfig)

Returns a given local library.

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:

libraryId - Identifier of the local library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Returns:

The LibraryModel instance associated with libraryId.

Throws:

NotFound - if the library specified by libraryId does not exist.

InvalidElementType - if the library specified by libraryId is not a local library.

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

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

get

void get(java.lang.String libraryId,
       AsyncCallback<LibraryModel> asyncCallback)

Returns a given local library.

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

Operation Result:
The LibraryModel instance associated with libraryId.

Operation Errors:
NotFound - if the library specified by libraryId does not exist.
InvalidElementType - if the library specified by libraryId is not a local library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

Parameters:

libraryId - Identifier of the local library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

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

get

void get(java.lang.String libraryId,
       AsyncCallback<LibraryModel> asyncCallback,
       InvocationConfig invocationConfig)

Returns a given local library.

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 LibraryModel instance associated with libraryId.

Operation Errors:
NotFound - if the library specified by libraryId does not exist.
InvalidElementType - if the library specified by libraryId is not a local library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

Parameters:

libraryId - Identifier of the local library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

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()

Returns the identifiers of all local libraries in the Content Library.

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

Returns:

The List of identifiers of all local libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Throws:

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

• Method execution requires System.Read.

list

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

Returns the identifiers of all local libraries in the Content Library.

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:

invocationConfig - Configuration for the method invocation.

Returns:

The List of identifiers of all local libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Throws:

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

• Method execution requires System.Read.

list

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

Returns the identifiers of all local libraries in the Content Library.

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

Operation Result:
The List of identifiers of all local libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

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

• Method execution requires System.Read.

Parameters:

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

list

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

Returns the identifiers of all local libraries in the Content Library.

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 local libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

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

• Method execution requires System.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String libraryId,
          LibraryModel updateSpec)

Updates the properties of a local library.

This is an incremental update to the local library. Properties that are null in the update specification will be left unchanged.

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

Parameters:

libraryId - Identifier of the local library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the local library.

Throws:

NotFound - if the library specified by libraryId does not exist.

NotAllowedInCurrentState - if the library specified by libraryId is a published library with JSON persistence enabled (see PublishInfo.getPersistJsonEnabled()) and the content of the library has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

InvalidElementType - if the library specified by libraryId is not a local library.

InvalidArgument - if the updateSpec is not valid.

InvalidArgument - if the PublishInfo.getCurrentPassword() in the updateSpec does not match the existing password of the published library.

ResourceBusy - if the LibraryModel.getVersion() of updateSpec is null and the library is being concurrently updated by another user.

ConcurrentChange - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.

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

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary.

update

void update(java.lang.String libraryId,
          LibraryModel updateSpec,
          InvocationConfig invocationConfig)

Updates the properties of a local library.

This is an incremental update to the local library. Properties that are null in the update specification will be left unchanged.

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:

libraryId - Identifier of the local library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the local library.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library specified by libraryId does not exist.

NotAllowedInCurrentState - if the library specified by libraryId is a published library with JSON persistence enabled (see PublishInfo.getPersistJsonEnabled()) and the content of the library has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

InvalidElementType - if the library specified by libraryId is not a local library.

InvalidArgument - if the updateSpec is not valid.

InvalidArgument - if the PublishInfo.getCurrentPassword() in the updateSpec does not match the existing password of the published library.

ResourceBusy - if the LibraryModel.getVersion() of updateSpec is null and the library is being concurrently updated by another user.

ConcurrentChange - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.

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

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary.

update

void update(java.lang.String libraryId,
          LibraryModel updateSpec,
          AsyncCallback<java.lang.Void> asyncCallback)

Updates the properties of a local library.

This is an incremental update to the local library. Properties that are null in the update specification will be left unchanged.

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

Operation Errors:
NotFound - if the library specified by libraryId does not exist.
NotAllowedInCurrentState - if the library specified by libraryId is a published library with JSON persistence enabled (see PublishInfo.getPersistJsonEnabled()) and the content of the library has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.
InvalidElementType - if the library specified by libraryId is not a local library.
InvalidArgument - if the updateSpec is not valid.
InvalidArgument - if the PublishInfo.getCurrentPassword() in the updateSpec does not match the existing password of the published library.
ResourceBusy - if the LibraryModel.getVersion() of updateSpec is null and the library is being concurrently updated by another user.
ConcurrentChange - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary.

Parameters:

libraryId - Identifier of the local library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the local library.

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

update

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

Updates the properties of a local library.

This is an incremental update to the local library. Properties that are null in the update specification will be left unchanged.

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 library specified by libraryId does not exist.
NotAllowedInCurrentState - if the library specified by libraryId is a published library with JSON persistence enabled (see PublishInfo.getPersistJsonEnabled()) and the content of the library has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.
InvalidElementType - if the library specified by libraryId is not a local library.
InvalidArgument - if the updateSpec is not valid.
InvalidArgument - if the PublishInfo.getCurrentPassword() in the updateSpec does not match the existing password of the published library.
ResourceBusy - if the LibraryModel.getVersion() of updateSpec is null and the library is being concurrently updated by another user.
ConcurrentChange - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary.

Parameters:

libraryId - Identifier of the local library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the local library.

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

invocationConfig - Configuration for the method invocation.