Package com.venafi.vcert.sdk.connectors.tpp

Class TppTokenConnector

java.lang.Object

com.venafi.vcert.sdk.connectors.tpp.AbstractTppConnector

com.venafi.vcert.sdk.connectors.tpp.TppTokenConnector

All Implemented Interfaces:

TokenConnector

public class TppTokenConnector
extends AbstractTppConnector
implements TokenConnector

Nested Class Summary

Nested classes/interfaces inherited from class com.venafi.vcert.sdk.connectors.tpp.AbstractTppConnector

AbstractTppConnector.AuthorizeRequest, AbstractTppConnector.CertificateRenewalRequest, AbstractTppConnector.CertificateRequestsPayload, AbstractTppConnector.CertificateRetrieveRequest, AbstractTppConnector.CertificateRevokeRequest, AbstractTppConnector.NameValuePair<K,V>, AbstractTppConnector.ReadZoneConfigurationRequest, AbstractTppConnector.ReadZoneConfigurationResponse, AbstractTppConnector.SANItem

Field Summary

Fields inherited from class com.venafi.vcert.sdk.connectors.tpp.AbstractTppConnector

FAILED_TO_AUTHENTICATE_MESSAGE, HEADER_VALUE_AUTHORIZATION, MISSING_ACCESS_TOKEN_MESSAGE, MISSING_CREDENTIALS_MESSAGE, MISSING_REFRESH_TOKEN_MESSAGE, revocationReasons, tpp, TPP_ATTRIBUTE_MANAGEMENT_TYPE, TPP_ATTRIBUTE_MANUAL_CSR, vendorAndProductName, zone

Constructor Summary

Constructors

Constructor	Description
TppTokenConnector(Tpp tpp)

Method Summary

Modifier and Type	Method	Description
CertificateRequest	generateRequest(ZoneConfiguration config, CertificateRequest request)	VedAuth method.
TokenInfo	getAccessToken()	returns a new access token.
TokenInfo	getAccessToken(Authentication auth)	returns a new access token.
PolicySpecification	getPolicy(String policyName)	Returns the policySpecification from the policy which matches with the policyName argument.
protected TppAPI	getTppAPI()
ConnectorType	getType()
String	getVendorAndProductName()
ImportResponse	importCertificate(ImportRequest request)	VedAuth method.
void	ping()	VedAuth method.
Policy	readPolicyConfiguration(String zone)	VedAuth method.
ZoneConfiguration	readZoneConfiguration(String zone)	VedAuth method.
TokenInfo	refreshAccessToken(String clientId)	this is for refreshing a token.
String	renewCertificate(RenewalRequest request)	VedAuth method.
String	requestCertificate(CertificateRequest request, ZoneConfiguration zoneConfiguration)	VedAuth method.
String	requestCertificate(CertificateRequest request, String zone)	VedAuth method.
String	requestSshCertificate(SshCertificateRequest sshCertificateRequest)	Request a new SSH Certificate.
PEMCollection	retrieveCertificate(CertificateRequest request)	VedAuth method.
SshCertRetrieveDetails	retrieveSshCertificate(SshCertificateRequest sshCertificateRequest)	Retrieve a requested SSH Certificate
SshConfig	retrieveSshConfig(SshCaTemplateRequest sshCaTemplateRequest)	Retrieve the SshConfig of the CA specified in the SshCaTemplateRequest.
int	revokeAccessToken()
void	revokeCertificate(RevocationRequest request)	VedAuth method.
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

Methods inherited from class com.venafi.vcert.sdk.connectors.tpp.AbstractTppConnector

getTPPPolicy, requestTppSshCertificate, retrieveTppSshCertificate, retrieveTppSshConfig, setPolicy

Methods inherited from class java.lang.Object

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

Constructor Detail

TppTokenConnector

public TppTokenConnector(Tpp tpp)

Method Detail

getType

public ConnectorType getType()

Specified by:

getType in interface TokenConnector

Returns:

ConnectorType the type of connector Cloud or TPP

setBaseUrl

public void setBaseUrl(String url)
                throws VCertException

Description copied from interface: TokenConnector

Allows overriding the default URL used to communicate with Venafi

Specified by:

setBaseUrl in interface TokenConnector

Throws:

VCertException

setZone

public void setZone(String zone)

Description copied from interface: TokenConnector

Set the default zone

Specified by:

setZone in interface TokenConnector

setVendorAndProductName

public void setVendorAndProductName(String vendorAndProductName)

Description copied from interface: TokenConnector

Set the vendor and product name

Specified by:

setVendorAndProductName in interface TokenConnector

getVendorAndProductName

public String getVendorAndProductName()

Specified by:

getVendorAndProductName in interface TokenConnector

Returns:

the vendor and product name

ping

public void ping()
          throws VCertException

