com.vmware.content

Class LibraryStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.content.LibraryStub

All Implemented Interfaces:

Library, LibraryTypes, Service

public class LibraryStub
extends com.vmware.vapi.internal.bindings.Stub
implements Library

Remote stub implementation of the Library API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.content.LibraryTypes

LibraryTypes.FindSpec

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.content.LibraryTypes

RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
LibraryStub(ApiProvider apiProvider, StubConfigurationBase config)
LibraryStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	find(LibraryTypes.FindSpec spec) Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.
void	find(LibraryTypes.FindSpec spec, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.
void	find(LibraryTypes.FindSpec spec, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.
java.util.List<java.lang.String>	find(LibraryTypes.FindSpec spec, InvocationConfig invocationConfig) Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.
LibraryModel	get(java.lang.String libraryId) Returns a given LibraryModel.
void	get(java.lang.String libraryId, AsyncCallback<LibraryModel> asyncCallback) Returns a given LibraryModel.
void	get(java.lang.String libraryId, AsyncCallback<LibraryModel> asyncCallback, InvocationConfig invocationConfig) Returns a given LibraryModel.
LibraryModel	get(java.lang.String libraryId, InvocationConfig invocationConfig) Returns a given LibraryModel.
java.util.List<java.lang.String>	list() Returns the identifiers of all libraries of any type in the Content Library.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns the identifiers of all libraries of any type in the Content Library.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers of all libraries of any type in the Content Library.
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Returns the identifiers of all libraries of any type in the Content Library.
void	update(java.lang.String libraryId, LibraryModel updateSpec) Updates the properties of a library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback) Updates the properties of a library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the properties of a library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, InvocationConfig invocationConfig) Updates the properties of a library.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LibraryStub

public LibraryStub(ApiProvider apiProvider,
           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
           StubConfigurationBase config)

LibraryStub

public LibraryStub(ApiProvider apiProvider,
           StubConfigurationBase config)

Method Detail

get

public LibraryModel get(java.lang.String libraryId)

Description copied from interface: Library

Returns a given LibraryModel.

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

Specified by:

get in interface Library

Parameters:

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

Returns:

The LibraryModel instance with the specified libraryId.

get

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

Description copied from interface: Library

Returns a given LibraryModel.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Library

Parameters:

libraryId - Identifier of the 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 with the specified libraryId.

get

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

Description copied from interface: Library

Returns a given LibraryModel.

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

Operation Result:
The LibraryModel instance with the specified libraryId.

Operation Errors:
NotFound - if the specified library 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 System.Read.

Specified by:

get in interface Library

Parameters:

libraryId - Identifier of the 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

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

Description copied from interface: Library

Returns a given LibraryModel.

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 with the specified libraryId.

Operation Errors:
NotFound - if the specified library 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 System.Read.

Specified by:

get in interface Library

Parameters:

libraryId - Identifier of the 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

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

Description copied from interface: Library

Returns the identifiers of all libraries of any type in the Content Library.

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

Specified by:

list in interface Library

Returns:

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

list

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

Description copied from interface: Library

Returns the identifiers of all libraries of any type 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.

Specified by:

list in interface Library

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

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

list

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

Description copied from interface: Library

Returns the identifiers of all libraries of any type in the Content Library.

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

Operation Result:
The List of all identifiers of all 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.

Specified by:

list in interface Library

Parameters:

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

list

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

Description copied from interface: Library

Returns the identifiers of all libraries of any type 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 all identifiers of all 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.

Specified by:

list in interface Library

Parameters:

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

invocationConfig - Configuration for the method invocation.

find

public java.util.List<java.lang.String> find(LibraryTypes.FindSpec spec)

Description copied from interface: Library

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.

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

Specified by:

find in interface Library

Parameters:

spec - Specification describing what properties to filter on.

Returns:

The List of identifiers of all the visible libraries matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.Library.

find

public java.util.List<java.lang.String> find(LibraryTypes.FindSpec spec,
                                    InvocationConfig invocationConfig)

Description copied from interface: Library

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

find in interface Library

Parameters:

spec - Specification describing what properties to filter on.

invocationConfig - Configuration for the method invocation.

Returns:

The List of identifiers of all the visible libraries matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.Library.

find

public void find(LibraryTypes.FindSpec spec,
        AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Description copied from interface: Library

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.

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

Operation Result:
The List of identifiers of all the visible libraries matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Operation Errors:
InvalidArgument - if no properties are specified in the spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Specified by:

find in interface Library

Parameters:

spec - Specification describing what properties to filter on.

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

find

public void find(LibraryTypes.FindSpec spec,
        AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: Library

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.

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 the visible libraries matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Operation Errors:
InvalidArgument - if no properties are specified in the spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Specified by:

find in interface Library

Parameters:

spec - Specification describing what properties to filter on.

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

invocationConfig - Configuration for the method invocation.

update

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

Description copied from interface: Library

Updates the properties of a library.

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

This method will only update the common properties for all library types. This will not, for example, update the LibraryModel.getPublishInfo() of a local library, nor the LibraryModel.getSubscriptionInfo() of a subscribed library. Specific properties are updated in LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) and SubscribedLibrary.update(java.lang.String, com.vmware.content.LibraryModel).

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

Specified by:

update in interface Library

Parameters:

libraryId - Identifier of the 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 library.

update

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

Description copied from interface: Library

Updates the properties of a library.

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

This method will only update the common properties for all library types. This will not, for example, update the LibraryModel.getPublishInfo() of a local library, nor the LibraryModel.getSubscriptionInfo() of a subscribed library. Specific properties are updated in LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) and SubscribedLibrary.update(java.lang.String, com.vmware.content.LibraryModel).

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface Library

Parameters:

libraryId - Identifier of the 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 library.

invocationConfig - Configuration for the method invocation.

update

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

Description copied from interface: Library

Updates the properties of a library.

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

This method will only update the common properties for all library types. This will not, for example, update the LibraryModel.getPublishInfo() of a local library, nor the LibraryModel.getSubscriptionInfo() of a subscribed library. Specific properties are updated in LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) and SubscribedLibrary.update(java.lang.String, com.vmware.content.LibraryModel).

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

Operation Errors:
NotFound - if the library associated with libraryId does not exist.
InvalidArgument - if the updateSpec is not valid.
InvalidArgument - 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.UpdateLibrary.

Specified by:

update in interface Library

Parameters:

libraryId - Identifier of the 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 library.

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

update

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

Description copied from interface: Library

Updates the properties of a library.

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

This method will only update the common properties for all library types. This will not, for example, update the LibraryModel.getPublishInfo() of a local library, nor the LibraryModel.getSubscriptionInfo() of a subscribed library. Specific properties are updated in LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) and SubscribedLibrary.update(java.lang.String, com.vmware.content.LibraryModel).

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 associated with libraryId does not exist.
InvalidArgument - if the updateSpec is not valid.
InvalidArgument - 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.UpdateLibrary.

Specified by:

update in interface Library

Parameters:

libraryId - Identifier of the 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 library.

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

invocationConfig - Configuration for the method invocation.