com.vmware.content.library.item

Class FileStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.content.library.item.FileStub

All Implemented Interfaces:

File, FileTypes, Service

public class FileStub
extends com.vmware.vapi.internal.bindings.Stub
implements File

Remote stub implementation of the File API service.

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

Nested Class Summary

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

FileTypes.ChecksumAlgorithm, FileTypes.ChecksumInfo, FileTypes.Info

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
FileTypes.Info	get(java.lang.String libraryItemId, java.lang.String name) Retrieves the information for a single file in a library item by its name.
void	get(java.lang.String libraryItemId, java.lang.String name, AsyncCallback<FileTypes.Info> asyncCallback) Retrieves the information for a single file in a library item by its name.
void	get(java.lang.String libraryItemId, java.lang.String name, AsyncCallback<FileTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves the information for a single file in a library item by its name.
FileTypes.Info	get(java.lang.String libraryItemId, java.lang.String name, InvocationConfig invocationConfig) Retrieves the information for a single file in a library item by its name.
java.util.List<FileTypes.Info>	list(java.lang.String libraryItemId) Lists all of the files that are stored within a given library item.
void	list(java.lang.String libraryItemId, AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback) Lists all of the files that are stored within a given library item.
void	list(java.lang.String libraryItemId, AsyncCallback<java.util.List<FileTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Lists all of the files that are stored within a given library item.
java.util.List<FileTypes.Info>	list(java.lang.String libraryItemId, InvocationConfig invocationConfig) Lists all of the files that are stored within a given library item.

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

FileStub

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

FileStub

public FileStub(ApiProvider apiProvider,
        StubConfigurationBase config)

Method Detail

get

public FileTypes.Info get(java.lang.String libraryItemId,
                 java.lang.String name)

Description copied from interface: File

Retrieves the information for a single file in a library item by its name.

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

Specified by:

get in interface File

Parameters:

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

name - Name of the file in the library item whose information should be returned.

Returns:

The FileTypes.Info object with information on the specified file.

get

public FileTypes.Info get(java.lang.String libraryItemId,
                 java.lang.String name,
                 InvocationConfig invocationConfig)

Description copied from interface: File

Retrieves the information for a single file in a library item by its name.

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 File

Parameters:

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

name - Name of the file in the library item whose information should be returned.

invocationConfig - Configuration for the method invocation.

Returns:

The FileTypes.Info object with information on the specified file.

get

public void get(java.lang.String libraryItemId,
       java.lang.String name,
       AsyncCallback<FileTypes.Info> asyncCallback)

Description copied from interface: File

Retrieves the information for a single file in a library item by its name.

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

Operation Result:
The FileTypes.Info object with information on the specified file.

Operation Errors:
NotFound - if libraryItemId refers to a library item that does not exist.
NotFound - if name refers to a file that does not exist in the library item.
Unauthorized - if you do not have all of the privileges described as follows:

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

Specified by:

get in interface File

Parameters:

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

name - Name of the file in the library item whose information should be returned.

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

get

public void get(java.lang.String libraryItemId,
       java.lang.String name,
       AsyncCallback<FileTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: File

Retrieves the information for a single file in a library item by its name.

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 FileTypes.Info object with information on the specified file.

Operation Errors:
NotFound - if libraryItemId refers to a library item that does not exist.
NotFound - if name refers to a file that does not exist in the library item.
Unauthorized - if you do not have all of the privileges described as follows:

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

Specified by:

get in interface File

Parameters:

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

name - Name of the file in the library item whose information should be returned.

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

invocationConfig - Configuration for the method invocation.

list

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

Description copied from interface: File

Lists all of the files that are stored within a given library item.

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

Specified by:

list in interface File

Parameters:

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

Returns:

The List of all of the files that are stored within the given library item.

list

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

Description copied from interface: File

Lists all of the files that are stored within a given library item.

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

Specified by:

list in interface File

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

The List of all of the files that are stored within the given library item.

list

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

Description copied from interface: File

Lists all of the files that are stored within a given library item.

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

Operation Result:
The List of all of the files that are stored within the given library item.

Operation Errors:
NotFound - if libraryItemId refers to a library item that does not 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.

Specified by:

list in interface File

Parameters:

libraryItemId - Identifier of the library item whose files should be listed. 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.

list

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

Description copied from interface: File

Lists all of the files that are stored within a given library item.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
The List of all of the files that are stored within the given library item.

Operation Errors:
NotFound - if libraryItemId refers to a library item that does not 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.

Specified by:

list in interface File

Parameters:

libraryItemId - Identifier of the library item whose files should be listed. 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.