com.vmware.vcenter.certificate_management.vcenter

Class TlsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.certificate_management.vcenter.TlsStub

All Implemented Interfaces:

Service, Tls, TlsTypes

public class TlsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Tls

Remote stub implementation of the Tls API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.certificate_management.vcenter.TlsTypes

TlsTypes.Info, TlsTypes.ReplaceSpec, TlsTypes.Spec

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.certificate_management.vcenter.TlsTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TlsTypes.Info	get() Returns the rhttpproxy TLS certificate.
void	get(AsyncCallback<TlsTypes.Info> asyncCallback) Returns the rhttpproxy TLS certificate.
void	get(AsyncCallback<TlsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the rhttpproxy TLS certificate.
TlsTypes.Info	get(InvocationConfig invocationConfig) Returns the rhttpproxy TLS certificate.
void	renew(java.lang.Long duration) Renews the TLS certificate for the given duration period.
void	renew(java.lang.Long duration, AsyncCallback<java.lang.Void> asyncCallback) Renews the TLS certificate for the given duration period.
void	renew(java.lang.Long duration, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Renews the TLS certificate for the given duration period.
void	renew(java.lang.Long duration, InvocationConfig invocationConfig) Renews the TLS certificate for the given duration period.
void	replaceVmcaSigned(TlsTypes.ReplaceSpec spec) Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	replaceVmcaSigned(TlsTypes.ReplaceSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	replaceVmcaSigned(TlsTypes.ReplaceSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	replaceVmcaSigned(TlsTypes.ReplaceSpec spec, InvocationConfig invocationConfig) Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	set(TlsTypes.Spec spec) Replaces the rhttpproxy TLS certificate with the specified certificate.
void	set(TlsTypes.Spec spec, AsyncCallback<java.lang.Void> asyncCallback) Replaces the rhttpproxy TLS certificate with the specified certificate.
void	set(TlsTypes.Spec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Replaces the rhttpproxy TLS certificate with the specified certificate.
void	set(TlsTypes.Spec spec, InvocationConfig invocationConfig) Replaces the rhttpproxy TLS certificate with the specified certificate.

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

TlsStub

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

TlsStub

public TlsStub(ApiProvider apiProvider,
               StubConfigurationBase config)

Method Detail

set

public void set(TlsTypes.Spec spec)

Description copied from interface: Tls

Replaces the rhttpproxy TLS certificate with the specified certificate. This method can be used in three scenarios :

1. When the CSR is created and the private key is already stored, this method can replace the certificate. The certificate but not the private key and root certificate must be provided as input.
2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this method can replace the certificate and private key. The certificate and the private key but not the root certificate must be provided as input.
3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this method can replace the certificate, private key and root CA certificate. The certificate, private key and root certificate must be provided as input.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

The above three scenarios are only supported from vsphere 7.0 onwards.

. This method was added in vSphere API 6.7.2.

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

Specified by:

set in interface Tls

Parameters:

spec - The information needed to replace the TLS certificate.

set

public void set(TlsTypes.Spec spec,
                InvocationConfig invocationConfig)

Description copied from interface: Tls

Replaces the rhttpproxy TLS certificate with the specified certificate. This method can be used in three scenarios :

1. When the CSR is created and the private key is already stored, this method can replace the certificate. The certificate but not the private key and root certificate must be provided as input.
2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this method can replace the certificate and private key. The certificate and the private key but not the root certificate must be provided as input.
3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this method can replace the certificate, private key and root CA certificate. The certificate, private key and root certificate must be provided as input.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

The above three scenarios are only supported from vsphere 7.0 onwards.

. This method was added in vSphere API 6.7.2.

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:

set in interface Tls

Parameters:

spec - The information needed to replace the TLS certificate.

invocationConfig - Configuration for the method invocation.

set

public void set(TlsTypes.Spec spec,
                AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Tls

Replaces the rhttpproxy TLS certificate with the specified certificate. This method can be used in three scenarios :

1. When the CSR is created and the private key is already stored, this method can replace the certificate. The certificate but not the private key and root certificate must be provided as input.
2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this method can replace the certificate and private key. The certificate and the private key but not the root certificate must be provided as input.
3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this method can replace the certificate, private key and root CA certificate. The certificate, private key and root certificate must be provided as input.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

The above three scenarios are only supported from vsphere 7.0 onwards.

. This method was added in vSphere API 6.7.2.

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

Operation Errors:
NotFound - If the private key is not present in the VECS store.
AlreadyExists - If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.
Error - If the system failed to replace the TLS certificate.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Specified by:

set in interface Tls

Parameters:

spec - The information needed to replace the TLS certificate.

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

set

public void set(TlsTypes.Spec spec,
                AsyncCallback<java.lang.Void> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Tls

Replaces the rhttpproxy TLS certificate with the specified certificate. This method can be used in three scenarios :

1. When the CSR is created and the private key is already stored, this method can replace the certificate. The certificate but not the private key and root certificate must be provided as input.
2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this method can replace the certificate and private key. The certificate and the private key but not the root certificate must be provided as input.
3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this method can replace the certificate, private key and root CA certificate. The certificate, private key and root certificate must be provided as input.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

The above three scenarios are only supported from vsphere 7.0 onwards.

. This method was added in vSphere API 6.7.2.

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 private key is not present in the VECS store.
AlreadyExists - If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.
Error - If the system failed to replace the TLS certificate.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Specified by:

set in interface Tls

Parameters:

spec - The information needed to replace the TLS certificate.

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

invocationConfig - Configuration for the method invocation.

get

public TlsTypes.Info get()

Description copied from interface: Tls

Returns the rhttpproxy TLS certificate. This method was added in vSphere API 6.7.2.

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

Specified by:

get in interface Tls

Returns:

TLS certificate.

get

public TlsTypes.Info get(InvocationConfig invocationConfig)

Description copied from interface: Tls

Returns the rhttpproxy TLS certificate. This method was added in vSphere API 6.7.2.

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 Tls

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

TLS certificate.

get

public void get(AsyncCallback<TlsTypes.Info> asyncCallback)

Description copied from interface: Tls

Returns the rhttpproxy TLS certificate. This method was added in vSphere API 6.7.2.

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

Invocation Result:
TLS certificate.

Operation Errors:
NotFound - if the rhttpproxy certificate is not present in VECS store.
Error - if failed due to generic exception.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Specified by:

get in interface Tls

Parameters:

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

get

public void get(AsyncCallback<TlsTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Tls

Returns the rhttpproxy TLS certificate. This method was added in vSphere API 6.7.2.

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:
TLS certificate.

Operation Errors:
NotFound - if the rhttpproxy certificate is not present in VECS store.
Error - if failed due to generic exception.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Specified by:

get in interface Tls

Parameters:

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

invocationConfig - Configuration for the method invocation.

renew

public void renew(java.lang.Long duration)

Description copied from interface: Tls

Renews the TLS certificate for the given duration period.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.7.2.

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

Specified by:

renew in interface Tls

Parameters:

duration - The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If null, the duration will be 730 days (two years).

renew

public void renew(java.lang.Long duration,
                  InvocationConfig invocationConfig)

Description copied from interface: Tls

Renews the TLS certificate for the given duration period.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.7.2.

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:

renew in interface Tls

Parameters:

duration - The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If null, the duration will be 730 days (two years).

invocationConfig - Configuration for the method invocation.

renew

public void renew(java.lang.Long duration,
                  AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Tls

Renews the TLS certificate for the given duration period.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.7.2.

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

Operation Errors:
Unsupported - If the TLS certificate is not VMCA generated.
InvalidArgument - If the duration period specified is invalid.
Error - If the system failed to renew the TLS certificate.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Specified by:

renew in interface Tls

Parameters:

duration - The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If null, the duration will be 730 days (two years).

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

renew

public void renew(java.lang.Long duration,
                  AsyncCallback<java.lang.Void> asyncCallback,
                  InvocationConfig invocationConfig)

Description copied from interface: Tls

Renews the TLS certificate for the given duration period.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.7.2.

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:
Unsupported - If the TLS certificate is not VMCA generated.
InvalidArgument - If the duration period specified is invalid.
Error - If the system failed to renew the TLS certificate.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Specified by:

renew in interface Tls

Parameters:

duration - The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If null, the duration will be 730 days (two years).

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

invocationConfig - Configuration for the method invocation.

replaceVmcaSigned

public void replaceVmcaSigned(TlsTypes.ReplaceSpec spec)

Description copied from interface: Tls

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.9.1.

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

Specified by:

replaceVmcaSigned in interface Tls

Parameters:

spec - The information needed to generate VMCA signed Machine SSL

replaceVmcaSigned

public void replaceVmcaSigned(TlsTypes.ReplaceSpec spec,
                              InvocationConfig invocationConfig)

Description copied from interface: Tls

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.9.1.

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:

replaceVmcaSigned in interface Tls

Parameters:

spec - The information needed to generate VMCA signed Machine SSL

invocationConfig - Configuration for the method invocation.

replaceVmcaSigned

public void replaceVmcaSigned(TlsTypes.ReplaceSpec spec,
                              AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Tls

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.9.1.

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

Operation Errors:
InvalidArgument - If the Spec given is not complete or invalid
Error - If the system failed to replace the machine ssl certificate
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Specified by:

replaceVmcaSigned in interface Tls

Parameters:

spec - The information needed to generate VMCA signed Machine SSL

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

replaceVmcaSigned

public void replaceVmcaSigned(TlsTypes.ReplaceSpec spec,
                              AsyncCallback<java.lang.Void> asyncCallback,
                              InvocationConfig invocationConfig)

Description copied from interface: Tls

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.9.1.

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:
InvalidArgument - If the Spec given is not complete or invalid
Error - If the system failed to replace the machine ssl certificate
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Specified by:

replaceVmcaSigned in interface Tls

Parameters:

spec - The information needed to generate VMCA signed Machine SSL

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

invocationConfig - Configuration for the method invocation.