Package com.venafi.vcert.sdk

Class VCertClient

java.lang.Object

com.venafi.vcert.sdk.VCertClient

All Implemented Interfaces:

Connector, IPMConnector, ISSHConnector

Direct Known Subclasses:

VCertTknClient

public class VCertClient
extends Object
implements Connector

Field Summary

Fields

Modifier and Type	Field	Description
protected Connector	connector

Constructor Summary

Constructors

Constructor	Description
VCertClient(Config config)

Method Summary

Modifier and Type	Method	Description
void	authenticate(Authentication credentials)	This is the default implementation which provides a mechanism to authenticate the credentials provided in the Authentication object.
void	authorize(Authentication credentials)	Performs the authorization actions using the credentials provided.
protected Connector	createConnector(Config config)
CertificateRequest	generateRequest(ZoneConfiguration config, CertificateRequest request)	GenerateRequest creates a new certificate request, based on the zone/policy configuration and the user data
Authentication	getCredentials()
PolicySpecification	getPolicy(String policyName)	Returns the policySpecification from the policy which matches with the policyName argument.
ConnectorType	getType()
String	getVendorAndProductName()
ImportResponse	importCertificate(ImportRequest request)	Import an external certificate into Venafi.
boolean	isEmptyCredentials(Authentication credentials)	Determines if the given credentials object is empty or not.
void	ping()	Attempt to connect the Venafi API and returns an error if it cannot
Policy	readPolicyConfiguration(String zone)	Reads the policy configuration for a specific zone in Venafi
ZoneConfiguration	readZoneConfiguration(String zone)	Reads the zone configuration needed for generating and requesting a certificate
String	renewCertificate(RenewalRequest request)	Attempts to renew a certificate
String	requestCertificate(CertificateRequest request, ZoneConfiguration zoneConfiguration)	Submits the CSR to Venafi for processing
String	requestCertificate(CertificateRequest request, String zone)	Submits the CSR to Venafi for processing
String	requestSshCertificate(SshCertificateRequest sshCertificateRequest)	Request a new SSH Certificate.
PEMCollection	retrieveCertificate(CertificateRequest request)	Retrieves the certificate for the specific ID
SshCertRetrieveDetails	retrieveSshCertificate(SshCertificateRequest sshCertificateRequest)	Retrieve a requested SSH Certificate
SshConfig	retrieveSshConfig(SshCaTemplateRequest sshCaTemplateRequest)	Retrieve the SshConfig of the CA specified in the SshCaTemplateRequest.
void	revokeCertificate(RevocationRequest request)	Attempts to revoke a certificate
void	setBaseUrl(String url)	Method not implemented yet.
void	setPolicy(String policyName, PolicySpecification policySpecification)	Create/update a policy based on the policySpecification passed as argument.
void	setVendorAndProductName(String vendorAndProductName)	Set the vendor and product name
void	setZone(String zone)	Set the default zone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

connector

protected Connector connector

Constructor Detail

VCertClient

public VCertClient(Config config)
            throws VCertException

Throws:

VCertException

Method Detail

createConnector

protected Connector createConnector(Config config)
                             throws VCertException

Throws:

VCertException

getCredentials

public Authentication getCredentials()

Specified by:

getCredentials in interface Connector

getType

public ConnectorType getType()

Specified by:

getType in interface Connector

Returns:

ConnectorType the type of connector Cloud or TPP

setBaseUrl

public void setBaseUrl(String url)
                throws VCertException

Method not implemented yet. Guaranteed to throw an exception.

Specified by:

setBaseUrl in interface Connector

Throws:

UnsupportedOperationException - always

VCertException

setZone

public void setZone(String zone)

Set the default zone

Specified by:

setZone in interface Connector

setVendorAndProductName

public void setVendorAndProductName(String vendorAndProductName)

Set the vendor and product name

Specified by:

setVendorAndProductName in interface Connector

getVendorAndProductName

public String getVendorAndProductName()

Specified by:

getVendorAndProductName in interface Connector

Returns:

the vendor and product name

ping

public void ping()
          throws VCertException

Attempt to connect the Venafi API and returns an error if it cannot

Specified by:

ping in interface Connector

Throws:

VCertException

authenticate

public void authenticate(Authentication credentials)
                  throws VCertException

This is the default implementation which provides a mechanism to authenticate the credentials provided in the Authentication object. Behind the scene, it's validating if the credentials were provided calling the Connector.isEmptyCredentials(Authentication) method and if that returns true, then a ConnectorException.MissingCredentialsException is thrown. If the credentials are not empty then is called the Connector.authorize(Authentication) method.

Specified by:

authenticate in interface Connector

Throws:

VCertException

isEmptyCredentials

public boolean isEmptyCredentials(Authentication credentials)

Determines if the given credentials object is empty or not. This method is used by Connector.authenticate(Authentication) method to determine if the credentials were provided in order to after invoke the Connector.authorize(Authentication) method.

Specified by:

isEmptyCredentials in interface Connector

Returns:

