com.silanis.esl.sdk

Class EslClient

java.lang.Object

com.silanis.esl.sdk.EslClient

public class EslClient
extends Object

The EslClient class creates a eSignLive client with the given api token and base url.

The base url can be the staging or production url.

For example: http://sandbox.esignlive.com/api

Provides access to service classes such as PackageService to help create packages.

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_KEY
static String	API_TOKEN_CONFIG
static String	BASE_URL

Constructor Summary

Constructors

Constructor and Description
EslClient(ApiTokenConfig apiTokenConfig, String baseURL, boolean allowAllSSLCertificates, ProxyConfiguration proxyConfiguration, boolean useSystemProperties, Map<String,String> headers)
EslClient(String apiKey, String baseURL) The constructor of the EslClient class
EslClient(String apiKey, String baseURL, boolean allowAllSSLCertificates)
EslClient(String apiKey, String baseURL, boolean allowAllSSLCertificates, ProxyConfiguration proxyConfiguration)
EslClient(String apiKey, String baseURL, boolean allowAllSSLCertificates, ProxyConfiguration proxyConfiguration, boolean useSystemProperties, Map<String,String> headers)
EslClient(String apiKey, String baseURL, ProxyConfiguration proxyConfiguration)
EslClient(String apiKey, String baseURL, String webpageURL) The constructor of the EslClient class
EslClient(String apiKey, String baseURL, String webpageURL, boolean allowAllSSLCertificates)

Method Summary

