com.silanis.esl.sdk

Class EslClient

java.lang.Object

com.silanis.esl.sdk.EslClient

public class EslClient
extends Object

The EslClient class creates a E-SignLive client with the given api token and base url.

The base url can be the staging or production url.

For example: http://sandbox.e-signlive.com/api

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

Constructor Summary

Constructors

Constructor and Description
EslClient(String apiKey, String baseURL) The constructor of the EslClient class

Method Summary

Methods

Modifier and Type	Method and Description
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) 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).
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
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
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()
SessionService	getSessionService()
SigningStatus	getSigningStatus(PackageId packageId, SignerId signerId, DocumentId documentId)
TemplateService	getTemplateService()
void	sendPackage(PackageId id) It does the followings for the package ID specified as argument:
void	uploadDocument(Document document, DocumentPackage documentPackage)
void	uploadDocument(String fileName, byte[] fileContent, Document document, DocumentPackage documentPackage)

Methods inherited from class java.lang.Object

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

Constructor Detail

EslClient

public EslClient(String apiKey,
         String baseURL)

The constructor of the EslClient class

Parameters:

apiKey - the api key token

baseURL - the E-SignLive base url

Method Detail

getPackageService

public PackageService getPackageService()

Gets the package service

Returns:

the package 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

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

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

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(DocumentPackage documentPackage,
                                  PackageId packageId)

Creates a package based on an existent template

Parameters:

documentPackage - the document package

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

Returns:

the package ID

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)
                                      throws EslException

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

Throws:

EslException

createSessionToken

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

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

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

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

uploadDocument

public void uploadDocument(Document document,
                  DocumentPackage documentPackage)

getGroupService

public GroupService getGroupService()

getAccountService

public AccountService getAccountService()

getApprovalService

public ApprovalService getApprovalService()

getReminderService

public ReminderService getReminderService()

getTemplateService

public TemplateService getTemplateService()

getAttachmentRequirementService

public AttachmentRequirementService getAttachmentRequirementService()

getLayoutService

public LayoutService getLayoutService()

getQrCodeService

public QRCodeService getQrCodeService()