com.vmware.vapi.metadata.authentication

Interface Service

All Superinterfaces:

Service, ServiceTypes

public interface Service
extends Service, ServiceTypes

The Service interface provides methods to retrieve authentication information of a service element.

A service element is said to contain authentication information if there is a default authentication assigned to all operation elements contained in a service element or if one of the operation elements contained in this service element has authentication information.

Field Summary

Fields inherited from interface com.vmware.vapi.metadata.authentication.ServiceTypes

RESOURCE_TYPE

Method Summary

Methods

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

Method Detail

list

List<String> list()

Returns the identifiers for the service elements that have authentication information.

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

Returns:

The list of identifiers for the service elements that have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.service.

list

List<String> list(InvocationConfig invocationConfig)

Returns the identifiers for the service elements 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:

invocationConfig - Configuration for the method invocation.

Returns:

The list of identifiers for the service elements that have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.service.

list

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

Returns the identifiers for the service elements that have authentication information.

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

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

Parameters:

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

list

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

ServiceInfo get(String serviceId)

Retrieves authentication information about 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.

Returns:

The ServiceInfo instance that corresponds to serviceId

Throws:

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

get

ServiceInfo get(String serviceId,
              InvocationConfig invocationConfig)

Retrieves authentication information about 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.

invocationConfig - Configuration for the method invocation.

Returns:

The ServiceInfo instance that corresponds to serviceId

Throws:

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

get

void get(String serviceId,
       AsyncCallback<ServiceInfo> asyncCallback)

Retrieves authentication information about the service element corresponding to serviceId.

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

Operation Result:
The ServiceInfo instance that corresponds to serviceId

Operation Errors:
NotFound - if the service element associated with serviceId 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.

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

get

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

Retrieves authentication information about 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 ServiceInfo instance that corresponds to serviceId

Operation Errors:
NotFound - if the service element associated with serviceId 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.

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

invocationConfig - Configuration for the method invocation.