Modifier and Type	Method and Description
void	changePackageStatusToDraft(PackageId packageId) Change the package's status from SENT to DRAFT.
void	configureDocumentVisibility(PackageId packageId, DocumentVisibility visibility) Configure the document visibility.
PackageId	createAndSendPackage(DocumentPackage documentPackage) Creates a new packages, and immediately sends it to be signed.
PackageId	createPackage(DocumentPackage documentPackage) Creates the package.
PackageId	createPackageFromTemplate(DocumentPackage documentPackage, PackageId packageId) Deprecated. Please use createPackageFromTemplate( PackageId packageId, DocumentPackage documentPackage ) instead of this method.
PackageId	createPackageFromTemplate(PackageId packageId, DocumentPackage documentPackage) Creates a package based on an existent template
PackageId	createPackageOneStep(DocumentPackage documentPackage) Creates the package in one step WARNING: DOES NOT WORK WHEN SENDER HAS A SIGNATURE
SessionToken	createSenderSessionToken() Deprecated. Use the AuthenticationTokensService.createSenderAuthenticationToken(java.lang.String) or AuthenticationTokensService.createUserAuthenticationToken() depending if you want to create a token to authenticate as the package sender or the api key user.
SessionToken	createSessionToken(PackageId packageId, String signerId) Deprecated. Use the AuthenticationTokensService.createSignerAuthenticationToken(java.lang.String, java.lang.String).
SessionToken	createSignerSessionToken(PackageId packageId, String signerId) Deprecated. Use the AuthenticationTokensService.createSignerAuthenticationToken(java.lang.String, java.lang.String).
void	createSignerVerification(PackageId packageId, String roleId, SignerVerification signerVerification)
void	deleteAttachmentFile(PackageId packageId, String attachmentId, Integer fileId, String signerId)
void	deleteSignerVerification(PackageId packageId, String roleId)
byte[]	downloadDocument(PackageId packageId, String documentId) Downloads a document that belongs to a package
byte[]	downloadEvidenceSummary(PackageId packageId) Downloads the evidence summary for a package
byte[]	downloadOriginalDocument(PackageId packageId, String documentId) Downloads an original document that belongs to a package.
byte[]	downloadZippedDocuments(PackageId packageId) Downloads the zipped documents of a package
AccountConfigService	getAccountConfigService()
AccountService	getAccountService()
ApprovalService	getApprovalService()
AttachmentRequirementService	getAttachmentRequirementService()
AuditService	getAuditService()
AuthenticationTokensService	getAuthenticationTokensService() Facilitates access to the service that creates authentication tokens
CustomFieldService	getCustomFieldService() Facilitates access to the service that could be used to add custom field
DataRetentionSettingsService	getDataRetentionSettingsService() Gets the data retention settings service
List<Document>	getDocuments(PackageId packageId, String signerId)
DocumentVisibility	getDocumentVisibility(PackageId packageId) Get document visibility.
EventNotificationService	getEventNotificationService() Facilitates access to the service that could be used to register for event notifications
FieldSummaryService	getFieldSummaryService() Facilitates access to the service that provides a summary of all the document fields and their values
List<FieldSummary>	getFieldValues(PackageId packageId) Retrieves a summary for all the document fields of the package identified by its packageId
GroupService	getGroupService()
LayoutService	getLayoutService()
DocumentPackage	getPackage(PackageId packageId)
PackageService	getPackageService() Gets the package service
QRCodeService	getQrCodeService()
ReminderService	getReminderService()
ReportService	getReportService() Gets the report service
SessionService	getSessionService()
SignatureImageService	getSignatureImageService() Facilitates access to the service that get signature image
List<Signer>	getSigners(PackageId packageId, String documentId)
SignerVerification	getSignerVerification(PackageId packageId, String roleId)
SigningService	getSigningService()
SigningStatus	getSigningStatus(PackageId packageId, SignerId signerId, DocumentId documentId)
SigningStyleService	getSigningStyleService() Facilitates access to the service that could be used to add signing style
SystemService	getSystemService()
TemplateService	getTemplateService()
VirtualRoomService	getVirtualRoomService() Gets the virtual room config service
void	sendPackage(PackageId id) It does the followings for the package ID specified as argument:
EslClient	setWebpageURL(String baseURL)
void	signDocument(PackageId packageId, String documentName) Sign a document using current api key
void	signDocument(PackageId packageId, String documentName, CapturedSignature capturedSignature) Sign a document using current api key
void	signDocuments(PackageId packageId) Sign documents using current api key
void	signDocuments(PackageId packageId, CapturedSignature capturedSignature) Sign documents using current api key
void	signDocuments(PackageId packageId, String signerId) Sign documents using signer id
void	signDocuments(PackageId packageId, String signerId, CapturedSignature capturedSignature) Sign documents using signer id
void	updatePackage(PackageId packageId, DocumentPackage documentPackage) Update the package, when the package status is only Draft
void	updateSignerVerification(PackageId packageId, String roleId, SignerVerification signerVerification)
void	uploadAttachment(PackageId packageId, String attachmentId, Map<String,byte[]> files, String signerId)
void	uploadAttachment(PackageId packageId, String attachmentId, String filename, byte[] fileContent, String signerId)
Document	uploadDocument(Document document, DocumentPackage documentPackage) Deprecated. Please use uploadDocument(Document document, PackageId packageId) instead of this method.
Document	uploadDocument(Document document, PackageId packageId)
Document	uploadDocument(String fileName, byte[] fileContent, Document document, DocumentPackage documentPackage) Deprecated. Please use uploadDocument(String fileName, byte[] fileContent, Document document, PackageId packageId) instead of this method.
Document	uploadDocument(String fileName, byte[] fileContent, Document document, PackageId packageId)
List<Document>	uploadDocuments(PackageId packageId, Document... documents)
List<Document>	uploadDocuments(PackageId packageId, List<Document> documents)

Methods inherited from class java.lang.Object

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

Field Detail

API_KEY

public static final String API_KEY

See Also:

Constant Field Values

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

API_TOKEN_CONFIG

public static final String API_TOKEN_CONFIG

See Also:

Constant Field Values

Constructor Detail

EslClient

public EslClient(String apiKey,
                 String baseURL)

The constructor of the EslClient class

Parameters:

