com.vmware.content.library

Interface SubscribedItem

All Superinterfaces:

Service, SubscribedItemTypes

All Known Implementing Classes:

SubscribedItemStub

public interface SubscribedItem
extends Service, SubscribedItemTypes

The SubscribedItem interface manages the unique features of library items that are members of a subscribed library.

Field Summary

Fields inherited from interface com.vmware.content.library.SubscribedItemTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	evict(java.lang.String libraryItemId) Evicts the cached content of a library item in a subscribed library.
void	evict(java.lang.String libraryItemId, AsyncCallback<java.lang.Void> asyncCallback) Evicts the cached content of a library item in a subscribed library.
void	evict(java.lang.String libraryItemId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Evicts the cached content of a library item in a subscribed library.
void	evict(java.lang.String libraryItemId, InvocationConfig invocationConfig) Evicts the cached content of a library item in a subscribed library.
void	sync(java.lang.String libraryItemId, boolean forceSyncContent) Forces the synchronization of an individual library item in a subscribed library.
void	sync(java.lang.String libraryItemId, boolean forceSyncContent, AsyncCallback<java.lang.Void> asyncCallback) Forces the synchronization of an individual library item in a subscribed library.
void	sync(java.lang.String libraryItemId, boolean forceSyncContent, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Forces the synchronization of an individual library item in a subscribed library.
void	sync(java.lang.String libraryItemId, boolean forceSyncContent, InvocationConfig invocationConfig) Forces the synchronization of an individual library item in a subscribed library.

Method Detail

evict

void evict(java.lang.String libraryItemId)

Evicts the cached content of a library item in a subscribed library.

This method allows the cached content of a library item to be removed to free up storage capacity. This method will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set ItemModel.getCached() to false.

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

Parameters:

libraryItemId - Identifier of the library item whose content should be evicted. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Throws:

NotFound - if the library item specified by libraryItemId does not exist.

InvalidElementType - if the library item specified by libraryItemId is not a member of a subscribed library.

InvalidElementConfiguration - if the library item specified by libraryItemId is a member of a subscribed library that does not synchronize on-demand.

NotAllowedInCurrentState - if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

For instance, this {@term error) is reported on evicting a library item in an on-demand subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.

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 ContentLibrary.EvictLibraryItem.

evict

void evict(java.lang.String libraryItemId,
           InvocationConfig invocationConfig)

Evicts the cached content of a library item in a subscribed library.

This method allows the cached content of a library item to be removed to free up storage capacity. This method will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set ItemModel.getCached() to false.

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 - Identifier of the library item whose content should be evicted. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library item specified by libraryItemId does not exist.

InvalidElementType - if the library item specified by libraryItemId is not a member of a subscribed library.

InvalidElementConfiguration - if the library item specified by libraryItemId is a member of a subscribed library that does not synchronize on-demand.

NotAllowedInCurrentState - if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

For instance, this {@term error) is reported on evicting a library item in an on-demand subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.

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 ContentLibrary.EvictLibraryItem.

evict

void evict(java.lang.String libraryItemId,
           AsyncCallback<java.lang.Void> asyncCallback)

Evicts the cached content of a library item in a subscribed library.

This method allows the cached content of a library item to be removed to free up storage capacity. This method will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set ItemModel.getCached() to false.

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

Operation Errors:
NotFound - if the library item specified by libraryItemId does not exist.
InvalidElementType - if the library item specified by libraryItemId is not a member of a subscribed library.
InvalidElementConfiguration - if the library item specified by libraryItemId is a member of a subscribed library that does not synchronize on-demand.
NotAllowedInCurrentState - if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

For instance, this error) is reported on evicting a library item in an on-demand subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.

{@link com.vmware.vapi.std.errors.Unauthorized} - if you do not have all of the privileges described as follows:

• The resource {@code com.vmware.content.library.Item} referenced by the parameter {@code libraryItemId} requires {@code ContentLibrary.EvictLibraryItem}.

Parameters:

libraryItemId - Identifier of the library item whose content should be evicted. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

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

evict

void evict(java.lang.String libraryItemId,
           AsyncCallback<java.lang.Void> asyncCallback,
           InvocationConfig invocationConfig)

Evicts the cached content of a library item in a subscribed library.

This method allows the cached content of a library item to be removed to free up storage capacity. This method will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set ItemModel.getCached() to false.

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 item specified by libraryItemId does not exist.
InvalidElementType - if the library item specified by libraryItemId is not a member of a subscribed library.
InvalidElementConfiguration - if the library item specified by libraryItemId is a member of a subscribed library that does not synchronize on-demand.
NotAllowedInCurrentState - if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

For instance, this error) is reported on evicting a library item in an on-demand subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.

{@link com.vmware.vapi.std.errors.Unauthorized} - if you do not have all of the privileges described as follows:

• The resource {@code com.vmware.content.library.Item} referenced by the parameter {@code libraryItemId} requires {@code ContentLibrary.EvictLibraryItem}.

Parameters:

libraryItemId - Identifier of the library item whose content should be evicted. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

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

invocationConfig - Configuration for the method invocation.

sync

void sync(java.lang.String libraryItemId,
          boolean forceSyncContent)