Description copied from interface: TokenConnector

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

Specified by:

ping in interface TokenConnector

Throws:

VCertException

getAccessToken

public TokenInfo getAccessToken(Authentication auth)
                         throws VCertException

Description copied from interface: TokenConnector

returns a new access token.

Specified by:

getAccessToken in interface TokenConnector

Parameters:

auth - authentication info

Returns:

the new token.

Throws:

VCertException - throws this exception when authentication info is null.

getAccessToken

public TokenInfo getAccessToken()
                         throws VCertException

Description copied from interface: TokenConnector

returns a new access token. This method uses the Authentication object passed earlier with the Config object.

Specified by:

getAccessToken in interface TokenConnector

Returns:

the new token.

Throws:

VCertException - throws this exception when authentication info is null.

refreshAccessToken

public TokenInfo refreshAccessToken(String clientId)
                             throws VCertException

Description copied from interface: TokenConnector

this is for refreshing a token.

Specified by:

refreshAccessToken in interface TokenConnector

Parameters:

clientId - the application id.

Returns:

a complete info about the new access token, refresh token, expires.

Throws:

VCertException

revokeAccessToken

public int revokeAccessToken()
                      throws VCertException

Specified by:

revokeAccessToken in interface TokenConnector

Returns:

1 if the access token was revoked and 0 if not.

Throws:

VCertException

readZoneConfiguration

public ZoneConfiguration readZoneConfiguration(String zone)
                                        throws VCertException

Description copied from interface: TokenConnector

VedAuth method. Reads the zone configuration needed for generating and requesting a certificate

Specified by:

readZoneConfiguration in interface TokenConnector

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

Description copied from interface: TokenConnector

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

Specified by:

generateRequest in interface TokenConnector

Returns:

the zone configuration

Throws:

VCertException

requestCertificate

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

Description copied from interface: TokenConnector

VedAuth method. Submits the CSR to Venafi for processing

Specified by:

requestCertificate in interface TokenConnector

Returns:

request id to track the certificate status.

Throws:

VCertException

requestCertificate

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

Description copied from interface: TokenConnector

VedAuth method. Submits the CSR to Venafi for processing

Specified by:

requestCertificate in interface TokenConnector

Returns:

request id to track the certificate status.

Throws:

VCertException

retrieveCertificate

public PEMCollection retrieveCertificate(CertificateRequest request)
                                  throws VCertException

Description copied from interface: TokenConnector

VedAuth method. Retrieves the certificate for the specific ID

Specified by:

retrieveCertificate in interface TokenConnector

Returns:

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

Throws:

VCertException

revokeCertificate

public void revokeCertificate(RevocationRequest request)
                       throws VCertException

Description copied from interface: TokenConnector

VedAuth method. Attempts to revoke a certificate

Specified by:

revokeCertificate in interface TokenConnector

Throws:

VCertException

renewCertificate

public String renewCertificate(RenewalRequest request)
                        throws VCertException

Description copied from interface: TokenConnector

VedAuth method. Attempts to renew a certificate

Specified by:

renewCertificate in interface TokenConnector

Returns:

Throws:

VCertException

importCertificate

public ImportResponse importCertificate(ImportRequest request)
                                 throws VCertException

Description copied from interface: TokenConnector

VedAuth method. Import an external certificate into Venafi.

Specified by:

importCertificate in interface TokenConnector

Returns:

Throws:

VCertException

readPolicyConfiguration

public Policy readPolicyConfiguration(String zone)
                               throws VCertException

Description copied from interface: TokenConnector

VedAuth method. Reads the policy configuration for a specific zone in Venafi

Specified by:

readPolicyConfiguration in interface TokenConnector

Returns:

Throws:

VCertException

setPolicy

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

Description copied from interface: TokenConnector

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

Specified by:

setPolicy in interface TokenConnector

Throws:

VCertException

getPolicy

public PolicySpecification getPolicy(String policyName)
                              throws VCertException

Description copied from interface: TokenConnector

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

Specified by:

getPolicy in interface TokenConnector

Returns:

Throws:

VCertException

requestSshCertificate

public String requestSshCertificate(SshCertificateRequest sshCertificateRequest)
                             throws VCertException

Description copied from interface: TokenConnector

Request a new SSH Certificate.

Specified by:

requestSshCertificate in interface TokenConnector

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: TokenConnector

Retrieve a requested SSH Certificate

Specified by:

retrieveSshCertificate in interface TokenConnector

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: TokenConnector

Retrieve the SshConfig of the CA specified in the SshCaTemplateRequest.

Specified by:

retrieveSshConfig in interface TokenConnector

Returns:

A SshConfig.

Throws:

VCertException

getTppAPI

protected TppAPI getTppAPI()

Specified by:

getTppAPI in class AbstractTppConnector