com.vmware.vapi.metadata.authentication.service

Interface Operation

All Superinterfaces:

OperationTypes, Service

All Known Implementing Classes:

OperationStub

public interface Operation
extends Service, OperationTypes

The Operation interface provides methods to retrieve authentication information of an operation element.

An operation element is said to contain authentication information if authentication schemes are specified in the authentication definition file.

Field Summary

Fields inherited from interface com.vmware.vapi.metadata.authentication.service.OperationTypes

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
OperationInfo	get(String serviceId, String operationId) Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
void	get(String serviceId, String operationId, AsyncCallback<OperationInfo> asyncCallback) Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
void	get(String serviceId, String operationId, AsyncCallback<OperationInfo> asyncCallback, InvocationConfig invocationConfig) Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
OperationInfo	get(String serviceId, String operationId, InvocationConfig invocationConfig) Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
List<String>	list(String serviceId) Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.
void	list(String serviceId, AsyncCallback<List<String>> asyncCallback) Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.
void	list(String serviceId, AsyncCallback<List<String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.
List<String>	list(String serviceId, InvocationConfig invocationConfig) Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.

Method Detail

list

List<String> list(String serviceId)

Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.

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

Parameters:

serviceId - Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

Returns:

List of identifiers for the operation elements contained in the service element that have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Throws:

NotFound - if the service element associated with serviceId does not have any operation elements that have authentication information.

list

List<String> list(String serviceId,
                InvocationConfig invocationConfig)

Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.

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:

serviceId - Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

invocationConfig - Configuration for the method invocation.

Returns:

List of identifiers for the operation elements contained in the service element that have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Throws:

NotFound - if the service element associated with serviceId does not have any operation elements that have authentication information.

list

void list(String serviceId,
        AsyncCallback<List<String>> asyncCallback)

Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.

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

Operation Result:
List of identifiers for the operation elements contained in the service element that have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Operation Errors:
NotFound - if the service element associated with serviceId does not have any operation elements that have authentication information.

Parameters:

serviceId - Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

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

list

void list(String serviceId,
        AsyncCallback<List<String>> asyncCallback,
        InvocationConfig invocationConfig)

Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.

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:
List of identifiers for the operation elements contained in the service element that have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Operation Errors:
NotFound - if the service element associated with serviceId does not have any operation elements that have authentication information.

Parameters:

serviceId - Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

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

invocationConfig - Configuration for the method invocation.

get

OperationInfo get(String serviceId,
                String operationId)

Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

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

Parameters:

serviceId - Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

operationId - Identifier of the operation element. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

Returns:

The OperationInfo instance that corresponds to operationId.

Throws:

NotFound - if the service element associated with serviceId does not exist.

NotFound - if the operation element associated with operationId does not exist.

NotFound - if the operation element associated with operationId does not have any authentication information.

get

OperationInfo get(String serviceId,
                String operationId,
                InvocationConfig invocationConfig)

Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

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:

serviceId - Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

operationId - Identifier of the operation element. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

invocationConfig - Configuration for the method invocation.

Returns:

The OperationInfo instance that corresponds to operationId.

Throws:

NotFound - if the service element associated with serviceId does not exist.

NotFound - if the operation element associated with operationId does not exist.

NotFound - if the operation element associated with operationId does not have any authentication information.

get

void get(String serviceId,
       String operationId,
       AsyncCallback<OperationInfo> asyncCallback)

Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

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

Operation Result:
The OperationInfo instance that corresponds to operationId.

Operation Errors:
NotFound - if the service element associated with serviceId does not exist.
NotFound - if the operation element associated with operationId does not exist.
NotFound - if the operation element associated with operationId does not have any authentication information.

Parameters:

serviceId - Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

operationId - Identifier of the operation element. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

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

get

void get(String serviceId,
       String operationId,
       AsyncCallback<OperationInfo> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

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 OperationInfo instance that corresponds to operationId.

Operation Errors:
NotFound - if the service element associated with serviceId does not exist.
NotFound - if the operation element associated with operationId does not exist.
NotFound - if the operation element associated with operationId does not have any authentication information.

Parameters:

serviceId - Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

operationId - Identifier of the operation element. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

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

invocationConfig - Configuration for the method invocation.