com.vmware.vcenter.ovf

Class CertificateParams

java.lang.Object

com.vmware.vcenter.ovf.CertificateParams

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class CertificateParams
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The CertificateParams class contains information about the public key certificate used to sign the OVF package. This class will only be returned if the OVF package is signed.

See LibraryItem.deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec) and LibraryItem.filter(java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CertificateParams.Builder Builder class for CertificateParams.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	CertificateParams() Default constructor.
protected	CertificateParams(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static CertificateParams	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static CertificateParams	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getIsSelfSigned() Is the certificate self-signed.
java.lang.String	getIssuer() Certificate issuer.
java.lang.Boolean	getIsValid() Is the certificate chain validated.
java.lang.String	getSubject() Certificate subject.
java.lang.String	getType() Unique identifier describing the type of the OVF parameters.
java.util.List<WarningInfo>	getWarnings() The list of warnings raised for the OVF certificate used in this OVF package deployment.
java.lang.String	getX509() The X509 representation of the certificate.
int	hashCode()
void	setIsSelfSigned(java.lang.Boolean isSelfSigned) Is the certificate self-signed.
void	setIssuer(java.lang.String issuer) Certificate issuer.
void	setIsValid(java.lang.Boolean isValid) Is the certificate chain validated.
void	setSubject(java.lang.String subject) Certificate subject.
void	setType(java.lang.String type) Unique identifier describing the type of the OVF parameters.
void	setWarnings(java.util.List<WarningInfo> warnings) The list of warnings raised for the OVF certificate used in this OVF package deployment.
void	setX509(java.lang.String x509) The X509 representation of the certificate.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

CertificateParams

public CertificateParams()

Default constructor.

CertificateParams

protected CertificateParams(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getIssuer

public java.lang.String getIssuer()

Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setIssuer

public void setIssuer(java.lang.String issuer)

Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

issuer - New value for the property.

getSubject

public java.lang.String getSubject()

Certificate subject. For example: /C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setSubject

public void setSubject(java.lang.String subject)

Certificate subject. For example: /C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

subject - New value for the property.

getIsValid

public java.lang.Boolean getIsValid()

Is the certificate chain validated. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setIsValid

public void setIsValid(java.lang.Boolean isValid)

Is the certificate chain validated. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

isValid - New value for the property.

getIsSelfSigned

public java.lang.Boolean getIsSelfSigned()

Is the certificate self-signed. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setIsSelfSigned

public void setIsSelfSigned(java.lang.Boolean isSelfSigned)

Is the certificate self-signed. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

isSelfSigned - New value for the property.

getX509

public java.lang.String getX509()

The X509 representation of the certificate. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setX509

public void setX509(java.lang.String x509)

The X509 representation of the certificate. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

x509 - New value for the property.

getWarnings

public java.util.List<WarningInfo> getWarnings()

The list of warnings raised for the OVF certificate used in this OVF package deployment. Any warning that is not ignored by the client will cause the OVF package deployment to fail. This property was added in vSphere API 7.0.2.0. This property is set only if the certificate has warnings when retrieving information about an OVF package by LibraryItem.filter(java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget). When the property is set, the WarningInfo.getIgnored() property can be updated before the OVF parameter is passed to LibraryItem.deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec) to deploy the OVF package.

Returns:

The current value of the property.

setWarnings

public void setWarnings(java.util.List<WarningInfo> warnings)

The list of warnings raised for the OVF certificate used in this OVF package deployment. Any warning that is not ignored by the client will cause the OVF package deployment to fail. This property was added in vSphere API 7.0.2.0. This property is set only if the certificate has warnings when retrieving information about an OVF package by LibraryItem.filter(java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget). When the property is set, the WarningInfo.getIgnored() property can be updated before the OVF parameter is passed to LibraryItem.deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec) to deploy the OVF package.

Parameters:

warnings - New value for the property.

getType

public java.lang.String getType()

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Returns:

The current value of the property.

setType

public void setType(java.lang.String type)

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

Parameters:

type - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

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

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static CertificateParams _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static CertificateParams _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.