apiKey - the api key token

baseURL - the eSignLive base url

EslClient

public EslClient(String apiKey,
                 String baseURL,
                 String webpageURL)

The constructor of the EslClient class

Parameters:

apiKey - the api key token

baseURL - the eSignLive base url

webpageURL - the eSignLive web page url

EslClient

public EslClient(String apiKey,
                 String baseURL,
                 String webpageURL,
                 boolean allowAllSSLCertificates)

EslClient

public EslClient(String apiKey,
                 String baseURL,
                 boolean allowAllSSLCertificates)

EslClient

public EslClient(String apiKey,
                 String baseURL,
                 ProxyConfiguration proxyConfiguration)

EslClient

public EslClient(String apiKey,
                 String baseURL,
                 boolean allowAllSSLCertificates,
                 ProxyConfiguration proxyConfiguration)

EslClient

public EslClient(String apiKey,
                 String baseURL,
                 boolean allowAllSSLCertificates,
                 ProxyConfiguration proxyConfiguration,
                 boolean useSystemProperties,
                 Map<String,String> headers)

EslClient

public EslClient(ApiTokenConfig apiTokenConfig,
                 String baseURL,
                 boolean allowAllSSLCertificates,
                 ProxyConfiguration proxyConfiguration,
                 boolean useSystemProperties,
                 Map<String,String> headers)

Method Detail

setWebpageURL

public EslClient setWebpageURL(String baseURL)

getPackageService

public PackageService getPackageService()

Gets the package service

Returns:

the package service

getDataRetentionSettingsService

public DataRetentionSettingsService getDataRetentionSettingsService()

Gets the data retention settings service

Returns:

the data retention settings service

getVirtualRoomService

public VirtualRoomService getVirtualRoomService()

Gets the virtual room config service

Returns:

the virtual room config service

getReportService

public ReportService getReportService()

Gets the report service

Returns:

the report service

getSessionService

public SessionService getSessionService()

getFieldSummaryService

public FieldSummaryService getFieldSummaryService()

Facilitates access to the service that provides a summary of all the document fields and their values

Returns:

the field summary service

getAuditService

public AuditService getAuditService()

getEventNotificationService

public EventNotificationService getEventNotificationService()

Facilitates access to the service that could be used to register for event notifications

Returns:

the event notification service

getAuthenticationTokensService

public AuthenticationTokensService getAuthenticationTokensService()

Facilitates access to the service that creates authentication tokens

Returns:

the authentication token service

getCustomFieldService

public CustomFieldService getCustomFieldService()

Facilitates access to the service that could be used to add custom field

Returns:

the custom field service

getSigningStyleService

public SigningStyleService getSigningStyleService()

Facilitates access to the service that could be used to add signing style

Returns:

the signing style service

getSignatureImageService

public SignatureImageService getSignatureImageService()

Facilitates access to the service that get signature image

Returns:

the signature image service

createPackage

public PackageId createPackage(DocumentPackage documentPackage)

Creates the package.

This basically does the followings:

- converts the document package to JSON format

- makes an eSL REST call to actually create the package. Is is using as payload the above generated JSON content.

Parameters:

documentPackage - the document package

Returns:

the package ID

updatePackage

public void updatePackage(PackageId packageId,
                          DocumentPackage documentPackage)

Update the package, when the package status is only Draft

Parameters:

packageId -

documentPackage - the document package

changePackageStatusToDraft

public void changePackageStatusToDraft(PackageId packageId)

Change the package's status from SENT to DRAFT.

Parameters:

packageId -

configureDocumentVisibility

public void configureDocumentVisibility(PackageId packageId,
                                        DocumentVisibility visibility)

Configure the document visibility.

Parameters:

packageId -

visibility - the document visibility

getDocumentVisibility

public DocumentVisibility getDocumentVisibility(PackageId packageId)

Get document visibility.

Parameters:

packageId -

Returns:

the document visibility

