Package com.xensource.xenapi
Class Certificate
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.Certificate
An X509 certificate used for TLS connections
First published in Citrix Hypervisor 8.2.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a Certificate -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
If obj is a Certificate, compares XenAPI references for equality.static Set<Certificate>
getAll
(Connection c) Return a list of all the Certificates known to the system.static Map<Certificate,
Certificate.Record> Return a map of Certificate references to Certificate records for all Certificates known to the system.static Certificate
getByUuid
(Connection c, String uuid) Get a reference to the Certificate instance with the specified UUID.Deprecated.since 24.19.0Get the fingerprint_sha1 field of the given Certificate.Get the fingerprint_sha256 field of the given Certificate.Get the host field of the given Certificate.Get the name field of the given Certificate.Get the not_after field of the given Certificate.Get the not_before field of the given Certificate.Get a record containing the current state of the given Certificate.Get the type field of the given Certificate.Get the uuid field of the given Certificate.int
hashCode()
Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a Certificate, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public Certificate.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given Certificate. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static Certificate getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the Certificate instance with the specified UUID. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uuid field of the given Certificate. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getName
public String getName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name field of the given Certificate. Minimum allowed role: read-only First published in 1.294.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getType
public Types.CertificateType getType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the type field of the given Certificate. Minimum allowed role: read-only First published in 1.294.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHost
public Host getHost(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host field of the given Certificate. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNotBefore
public Date getNotBefore(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the not_before field of the given Certificate. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNotAfter
public Date getNotAfter(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the not_after field of the given Certificate. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getFingerprint
@Deprecated(since="24.19.0") public String getFingerprint(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 24.19.0Get the fingerprint field of the given Certificate. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getFingerprintSha256
public String getFingerprintSha256(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the fingerprint_sha256 field of the given Certificate. Minimum allowed role: read-only Experimental. First published in 24.20.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getFingerprintSha1
public String getFingerprintSha1(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the fingerprint_sha1 field of the given Certificate. Minimum allowed role: read-only Experimental. First published in 24.20.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAll
public static Set<Certificate> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the Certificates known to the system. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<Certificate,Certificate.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of Certificate references to Certificate records for all Certificates known to the system. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-