public final class SignerBuilder extends Object
The SignerBuilder class is a convenient class used to create and customize a signer.
Modifier and Type | Class and Description |
---|---|
static class |
SignerBuilder.AuthenticationBuilder
Authentication builder is a convenient class used to create an Authentication object
with email defined as the authentication method.
|
static class |
SignerBuilder.ChallengeBuilder
Challenge builder is a convenient class used to create an Authentication
object.
|
static class |
SignerBuilder.SMSAuthenticationBuilder |
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_SIGNING_ORDER |
Modifier and Type | Method and Description |
---|---|
Signer |
build()
Builds the actual signer object.
|
SignerBuilder |
canChangeSigner()
The signer can assign someone else to sign the package.
|
SignerBuilder |
challengedWithKnowledgeBasedAuthentication(KnowledgeBasedAuthentication knowledgeBasedAuthentication)
Adds KBA to the signer.
|
SignerBuilder |
challengedWithKnowledgeBasedAuthentication(SignerInformationForEquifaxCanada signerInformationForEquifaxCanada)
Adds a signer information for Equifax Canada to the signer.
|
SignerBuilder |
challengedWithKnowledgeBasedAuthentication(SignerInformationForEquifaxCanadaBuilder signerInformationForEquifaxCanadaBuilder)
Adds a signer information for Equifax Canada to the signer.
|
SignerBuilder |
challengedWithKnowledgeBasedAuthentication(SignerInformationForEquifaxUSA signerInformationForEquifaxUSA)
Adds a signer information for Equifax USA to the signer.
|
SignerBuilder |
challengedWithKnowledgeBasedAuthentication(SignerInformationForEquifaxUSABuilder signerInformationForEquifaxUSABuilder)
Adds a signer information for Equifax USA to the signer.
|
SignerBuilder |
challengedWithQuestions(SignerBuilder.ChallengeBuilder challengeBuilder)
Sets the signer's authentication type to CHALLENGE.
|
SignerBuilder |
deliverSignedDocumentsByEmail()
Invoking this method results in documents being distributed back to the sender as an email attachments once the package is complete.
|
SignerBuilder |
lock()
Locks the signer.
|
static SignerBuilder |
newSignerFromGroup(GroupId groupId)
Creates a SignerBuilder object.
|
static SignerBuilder |
newSignerPlaceholder(Placeholder roleId)
Creates a SignerBuilder object.
|
static SignerBuilder |
newSignerWithEmail(String email)
Creates a SignerBuilder object.
|
SignerBuilder |
replacing(Placeholder placeholder)
Sets the signer's ID to the placeholder's ID.
|
SignerBuilder |
signingOrder(int signingOrder)
Sets the signing order.
|
SignerBuilder |
withAttachmentRequirement(AttachmentRequirement attachmentRequirement)
Adds an attachment requirement for the signer.
|
SignerBuilder |
withAttachmentRequirement(AttachmentRequirementBuilder builder)
Adds an attachment requirement for the signer.
|
SignerBuilder |
withAuthentication(Authentication authentication)
Sets the Signer's authentication.
|
SignerBuilder |
withCompany(String company)
Sets the signer's company name.
|
SignerBuilder |
withCustomId(String id)
Sets the ID of the signer for this package.
|
SignerBuilder |
withEmailMessage(String message)
Sets the signer's email message they will receive in the email invitation to start the signing ceremony.
|
SignerBuilder |
withFirstName(String firstName)
Sets the signer's first name.
|
SignerBuilder |
withLastName(String lastName)
Sets the signer's last name.
|
SignerBuilder |
withRoleId(String roleId)
Deprecated.
Use withCustomId() from now on. Will get deleted in a future release
|
SignerBuilder |
withSmsSentTo(String phoneNumber)
Sets the signer's authentication type to SMS.
|
SignerBuilder |
withTitle(String title)
Sets the signer's title.
|
public static final int DEFAULT_SIGNING_ORDER
public static SignerBuilder newSignerWithEmail(String email)
Creates a SignerBuilder object.
email
- the signer's email @size(min="6", max="255", valid email address)public static SignerBuilder newSignerFromGroup(GroupId groupId)
Creates a SignerBuilder object.
groupId
- the group ID.public static SignerBuilder newSignerPlaceholder(Placeholder roleId)
Creates a SignerBuilder object.
roleId
- the placeholder's ID.public SignerBuilder withCustomId(String id)
E.g.: the signer's email makes for a good unique ID. [email protected]
id
- the signer's ID @size(min="1", max="64")public SignerBuilder replacing(Placeholder placeholder)
placeholder
- public SignerBuilder withFirstName(String firstName)
firstName
- the signer's first name @size(min="1", max="64")public SignerBuilder withLastName(String lastName)
lastName
- the signer's last name @size(min="1", max="64")public SignerBuilder signingOrder(int signingOrder)
E.g.: a signer with a signingOrder of 1 would be required to sign before a signer with a signingOrder of 2, for example.
signingOrder
- a value greater than zeropublic Signer build()
public SignerBuilder challengedWithQuestions(SignerBuilder.ChallengeBuilder challengeBuilder)
Sets the signer's authentication type to CHALLENGE.
The signer will be asked to authenticate, before accessing his signing ceremony, by providing answers to authentication questions.challengeBuilder
- the challenge builderSignerBuilder.ChallengeBuilder
public SignerBuilder withSmsSentTo(String phoneNumber)
Sets the signer's authentication type to SMS.
The signer will be asked to authenticate, before accessing his signing ceremony, by providing an SMS PIN number that will have been sent by e-SignLive to his phone.phoneNumber
- the signer's cellphone number to which the SMS PIN number will be sent @size(min="10", max="40")public SignerBuilder withAuthentication(Authentication authentication)
authentication
- the authentication objectpublic SignerBuilder withTitle(String title)
Sets the signer's title.
E.g.: Mr., Mrs., Ms., etc...title
- the signer's title @size(min="0", max="64")public SignerBuilder withCompany(String company)
Sets the signer's company name.
company
- the signer's company name @size(max="255")EslException
- throws an exception if signer is a group signer.public SignerBuilder canChangeSigner()
Sets the canChangeSigner property to true.
public SignerBuilder withEmailMessage(String message)
message
- the message the signer will receive in the email invitation to start the signing ceremony @size(min="0", max="2000")public SignerBuilder deliverSignedDocumentsByEmail()
Invoking this method results in documents being distributed back to the sender as an email attachments once the package is complete.
public SignerBuilder lock()
@Deprecated public SignerBuilder withRoleId(String roleId)
roleId
- public SignerBuilder withAttachmentRequirement(AttachmentRequirementBuilder builder)
Adds an attachment requirement for the signer. The attachment requirement is conveniently customized by the builder provided as parameter.
builder
- the attachment requirement builderAttachmentRequirementBuilder
public SignerBuilder withAttachmentRequirement(AttachmentRequirement attachmentRequirement)
attachmentRequirement
- the attachmentpublic SignerBuilder challengedWithKnowledgeBasedAuthentication(KnowledgeBasedAuthentication knowledgeBasedAuthentication)
Adds KBA to the signer.
knowledgeBasedAuthentication
- knowledge based authenticationpublic SignerBuilder challengedWithKnowledgeBasedAuthentication(SignerInformationForEquifaxCanadaBuilder signerInformationForEquifaxCanadaBuilder)
Adds a signer information for Equifax Canada to the signer. The signer information is conveniently customized by the builder provided as parameter.
signerInformationForEquifaxCanadaBuilder
- the signer builder for Equifax Canadapublic SignerBuilder challengedWithKnowledgeBasedAuthentication(SignerInformationForEquifaxCanada signerInformationForEquifaxCanada)
Adds a signer information for Equifax Canada to the signer.
signerInformationForEquifaxCanada
- a signer information for Equifax Canadapublic SignerBuilder challengedWithKnowledgeBasedAuthentication(SignerInformationForEquifaxUSABuilder signerInformationForEquifaxUSABuilder)
Adds a signer information for Equifax USA to the signer. The signer information is conveniently customized by the builder provided as parameter.
signerInformationForEquifaxUSABuilder
- the signer builder for Equifax USApublic SignerBuilder challengedWithKnowledgeBasedAuthentication(SignerInformationForEquifaxUSA signerInformationForEquifaxUSA)
Adds a signer information for Equifax USA to the signer.
signerInformationForEquifaxUSA
- a signer information for Equifax USACopyright 2014, Silanis Technology, Inc. All rights reserved.