authorize

public void authorize(Authentication credentials)
               throws VCertException

Performs the authorization actions using the credentials provided. This method is used by Connector.authenticate(Authentication) method after the credentials were validated as not empty.

Specified by:

authorize in interface Connector

Throws:

VCertException

readZoneConfiguration

public ZoneConfiguration readZoneConfiguration(String zone)
                                        throws VCertException

Reads the zone configuration needed for generating and requesting a certificate

Specified by:

readZoneConfiguration in interface Connector

Parameters:

zone - ID (e.g. 2ebd4ec1-57f7-4994-8651-e396b286a3a8) or zone path (e.g. "ProjectName\ZoneName")

Returns:

Throws:

VCertException

generateRequest

public CertificateRequest generateRequest(ZoneConfiguration config,
                                          CertificateRequest request)
                                   throws VCertException

GenerateRequest creates a new certificate request, based on the zone/policy configuration and the user data

Specified by:

generateRequest in interface Connector

Returns:

the zone configuration

Throws:

VCertException

requestCertificate

public String requestCertificate(CertificateRequest request,
                                 String zone)
                          throws VCertException

Description copied from interface: Connector

Submits the CSR to Venafi for processing

Specified by:

requestCertificate in interface Connector

Returns:

request id to track the certificate status.

Throws:

VCertException

requestCertificate

public String requestCertificate(CertificateRequest request,
                                 ZoneConfiguration zoneConfiguration)
                          throws VCertException

Submits the CSR to Venafi for processing

Specified by:

requestCertificate in interface Connector

Returns:

request id to track the certificate status.

Throws:

VCertException

retrieveCertificate

public PEMCollection retrieveCertificate(CertificateRequest request)
                                  throws VCertException

Retrieves the certificate for the specific ID

Specified by:

retrieveCertificate in interface Connector

Returns:

A collection of PEM files including certificate, chain and potentially a private key.

Throws:

VCertException

revokeCertificate

public void revokeCertificate(RevocationRequest request)
                       throws VCertException

Attempts to revoke a certificate

Specified by:

revokeCertificate in interface Connector

Throws:

VCertException

renewCertificate

public String renewCertificate(RenewalRequest request)
                        throws VCertException

Attempts to renew a certificate

Specified by:

renewCertificate in interface Connector

Returns:

Throws:

VCertException

importCertificate

public ImportResponse importCertificate(ImportRequest request)
                                 throws VCertException

Import an external certificate into Venafi.

Specified by:

importCertificate in interface Connector

Returns:

Throws:

VCertException

readPolicyConfiguration

public Policy readPolicyConfiguration(String zone)
                               throws VCertException

Reads the policy configuration for a specific zone in Venafi

Specified by:

readPolicyConfiguration in interface IPMConnector

Returns:

Throws:

VCertException

setPolicy

public void setPolicy(String policyName,
                      PolicySpecification policySpecification)
               throws VCertException

Create/update a policy based on the policySpecification passed as argument.

Specified by:

setPolicy in interface IPMConnector

Throws:

VCertException

getPolicy

public PolicySpecification getPolicy(String policyName)
                              throws VCertException

Returns the policySpecification from the policy which matches with the policyName argument.

Specified by:

getPolicy in interface IPMConnector

Returns:

Throws:

VCertException

requestSshCertificate

public String requestSshCertificate(SshCertificateRequest sshCertificateRequest)
                             throws VCertException

Description copied from interface: ISSHConnector

Request a new SSH Certificate.

Specified by:

requestSshCertificate in interface ISSHConnector

Parameters:

sshCertificateRequest - The SshCertificateRequest instance needed to do the request. For more information about of which properties should be filled, please review the documentation of SshCertificateRequest.

Returns:

The DN of the created SSH certificate object. It can be used as pickup ID to retrieve the created SSH Certificate. For more details review the retrieveSshCertificate(SshCertificateRequest) method.

Throws:

VCertException

retrieveSshCertificate

public SshCertRetrieveDetails retrieveSshCertificate(SshCertificateRequest sshCertificateRequest)
                                              throws VCertException

Description copied from interface: ISSHConnector

Retrieve a requested SSH Certificate

Specified by:

retrieveSshCertificate in interface ISSHConnector

Parameters:

sshCertificateRequest - The SshCertificateRequest instance needed to do the request.
It's mandatory to set the PickUpID which is the value of the DN returned when the SSH Certificate was requested. For more information about of which properties should be filled, please review the documentation of SshCertificateRequest.

Returns:

A SshCertRetrieveDetails containing the Certificate Data of the created Certificate.

Throws:

VCertException

retrieveSshConfig

public SshConfig retrieveSshConfig(SshCaTemplateRequest sshCaTemplateRequest)
                            throws VCertException

Description copied from interface: ISSHConnector

Retrieve the SshConfig of the CA specified in the SshCaTemplateRequest.

Specified by:

retrieveSshConfig in interface ISSHConnector

Returns:

A SshConfig.

Throws:

VCertException