Forces the synchronization of an individual library item in a subscribed library.

Synchronizing an individual item will update that item's metadata from the remote source. If the source library item on the remote library has been deleted, this method will delete the library item from the subscribed library as well.

The default behavior of the synchronization is determined by the SubscriptionInfo of the library which owns the library item.

• If SubscriptionInfo.getOnDemand() is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the forceSyncContent parameter.
• If SubscriptionInfo.getOnDemand() is false, then this call will always synchronize the file content. The forceSyncContent parameter is ignored when the subscription is not on-demand.

When the file content has been synchronized, the ItemModel.getCached() property will be true.

This method will return immediately and create an asynchronous task to perform the synchronization.

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

Parameters:

libraryItemId - Identifier of the library item to synchronize. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

forceSyncContent - Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.

Throws:

NotFound - if the library item specified by libraryItemId could not be found.

InvalidElementType - if the library item specified by libraryItemId is not a member of a subscribed library.

NotAllowedInCurrentState - if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

For instance, this {@term error) is reported on synchronizing a library item in a subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.

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 ContentLibrary.SyncLibraryItem.

sync

void sync(java.lang.String libraryItemId,
          boolean forceSyncContent,
          InvocationConfig invocationConfig)

Forces the synchronization of an individual library item in a subscribed library.

Synchronizing an individual item will update that item's metadata from the remote source. If the source library item on the remote library has been deleted, this method will delete the library item from the subscribed library as well.

The default behavior of the synchronization is determined by the SubscriptionInfo of the library which owns the library item.

• If SubscriptionInfo.getOnDemand() is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the forceSyncContent parameter.
• If SubscriptionInfo.getOnDemand() is false, then this call will always synchronize the file content. The forceSyncContent parameter is ignored when the subscription is not on-demand.

When the file content has been synchronized, the ItemModel.getCached() property will be true.

This method will return immediately and create an asynchronous task to perform the synchronization.

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

forceSyncContent - Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library item specified by libraryItemId could not be found.

InvalidElementType - if the library item specified by libraryItemId is not a member of a subscribed library.

NotAllowedInCurrentState - if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

For instance, this {@term error) is reported on synchronizing a library item in a subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.

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 ContentLibrary.SyncLibraryItem.

sync

void sync(java.lang.String libraryItemId,
          boolean forceSyncContent,
          AsyncCallback<java.lang.Void> asyncCallback)

Forces the synchronization of an individual library item in a subscribed library.

Synchronizing an individual item will update that item's metadata from the remote source. If the source library item on the remote library has been deleted, this method will delete the library item from the subscribed library as well.

The default behavior of the synchronization is determined by the SubscriptionInfo of the library which owns the library item.

• If SubscriptionInfo.getOnDemand() is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the forceSyncContent parameter.
• If SubscriptionInfo.getOnDemand() is false, then this call will always synchronize the file content. The forceSyncContent parameter is ignored when the subscription is not on-demand.

When the file content has been synchronized, the ItemModel.getCached() property will be true.

This method will return immediately and create an asynchronous task to perform the synchronization.

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

Operation Errors:
NotFound - if the library item specified by libraryItemId could not be found.
InvalidElementType - if the library item specified by libraryItemId is not a member of a subscribed library.
NotAllowedInCurrentState - if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

For instance, this error) is reported on synchronizing a library item in a subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.

{@link com.vmware.vapi.std.errors.Unauthorized} - if you do not have all of the privileges described as follows:

• The resource {@code com.vmware.content.library.Item} referenced by the parameter {@code libraryItemId} requires {@code ContentLibrary.SyncLibraryItem}.

Parameters:

libraryItemId - Identifier of the library item to synchronize. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

forceSyncContent - Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.

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

sync

void sync(java.lang.String libraryItemId,
          boolean forceSyncContent,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Forces the synchronization of an individual library item in a subscribed library.

Synchronizing an individual item will update that item's metadata from the remote source. If the source library item on the remote library has been deleted, this method will delete the library item from the subscribed library as well.

The default behavior of the synchronization is determined by the SubscriptionInfo of the library which owns the library item.

• If SubscriptionInfo.getOnDemand() is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the forceSyncContent parameter.
• If SubscriptionInfo.getOnDemand() is false, then this call will always synchronize the file content. The forceSyncContent parameter is ignored when the subscription is not on-demand.

When the file content has been synchronized, the ItemModel.getCached() property will be true.

This method will return immediately and create an asynchronous task to perform the synchronization.

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 item specified by libraryItemId could not be found.
InvalidElementType - if the library item specified by libraryItemId is not a member of a subscribed library.
NotAllowedInCurrentState - if the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

For instance, this error) is reported on synchronizing a library item in a subscribed library that was restored from backup, and the library item was deleted after backup, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library item is present on a restore, while its content has been deleted.

{@link com.vmware.vapi.std.errors.Unauthorized} - if you do not have all of the privileges described as follows:

• The resource {@code com.vmware.content.library.Item} referenced by the parameter {@code libraryItemId} requires {@code ContentLibrary.SyncLibraryItem}.

Parameters:

libraryItemId - Identifier of the library item to synchronize. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

forceSyncContent - Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.

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

invocationConfig - Configuration for the method invocation.