createPackageOneStep

public PackageId createPackageOneStep(DocumentPackage documentPackage)

Creates the package in one step

WARNING: DOES NOT WORK WHEN SENDER HAS A SIGNATURE

Parameters:

documentPackage - the document package

Returns:

the package ID

signDocument

public void signDocument(PackageId packageId,
                         String documentName)

Sign a document using current api key

Parameters:

packageId - the package id

documentName - the document name of the document to sign

signDocument

public void signDocument(PackageId packageId,
                         String documentName,
                         CapturedSignature capturedSignature)

Sign a document using current api key

Parameters:

packageId - the package id

documentName - the document name of the document to sign

capturedSignature - the captured signature string to use when signing

signDocuments

public void signDocuments(PackageId packageId)

Sign documents using current api key

Parameters:

packageId - the package id

signDocuments

public void signDocuments(PackageId packageId,
                          CapturedSignature capturedSignature)

Sign documents using current api key

Parameters:

packageId - the package id

capturedSignature - the captured signature string to use when signing

signDocuments

public void signDocuments(PackageId packageId,
                          String signerId)

Sign documents using signer id

Parameters:

packageId - the package id

signerId - the signer id

signDocuments

public void signDocuments(PackageId packageId,
                          String signerId,
                          CapturedSignature capturedSignature)

Sign documents using signer id

Parameters:

packageId - the package id

signerId - the signer id

capturedSignature - the captured signature string to use when signing

createAndSendPackage

public PackageId createAndSendPackage(DocumentPackage documentPackage)

Creates a new packages, and immediately sends it to be signed.

Parameters:

documentPackage - the document package to be created and signed

Returns:

the packageId for the newly created package.

createPackageFromTemplate

public PackageId createPackageFromTemplate(PackageId packageId,
                                           DocumentPackage documentPackage)

Creates a package based on an existent template

Parameters:

packageId - the package ID used as template for the new package

documentPackage - the document package

Returns:

the package ID

createPackageFromTemplate

@Deprecated
public PackageId createPackageFromTemplate(DocumentPackage documentPackage,
                                                       PackageId packageId)

Deprecated. Please use createPackageFromTemplate( PackageId packageId, DocumentPackage documentPackage ) instead of this method.

sendPackage

public void sendPackage(PackageId id)

It does the followings for the package ID specified as argument:

- activates the package

- send emails to signers and the package owner

- sends notifications (if any)

Parameters:

id - the package ID

getFieldValues

public List<FieldSummary> getFieldValues(PackageId packageId)

Retrieves a summary for all the document fields of the package identified by its packageId

Parameters:

packageId - the package ID

Returns:

a list of field summarys

createSenderSessionToken

@Deprecated
public SessionToken createSenderSessionToken()

Deprecated. Use the AuthenticationTokensService.createSenderAuthenticationToken(java.lang.String) or AuthenticationTokensService.createUserAuthenticationToken() depending if you want to create a token to authenticate as the package sender or the api key user.

createSignerSessionToken

@Deprecated
public SessionToken createSignerSessionToken(PackageId packageId,
                                                         String signerId)

Deprecated. Use the AuthenticationTokensService.createSignerAuthenticationToken(java.lang.String, java.lang.String).

createSessionToken

@Deprecated
public SessionToken createSessionToken(PackageId packageId,
                                                   String signerId)

Deprecated. Use the AuthenticationTokensService.createSignerAuthenticationToken(java.lang.String, java.lang.String).

Creates a session token for the package and user provided as parameters.

The content of SessionToken that is returned by this method is needed to access

the signing ceremony on behalf of the signer for whom the session was generated

Parameters:

packageId - the package ID

signerId - the signer ID

Returns:

the session token

Throws:

EslException

getPackage

public DocumentPackage getPackage(PackageId packageId)

Parameters:

packageId - The document package identifier

Returns:

the document package with the given packageId

getDocuments

