Package com.venafi.vcert.sdk.connectors

Interface Connector

All Known Implementing Classes:

CloudConnector, TppConnector, VCertClient

public interface Connector

This represents the connector to TPP or Cloud

Method Summary

Modifier and Type	Method	Description
void	authenticate(Authentication auth)	Authenticate the user with Venafi using either API key for Venafi Cloud or user and password for TPP
CertificateRequest	generateRequest(ZoneConfiguration config, CertificateRequest request)	GenerateRequest creates a new certificate request, based on the zone/policy configuration and the user data
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.
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)	Allows overriding the default URL used to communicate with Venafi
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

Method Detail

getType

ConnectorType getType()

Returns:

ConnectorType the type of connector Cloud or TPP

setBaseUrl

void setBaseUrl(String url)
         throws VCertException

Allows overriding the default URL used to communicate with Venafi

Parameters:

url -

Throws:

VCertException

setZone

void setZone(String zone)

Set the default zone

Parameters:

zone -

setVendorAndProductName

void setVendorAndProductName(String vendorAndProductName)

Set the vendor and product name

Parameters:

vendorAndProductName -

getVendorAndProductName

String getVendorAndProductName()

Returns:

the vendor and product name

ping

void ping()
   throws VCertException

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

Throws:

VCertException

authenticate

void authenticate(Authentication auth)
           throws VCertException

Authenticate the user with Venafi using either API key for Venafi Cloud or user and password for TPP

Parameters:

auth -

Throws:

VCertException

readZoneConfiguration

ZoneConfiguration readZoneConfiguration(String zone)
                                 throws VCertException

Reads the zone configuration needed for generating and requesting a certificate

Parameters:

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

Returns:

Throws:

VCertException

generateRequest

CertificateRequest generateRequest(ZoneConfiguration config,
                                   CertificateRequest request)
                            throws VCertException

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

Parameters:

config -

Returns:

the zone configuration

Throws:

VCertException

requestCertificate

String requestCertificate(CertificateRequest request,
                          ZoneConfiguration zoneConfiguration)
                   throws VCertException

Submits the CSR to Venafi for processing

Parameters:

request -

zoneConfiguration -

Returns:

request id to track the certificate status.

Throws:

VCertException

requestCertificate

String requestCertificate(CertificateRequest request,
                          String zone)
                   throws VCertException

Submits the CSR to Venafi for processing

Parameters:

request -

zone -

Returns:

request id to track the certificate status.

Throws:

VCertException

retrieveCertificate

PEMCollection retrieveCertificate(CertificateRequest request)
                           throws VCertException

Retrieves the certificate for the specific ID

Parameters:

request -

Returns:

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

Throws:

VCertException

revokeCertificate

void revokeCertificate(RevocationRequest request)
                throws VCertException

Attempts to revoke a certificate

Parameters:

request -

Throws:

VCertException

renewCertificate

String renewCertificate(RenewalRequest request)
                 throws VCertException

Attempts to renew a certificate

Parameters:

request -

Returns:

Throws:

VCertException

importCertificate

ImportResponse importCertificate(ImportRequest request)
                          throws VCertException

Import an external certificate into Venafi.

Parameters:

request -

Returns:

Throws:

VCertException

readPolicyConfiguration

Policy readPolicyConfiguration(String zone)
                        throws VCertException

Reads the policy configuration for a specific zone in Venafi

Parameters:

zone -

Returns:

Throws:

VCertException

setPolicy

void setPolicy(String policyName,
               PolicySpecification policySpecification)
        throws VCertException

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

Parameters:

policyName -

policySpecification -

Throws:

VCertException

getPolicy

PolicySpecification getPolicy(String policyName)
                       throws VCertException

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

Parameters:

policyName -

Returns:

Throws:

VCertException

requestSshCertificate

String requestSshCertificate(SshCertificateRequest sshCertificateRequest)
                      throws VCertException

Request a new SSH Certificate.

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

SshCertRetrieveDetails retrieveSshCertificate(SshCertificateRequest sshCertificateRequest)
                                       throws VCertException

Retrieve a requested SSH Certificate

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

SshConfig retrieveSshConfig(SshCaTemplateRequest sshCaTemplateRequest)
                     throws VCertException

Retrieve the SshConfig of the CA specified in the SshCaTemplateRequest.

Parameters:

sshCaTemplateRequest -

Returns:

A SshConfig.

Throws:

VCertException