com.vmware.vcenter.identity

Class ProvidersStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.identity.ProvidersStub

All Implemented Interfaces:

Service, Providers, ProvidersTypes

public class ProvidersStub
extends com.vmware.vapi.internal.bindings.Stub
implements Providers

Remote stub implementation of the Providers API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.identity.ProvidersTypes

ProvidersTypes.ActiveDirectoryOverLdap, ProvidersTypes.ConfigType, ProvidersTypes.CreateSpec, ProvidersTypes.IdmProtocol, ProvidersTypes.Info, ProvidersTypes.Oauth2AuthenticationMethod, ProvidersTypes.Oauth2CreateSpec, ProvidersTypes.Oauth2Info, ProvidersTypes.Oauth2Summary, ProvidersTypes.Oauth2UpdateSpec, ProvidersTypes.OidcCreateSpec, ProvidersTypes.OidcInfo, ProvidersTypes.OidcSummary, ProvidersTypes.OidcUpdateSpec, ProvidersTypes.Summary, ProvidersTypes.UpdateSpec

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vcenter.identity.ProvidersTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(ProvidersTypes.CreateSpec spec) Create a vCenter Server identity provider.
void	create(ProvidersTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Create a vCenter Server identity provider.
void	create(ProvidersTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Create a vCenter Server identity provider.
java.lang.String	create(ProvidersTypes.CreateSpec spec, InvocationConfig invocationConfig) Create a vCenter Server identity provider.
void	delete(java.lang.String provider) Delete a vCenter Server identity provider.
void	delete(java.lang.String provider, AsyncCallback<java.lang.Void> asyncCallback) Delete a vCenter Server identity provider.
void	delete(java.lang.String provider, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete a vCenter Server identity provider.
void	delete(java.lang.String provider, InvocationConfig invocationConfig) Delete a vCenter Server identity provider.
ProvidersTypes.Info	get(java.lang.String provider) Retrieve detailed information of the specified identity provider.
void	get(java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback) Retrieve detailed information of the specified identity provider.
void	get(java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieve detailed information of the specified identity provider.
ProvidersTypes.Info	get(java.lang.String provider, InvocationConfig invocationConfig) Retrieve detailed information of the specified identity provider.
java.util.List<ProvidersTypes.Summary>	list() Retrieve all identity providers.
void	list(AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback) Retrieve all identity providers.
void	list(AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Retrieve all identity providers.
java.util.List<ProvidersTypes.Summary>	list(InvocationConfig invocationConfig) Retrieve all identity providers.
void	update(java.lang.String provider, ProvidersTypes.UpdateSpec spec) Update a vCenter Server identity provider.
void	update(java.lang.String provider, ProvidersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Update a vCenter Server identity provider.
void	update(java.lang.String provider, ProvidersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update a vCenter Server identity provider.
void	update(java.lang.String provider, ProvidersTypes.UpdateSpec spec, InvocationConfig invocationConfig) Update a vCenter Server identity provider.

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

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProvidersStub

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

ProvidersStub

public ProvidersStub(ApiProvider apiProvider,
                     StubConfigurationBase config)

Method Detail

list

public java.util.List<ProvidersTypes.Summary> list()

Description copied from interface: Providers

Retrieve all identity providers. This method was added in vSphere API 7.0.0.0.

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

Specified by:

list in interface Providers

Returns:

Commonly used information about the identity providers.

list

public java.util.List<ProvidersTypes.Summary> list(InvocationConfig invocationConfig)

Description copied from interface: Providers

Retrieve all identity providers. This method was added in vSphere API 7.0.0.0.

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 Providers

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the identity providers.

list

public void list(AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback)

Description copied from interface: Providers

Retrieve all identity providers. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
Commonly used information about the identity providers.

Operation Errors:
Unauthorized - if authorization is not given to caller.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Specified by:

list in interface Providers

Parameters:

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

list

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

Description copied from interface: Providers

Retrieve all identity providers. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
Commonly used information about the identity providers.

Operation Errors:
Unauthorized - if authorization is not given to caller.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Specified by:

list in interface Providers

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

public ProvidersTypes.Info get(java.lang.String provider)

Description copied from interface: Providers

Retrieve detailed information of the specified identity provider. This method was added in vSphere API 7.0.0.0.

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

Specified by:

get in interface Providers

Parameters:

provider - the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Returns:

Detailed information of the specified identity provider.

get

public ProvidersTypes.Info get(java.lang.String provider,
                               InvocationConfig invocationConfig)

Description copied from interface: Providers

Retrieve detailed information of the specified identity provider. This method was added in vSphere API 7.0.0.0.

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 Providers

Parameters:

provider - the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

invocationConfig - Configuration for the method invocation.

Returns:

Detailed information of the specified identity provider.

get

public void get(java.lang.String provider,
                AsyncCallback<ProvidersTypes.Info> asyncCallback)

Description copied from interface: Providers

Retrieve detailed information of the specified identity provider. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
Detailed information of the specified identity provider.

Operation Errors:
Unauthorized - if authorization is not given to caller.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Specified by:

get in interface Providers

Parameters:

provider - the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

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

get

public void get(java.lang.String provider,
                AsyncCallback<ProvidersTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Providers

Retrieve detailed information of the specified identity provider. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
Detailed information of the specified identity provider.

Operation Errors:
Unauthorized - if authorization is not given to caller.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Specified by:

get in interface Providers

Parameters:

provider - the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

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

invocationConfig - Configuration for the method invocation.

create

public java.lang.String create(ProvidersTypes.CreateSpec spec)

Description copied from interface: Providers

Create a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Specified by:

create in interface Providers

Parameters:

spec - the CreateSpec contains the information used to create the provider

Returns:

The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

create

public java.lang.String create(ProvidersTypes.CreateSpec spec,
                               InvocationConfig invocationConfig)

Description copied from interface: Providers

Create a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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:

create in interface Providers

Parameters:

spec - the CreateSpec contains the information used to create the provider

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

create

public void create(ProvidersTypes.CreateSpec spec,
                   AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Providers

Create a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Operation Errors:
Unauthorized - if authorization is not given to caller.
InvalidArgument - if invalid arguments are provided in createSpec.
AlreadyExists - if provider exists for provider ID in given spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Create and VcIdentityProviders.Manage.

Specified by:

create in interface Providers

Parameters:

spec - the CreateSpec contains the information used to create the provider

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

create

public void create(ProvidersTypes.CreateSpec spec,
                   AsyncCallback<java.lang.String> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Providers

Create a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Operation Errors:
Unauthorized - if authorization is not given to caller.
InvalidArgument - if invalid arguments are provided in createSpec.
AlreadyExists - if provider exists for provider ID in given spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Create and VcIdentityProviders.Manage.

Specified by:

create in interface Providers

Parameters:

spec - the CreateSpec contains the information used to create the provider

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 provider,
                   ProvidersTypes.UpdateSpec spec)

Description copied from interface: Providers

Update a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Specified by:

update in interface Providers

Parameters:

provider - the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

spec - the UpdateSpec contains the information used to update the provider

update

public void update(java.lang.String provider,
                   ProvidersTypes.UpdateSpec spec,
                   InvocationConfig invocationConfig)

Description copied from interface: Providers

Update a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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 Providers

Parameters:

provider - the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

spec - the UpdateSpec contains the information used to update the provider

invocationConfig - Configuration for the method invocation.

update

public void update(java.lang.String provider,
                   ProvidersTypes.UpdateSpec spec,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Providers

Update a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Operation Errors:
Unauthorized - if authorization is not given to caller.
InvalidArgument - if invalid arguments are provided in updateSpec.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Specified by:

update in interface Providers

Parameters:

provider - the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

spec - the UpdateSpec contains the information used to update the provider

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

update

public void update(java.lang.String provider,
                   ProvidersTypes.UpdateSpec spec,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Providers

Update a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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:
Unauthorized - if authorization is not given to caller.
InvalidArgument - if invalid arguments are provided in updateSpec.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Specified by:

update in interface Providers

Parameters:

provider - the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

spec - the UpdateSpec contains the information used to update the provider

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String provider)

Description copied from interface: Providers

Delete a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Specified by:

delete in interface Providers

Parameters:

provider - the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

delete

public void delete(java.lang.String provider,
                   InvocationConfig invocationConfig)

Description copied from interface: Providers

Delete a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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:

delete in interface Providers

Parameters:

provider - the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String provider,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Providers

Delete a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Operation Errors:
Unauthorized - if authorization is not given to caller.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Specified by:

delete in interface Providers

Parameters:

provider - the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

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

delete

public void delete(java.lang.String provider,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Providers

Delete a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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:
Unauthorized - if authorization is not given to caller.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Specified by:

delete in interface Providers

Parameters:

provider - the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

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

invocationConfig - Configuration for the method invocation.