Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.pki

Class Certificate

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,Certificate>

com.aoindustries.aoserv.client.CachedObject<Integer,Certificate>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<Certificate>

com.aoindustries.aoserv.client.pki.Certificate

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, SingleTableObject<Integer,Certificate>

public final class Certificate
extends CachedObjectIntegerKey<Certificate>

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Certificate.Check

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
Certificate()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
List<Certificate.Check>	check(boolean allowCached)	Performs a status check on this certificate.
List<CertificateName>	getAltNames()
String	getCertbotName()
PosixPath	getCertFile()	The public key file.
PosixPath	getChainFile()	The optional certificate chain file.
protected Object	getColumnImpl(int i)
CertificateName	getCommonName()
PosixPath	getCsrFile()	The optional CSR file.
List<CyrusImapdBind>	getCyrusImapdBinds()
List<CyrusImapdServer>	getCyrusImapdServers()
List<VirtualHost>	getHttpdSiteBinds()
PosixPath	getKeyFile()	The private key file.
Server	getLinuxServer()
List<CertificateName>	getNames()
List<CertificateOtherUse>	getOtherUses()
Package	getPackage()
List<SendmailServer>	getSendmailServersByClientCertificate()
List<SendmailServer>	getSendmailServersByServerCertificate()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

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

Constructor Details

Certificate

@Deprecated
public Certificate()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

toStringImpl

public String toStringImpl()
                    throws SQLException,
IOException

Description copied from class: AoservObject

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<Certificate>

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Certificate>

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Certificate>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,Certificate>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,Certificate>

Throws:

IOException

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,Certificate>

Throws:

IOException

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getPackage

public Package getPackage()
                   throws IOException,
SQLException

Throws:

IOException

SQLException

getKeyFile

public PosixPath getKeyFile()

The private key file.

getCsrFile

public PosixPath getCsrFile()

The optional CSR file.

getCertFile

public PosixPath getCertFile()

The public key file.

getChainFile

public PosixPath getChainFile()

The optional certificate chain file.

getCertbotName

public String getCertbotName()

getNames

public List<CertificateName> getNames()
                               throws IOException,
SQLException

Throws:

IOException

SQLException

getCommonName

public CertificateName getCommonName()
                              throws SQLException,
IOException

Throws:

SQLException

IOException

getAltNames

public List<CertificateName> getAltNames()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getOtherUses

public List<CertificateOtherUse> getOtherUses()
                                       throws IOException,
SQLException

Throws:

IOException

SQLException

getCyrusImapdBinds

public List<CyrusImapdBind> getCyrusImapdBinds()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getCyrusImapdServers

public List<CyrusImapdServer> getCyrusImapdServers()
                                            throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdSiteBinds

public List<VirtualHost> getHttpdSiteBinds()
                                    throws IOException,
SQLException

Throws:

IOException

SQLException

getSendmailServersByServerCertificate

public List<SendmailServer> getSendmailServersByServerCertificate()
                                                           throws IOException,
SQLException

Throws:

IOException

SQLException

getSendmailServersByClientCertificate

public List<SendmailServer> getSendmailServersByClientCertificate()
                                                           throws IOException,
SQLException

Throws:

IOException

SQLException

check

public List<Certificate.Check> check(boolean allowCached)
                              throws IOException,
SQLException

Performs a status check on this certificate.

Parameters:

allowCached - allow a cached response? When false may be slow, but result will be up-to-date. true is good for interactive use, while false is good for background tasks such as certificate monitoring.

Throws:

IOException

SQLException