com.vmware.vcenter.vcha

Class ConnectionSpec

java.lang.Object

com.vmware.vcenter.vcha.ConnectionSpec

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

public final class ConnectionSpec
extends java.lang.Object
implements java.io.Serializable, StaticStructure

The ConnectionSpec class contains information required to connect to a vCenter server. The connection to the vCenter server always uses the HTTPS protocol. This class was added in vSphere API 6.7.1.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConnectionSpec() Default constructor.
protected	ConnectionSpec(StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(java.lang.Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
java.lang.String	_getCanonicalName() Returns the canonical name of the structure.
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.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
DataValue	_getDynamicField(java.lang.String fieldName) Get dynamic filed value.
java.util.Set<java.lang.String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
com.vmware.vapi.bindings.type.StructType	_getType() WARNING: Internal method, subject to change in future versions.
boolean	_hasTypeNameOf(java.lang.Class<? extends Structure> clazz) Checks if the runtime type name of this structure matches the type represented by the specified binding class.
static ConnectionSpec	_newInstance(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 ConnectionSpec	_newInstance2(StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, DataValue fieldValue) Sets a dynamic field value.
protected void	_updateDataValue(StructValue structValue)
void	_validate() Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
boolean	equals(java.lang.Object obj)
java.lang.String	getHostname() IP Address or DNS of the vCenter.
char[]	getPassword() Password for the specified user.
java.lang.Long	getPort() Port number.
java.lang.String	getSslThumbprint() SHA1 hash of the server SSL certificate.
java.lang.String	getUsername() Username to access the server.
int	hashCode()
void	setHostname(java.lang.String hostname) IP Address or DNS of the vCenter.
void	setPassword(char[] password) Password for the specified user.
void	setPort(java.lang.Long port) Port number.
void	setSslThumbprint(java.lang.String sslThumbprint) SHA1 hash of the server SSL certificate.
void	setUsername(java.lang.String username) Username to access the server.
java.lang.String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

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

Field Detail

__dynamicStructureFields

protected StructValue __dynamicStructureFields

Constructor Detail

ConnectionSpec

public ConnectionSpec()

Default constructor.

ConnectionSpec

protected ConnectionSpec(StructValue __dynamicStructureFields)

Method Detail

getHostname

public java.lang.String getHostname()

IP Address or DNS of the vCenter. This property was added in vSphere API 6.7.1.

Returns:

The current value of the property.

setHostname

public void setHostname(java.lang.String hostname)

IP Address or DNS of the vCenter. This property was added in vSphere API 6.7.1.

Parameters:

hostname - New value for the property.

getPort

public java.lang.Long getPort()

Port number. This property was added in vSphere API 6.7.1. If null, port 443 will be used.

Returns:

The current value of the property.

setPort

public void setPort(java.lang.Long port)

Port number. This property was added in vSphere API 6.7.1. If null, port 443 will be used.

Parameters:

port - New value for the property.

getSslThumbprint

public java.lang.String getSslThumbprint()

SHA1 hash of the server SSL certificate. This property was added in vSphere API 6.7.1. If null, empty ssl thumbprint is assumed.

Returns:

The current value of the property.

setSslThumbprint

public void setSslThumbprint(java.lang.String sslThumbprint)

SHA1 hash of the server SSL certificate. This property was added in vSphere API 6.7.1. If null, empty ssl thumbprint is assumed.

Parameters:

sslThumbprint - New value for the property.

getUsername

public java.lang.String getUsername()

Username to access the server. This property was added in vSphere API 6.7.1. This property is currently required. If null, an error is returned. In the future, if this property is null, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail.

Returns:

The current value of the property.

setUsername

public void setUsername(java.lang.String username)

Username to access the server. This property was added in vSphere API 6.7.1. This property is currently required. If null, an error is returned. In the future, if this property is null, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail.

Parameters:

username - New value for the property.

getPassword

public char[] getPassword()

Password for the specified user. This property was added in vSphere API 6.7.1. This property is currently required. If null, an empty password is assumed. In the future, if this property is null, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail.

Returns:

The current value of the property.

setPassword

public void setPassword(char[] password)

Password for the specified user. This property was added in vSphere API 6.7.1. This property is currently required. If null, an empty password is assumed. In the future, if this property is null, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail.

Parameters:

password - New value for the property.

_getType

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

Description copied from interface: StaticStructure

WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.

Specified by:

_getType in interface StaticStructure

Returns:

the static bindings StructType

_getDataValue

public StructValue _getDataValue()

Description copied from interface: Structure

Returns this Structure represented in the dynamic DataValue model.

Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.

Specified by:

_getDataValue in interface Structure

Returns:

StructValue representing this structure

_updateDataValue

protected void _updateDataValue(StructValue structValue)

_validate

public void _validate()

Description copied from interface: StaticStructure

Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.

More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:

all fields of the union required for that value of the discriminant are set fields of the union that are not allowed for that value of the discriminant are not set any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:

_validate in interface 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()

Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.

In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)

Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.

This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo

public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)

Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)

Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField

public DataValue _getDynamicField(java.lang.String fieldName)

Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames

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

Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_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()

Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static ConnectionSpec _newInstance(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 ConnectionSpec _newInstance2(StructValue structValue)

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