public List<Document> getDocuments(PackageId packageId,
                                   String signerId)

Parameters:

packageId - The document package identifier

signerId - the signer ID

Returns:

the document list based on document visibility for the specific signer

getSigners

public List<Signer> getSigners(PackageId packageId,
                               String documentId)

Parameters:

packageId - The document package identifier

documentId - the document ID

Returns:

the signer list based on document visibility for the specific document

downloadDocument

public byte[] downloadDocument(PackageId packageId,
                               String documentId)

Downloads a document that belongs to a package

Parameters:

packageId - the package ID

documentId - the document ID

Returns:

the content of the document

downloadOriginalDocument

public byte[] downloadOriginalDocument(PackageId packageId,
                                       String documentId)

Downloads an original document that belongs to a package.

Parameters:

packageId - the package ID

documentId - the document ID

Returns:

the content of the original document

downloadEvidenceSummary

public byte[] downloadEvidenceSummary(PackageId packageId)

Downloads the evidence summary for a package

Parameters:

packageId - the package ID

Returns:

the content of the evidence summary

downloadZippedDocuments

public byte[] downloadZippedDocuments(PackageId packageId)

Downloads the zipped documents of a package

Parameters:

packageId - the package ID

Returns:

the zipped documents

getSigningStatus

public SigningStatus getSigningStatus(PackageId packageId,
                                      SignerId signerId,
                                      DocumentId documentId)

uploadDocument

@Deprecated
public Document uploadDocument(String fileName,
                                           byte[] fileContent,
                                           Document document,
                                           DocumentPackage documentPackage)

Deprecated. Please use uploadDocument(String fileName, byte[] fileContent, Document document, PackageId packageId) instead of this method.

uploadDocument

public Document uploadDocument(String fileName,
                               byte[] fileContent,
                               Document document,
                               PackageId packageId)

uploadDocuments

public List<Document> uploadDocuments(PackageId packageId,
                                      Document... documents)

uploadDocuments

public List<Document> uploadDocuments(PackageId packageId,
                                      List<Document> documents)

uploadDocument

@Deprecated
public Document uploadDocument(Document document,
                                           DocumentPackage documentPackage)

Deprecated. Please use uploadDocument(Document document, PackageId packageId) instead of this method.

uploadDocument

public Document uploadDocument(Document document,
                               PackageId packageId)

uploadAttachment

public void uploadAttachment(PackageId packageId,
                             String attachmentId,
                             String filename,
                             byte[] fileContent,
                             String signerId)

uploadAttachment

public void uploadAttachment(PackageId packageId,
                             String attachmentId,
                             Map<String,byte[]> files,
                             String signerId)

createSignerVerification

public void createSignerVerification(PackageId packageId,
                                     String roleId,
                                     SignerVerification signerVerification)

getSignerVerification

public SignerVerification getSignerVerification(PackageId packageId,
                                                String roleId)

updateSignerVerification

public void updateSignerVerification(PackageId packageId,
                                     String roleId,
                                     SignerVerification signerVerification)

deleteSignerVerification

public void deleteSignerVerification(PackageId packageId,
                                     String roleId)

deleteAttachmentFile

public void deleteAttachmentFile(PackageId packageId,
                                 String attachmentId,
                                 Integer fileId,
                                 String signerId)

getGroupService

public GroupService getGroupService()

getAccountService

public AccountService getAccountService()

getAccountConfigService

public AccountConfigService getAccountConfigService()

getApprovalService

public ApprovalService getApprovalService()

getReminderService

public ReminderService getReminderService()

getTemplateService

public TemplateService getTemplateService()

getAttachmentRequirementService

public AttachmentRequirementService getAttachmentRequirementService()

getLayoutService

public LayoutService getLayoutService()

getQrCodeService

public QRCodeService getQrCodeService()

getSystemService

public SystemService getSystemService()

getSigningService

public SigningService getSigningService()