com.cryptshare.api

Class Client

java.lang.Object

com.cryptshare.api.Client

All Implemented Interfaces:

IClient

public class Client
extends java.lang.Object
implements IClient

Central client that is used to carry out request and operations on the Cryptshare Server, as a specified user.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MINIMUM_SERVER_VERSION

Constructor Summary

Constructors

Constructor and Description
Client(java.lang.String userEmailAddress, CryptshareConnection connection, java.nio.file.Path storePath) Constructs a Client instance that sets the Locale.getDefault() as user language, and uses a file based store to persist information.
Client(java.lang.String userEmailAddress, CryptshareConnection connection, java.nio.file.Path storePath, ProtectionScope protectionScope) Constructs a Client instance that sets the Locale.getDefault() as user language, and uses a file based store to persist information.
Client(java.lang.String userEmailAddress, java.util.Locale userLanguage, CryptshareConnection connection, IStore store) Constructs a Client instance with a custom IStore implementation.
Client(java.lang.String userEmailAddress, java.util.Locale userLanguage, CryptshareConnection connection, java.nio.file.Path storePath) Constructs a Client instance that sets the Locale.getDefault() as user language, and uses a file based store to persist information.
Client(java.lang.String userEmailAddress, java.util.Locale userLanguage, CryptshareConnection connection, java.nio.file.Path storePath, ProtectionScope protectionScope) Constructs a Client instance that sets the Locale as user language, and uses a file based store to persist information.

Method Summary

Modifier and Type	Method and Description
void	applyQuickActivationCode(java.lang.String recoveryCode) Applies a QUICK activation code to activate QUICK access for the user on this client.
void	beginTransfer(Transfer transfer, IUploadProgressChangedHandler uploadProgressChangedCallback, IUploadCompleteHandler uploadCompleteCallback, IUploadInterruptedHandler uploadInterruptedCallback, IUploadCancelledHandler uploadCancelledCallback, int pollingTimer) Performs a transfer asynchronously in a separate thread.
void	cancelTransfer() Cancels a currently ongoing transfer.
boolean	checkCompatibility() Performs a compatibility check of this API against the Cryptshare Server.
boolean	checkCompatibility(java.lang.String minimumServerVersion) Performs a compatibility check against the Cryptshare Server.
PasswordCheckResult	checkPassword(java.lang.String password) Checks the given password against the password policy defined on the server.
CheckVerificationResult	checkVerification() Requests information about the verification configuration on the server and the current verification state of the user on this client.
void	confirmQuickConnection(java.lang.String metaId, java.lang.String password) Confirms/activates the QUICK connection that has been offered with a transfer.
void	confirmSenderVerification(java.lang.String verificationCode) Completes the sender verification process by confirming it with the the received verification code.
void	enableVerificationForQuick() Enables the verification of the user for QUICK so that it can be used to send and retrieve QUICK transfers.
java.lang.String	generateQuickActivationCode() Generates a activation code for client activation.
java.lang.String	getClientId() Returns the identifier if the client, which is generated automatically together with the store file.
java.lang.String	getServerUrl() Returns the Cryptshare Server URL that is set for this client.
java.lang.String	getUserEmailAddress() Returns the email address of the user that is set for this client.
java.util.Locale	getUserLanguage() Returns the language/region that is set for this client.
java.lang.String	getVerificationToken() Returns the verification token for the user that is set for this client.
void	performTransfer(Transfer transfer, IUploadProgressChangedHandler uploadProgressChangedCallback, IUploadCompleteHandler uploadCompleteCallback, IUploadInterruptedHandler uploadInterruptedCallback, IUploadCancelledHandler uploadCancelledCallback, int pollingTimer) Performs a transfer synchronously in the current thread.
void	performTransfer(Transfer transfer, IUploadProgressChangedHandler uploadProgressChangedCallback, IUploadCompleteHandler uploadCompleteCallback, IUploadInterruptedHandler uploadInterruptedCallback, IUploadCancelledHandler uploadCancelledCallback, int pollingTimer, IUploadFilesFinishedHandler uploadFilesFinishedHandler) Performs a transfer synchronously in the current thread.
java.util.Map<java.lang.String,java.lang.String>	requestActiveTransfers() Requests all active transfers where this client's sender address is a recipient.
java.util.Map<java.lang.String,AddOnOptionValue>	requestAddOnSettings() Requests the Add-On settings from the server.
void	requestClientVerification() Requests a client verification.
java.util.Map<java.util.List<java.lang.String>,java.lang.String>	requestEmailTemplate(java.lang.String templateName, java.util.Map<java.util.Set<java.lang.String>,java.util.Set<TemplateReplacement>> replacements, java.util.Locale locale, EmailFormat mailFormat) Requests several resolved template content strings at once.
java.lang.String	requestGeneratedPassword(int length) Requests a generated password with the given length from the Cryptshare Server.
byte[]	requestLanguagePackFile(java.lang.String filePath, java.util.Locale locale) Downloads a single language pack resource.
java.util.List<LanguagePack>	requestLanguagePacks() Requests info about the language packs that are available on the server.
LicenseInfo	requestLicenseInfo() Requests the license info for the Cryptshare server and this product.
PasswordPolicy	requestPasswordPolicy() Requests the password policy from the server.
Policy	requestPolicy(java.util.Collection<java.lang.String> recipients) Request the policy rules that applies to the combination of the current user as sender, and the specified recipients.
java.util.Map<java.lang.String,QuickConnectionState>	requestQuickConnectionStates(java.util.List<java.lang.String> userEmailAddresses) Requests the QuickConnectionState for each of the specified recipients.
RecipientQuickState	requestRecipientQuickState(java.lang.String metaId) Requests information about the QUICK state of a transfer recipient.
void	requestSenderVerification() Requests a sender verification.
ServerData	requestServerData() Requests the general server settings from the Cryptshare server.
TermsOfUse	requestTermsOfUse() Requests the Terms of Use from the server.
void	resetQuickState() Resets the QUICK state of the user on the Cryptshare server.
void	revokeTransfer(java.lang.String trackingId) Revokes the transfer with the given trackingId such that its files are no longer accessible.
void	revokeTransfer(java.lang.String trackingId, boolean notifyRecipient, boolean notifySender) Revokes the transfer with the given trackingId such that its files are no longer accessible.
void	revokeTransfer(java.lang.String trackingId, boolean notifyRecipient, boolean notifySender, java.lang.String message) Revokes the transfer with the given trackingId such that its files are no longer accessible.
void	revokeTransfer(java.lang.String trackingId, java.lang.String message) Revokes the transfer with the given trackingId such that its files are no longer accessible.
void	setUserLanguage(java.util.Locale userLanguage) Sets the language/region for this client.
void	updateTransferError(java.lang.String trackingId, TransferError transferError) Updates the error status for the Transfer with the given tracking ID.

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_SERVER_VERSION

public static final java.lang.String MINIMUM_SERVER_VERSION

See Also:

Constant Field Values

Constructor Detail

Client

public Client(java.lang.String userEmailAddress,
              CryptshareConnection connection,
              java.nio.file.Path storePath)
       throws ClientException

Constructs a Client instance that sets the Locale.getDefault() as user language, and uses a file based store to persist information. The file contents are protected on machine scope. This means that the created client store file cannot be used on another host. Depending on the OS, a default IProtectionService is to protect the store:

• Linux/MacOS: AES encryption, using AesProtectionService with LinuxKeySourceProvider.
• Windows: Windows DPAPI, using DpApiProtectionService.

Parameters:

userEmailAddress - The email address of the user that acts as initiating user (that is, most of the time, as sender) for the opertions.

connection - The CryptshareConnection for the targeted Cryptshare Server.

storePath - The path to the store file or directory. If the path points to an existing directory, a file named 'client.store' will be created in there.

Throws:

ClientException - If the Client can't be created using the given CryptshareConnection.

Client

public Client(java.lang.String userEmailAddress,
              java.util.Locale userLanguage,
              CryptshareConnection connection,
              java.nio.file.Path storePath)
       throws ClientException

Constructs a Client instance that sets the Locale.getDefault() as user language, and uses a file based store to persist information. The file contents are protected on machine scope. This means that the created client store file cannot be used on another host. Depending on the OS, a default IProtectionService is to protect the store:

• Linux/MacOS: AES encryption, using AesProtectionService with LinuxKeySourceProvider.
• Windows: Windows DPAPI, using DpApiProtectionService.

Parameters:

userEmailAddress - The email address of the user that acts as initiating user (that is, most of the time, as sender) for the opertions.

userLanguage - The language/region of the user. This sets the default language for all requests, for example to set the sender language for transfers. It may be null, in which case the Locale.getDefault() is set.

connection - The CryptshareConnection for the targeted Cryptshare Server.

storePath - The path to the store file or directory. If the path points to an existing directory, a file named 'client.store' will be created in there.

Throws:

ClientException - If the Client can't be created using the given CryptshareConnection.

Client

public Client(java.lang.String userEmailAddress,
              CryptshareConnection connection,
              java.nio.file.Path storePath,
              ProtectionScope protectionScope)
       throws ClientException

Constructs a Client instance that sets the Locale.getDefault() as user language, and uses a file based store to persist information. Depending on the OS, a default IProtectionService is to protect the store:

• Linux/MacOS: AES encryption, using AesProtectionService with LinuxKeySourceProvider.
• Windows: Windows DPAPI, using DpApiProtectionService.

Parameters:

userEmailAddress - The email address of the user that acts as initiating user (that is, most of the time, as sender) for the opertions.

connection - The CryptshareConnection for the targeted Cryptshare Server.

storePath - The path to the store file or directory. If the path points to an existing directory, a file named 'client.store' will be created in there.

protectionScope - The ProtectionScope that is used to protect the data in the store file. On Linux, only ProtectionScope.LOCAL_MACHINE is valid.

Throws:

ClientException - If the Client can't be created using the given CryptshareConnection.

Client

public Client(java.lang.String userEmailAddress,
              java.util.Locale userLanguage,
              CryptshareConnection connection,
              java.nio.file.Path storePath,
              ProtectionScope protectionScope)
       throws ClientException

Constructs a Client instance that sets the Locale as user language, and uses a file based store to persist information. Depending on the OS, a default IProtectionService is to protect the store:

• Linux/MacOS: AES encryption, using AesProtectionService with LinuxKeySourceProvider.
• Windows: Windows DPAPI, using DpApiProtectionService.

Parameters:

userEmailAddress - The email address of the user that acts as initiating user (that is, most of the time, as sender) for the opertions.

userLanguage - The language/region of the user. This sets the default language for all requests, for example to set the sender language for transfers. It may be null, in which case the Locale.getDefault() is set.

connection - The CryptshareConnection for the targeted Cryptshare Server.

storePath - The path to the store file or directory. If the path points to an existing directory, a file named 'client.store' will be created in there.

protectionScope - The ProtectionScope that is used to protect the data in the store file. On Linux, only ProtectionScope.LOCAL_MACHINE is valid.

Throws:

ClientException - If the Client can't be created using the given CryptshareConnection.

Client

public Client(java.lang.String userEmailAddress,
              java.util.Locale userLanguage,
              CryptshareConnection connection,
              IStore store)
       throws ClientException

Constructs a Client instance with a custom IStore implementation.

Parameters:

userEmailAddress - The email address of the user that acts as initiating user (that is, most of the time, as sender) for the opertions.

userLanguage - The language/region of the user. This sets the default language for all requests, for example to set the sender language for transfers. It may be null, in which case the Locale.getDefault() is set.

connection - The CryptshareConnection for the targeted Cryptshare Server.

store - An IStore instance that persists the clients state.

Throws:

ClientException - If the Client can't be created using the given CryptshareConnection.

Method Detail

checkVerification

public CheckVerificationResult checkVerification()
                                          throws CryptshareServerException,
                                                 ClientException

Description copied from interface: IClient

Requests information about the verification configuration on the server and the current verification state of the user on this client.

Specified by:

checkVerification in interface IClient

Returns:

A CheckVerificationResult object that contains information about the verification state and configuration.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestClientVerification

public void requestClientVerification()
                               throws ClientException,
                                      CryptshareServerException

Description copied from interface: IClient

Requests a client verification. This automatically verifies the user, if client verification is enabled on the Cryptshare Server and the client ID has been added to the list of allowed clients.

Specified by:

requestClientVerification in interface IClient

Throws:

ClientException - If the API failed to process the request.

CryptshareServerException - If the Cryptshare Server failed to process the request.

requestPolicy

public Policy requestPolicy(java.util.Collection<java.lang.String> recipients)
                     throws CryptshareServerException,
                            ClientException

Description copied from interface: IClient

Request the policy rules that applies to the combination of the current user as sender, and the specified recipients.

Specified by:

requestPolicy in interface IClient

Parameters:

recipients - The email addresses of the recipients

Returns:

The Policy containing the policy rules

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestAddOnSettings

public java.util.Map<java.lang.String,AddOnOptionValue> requestAddOnSettings()
                                                                      throws CryptshareServerException,
                                                                             ClientException

Requests the Add-On settings from the server.

Returns:

a map containing the add-on settings info

Throws:

CryptshareServerException - Cryptshare server exception

ClientException - client exception

requestLanguagePacks

public java.util.List<LanguagePack> requestLanguagePacks()
                                                  throws CryptshareServerException,
                                                         ClientException

Description copied from interface: IClient

Requests info about the language packs that are available on the server. Uses the default language pack major version of the Client, as defined when creating the CryptshareConnection.

Specified by:

requestLanguagePacks in interface IClient

Returns:

A list of languages that are available on the server

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestLanguagePackFile

public byte[] requestLanguagePackFile(java.lang.String filePath,
                                      java.util.Locale locale)
                               throws CryptshareServerException,
                                      ClientException

Description copied from interface: IClient

Downloads a single language pack resource. Uses the default language pack major version of the Client, as defined when creating the CryptshareConnection.

Specified by:

requestLanguagePackFile in interface IClient

Parameters:

filePath - The path to the resource, relative to the language pack root.

locale - The Locale of the requested language pack file

Returns:

The raw bytes of the language pack file.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestTermsOfUse

public TermsOfUse requestTermsOfUse()
                             throws CryptshareServerException,
                                    ClientException

Description copied from interface: IClient

Requests the Terms of Use from the server.

Specified by:

requestTermsOfUse in interface IClient

Returns:

A TermsOfUse object containing a list of key/value entries where the key is the locale, and the value is the actual text of the Terms of Use for that language.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestLicenseInfo

public LicenseInfo requestLicenseInfo()
                               throws CryptshareServerException,
                                      ClientException

Description copied from interface: IClient

Requests the license info for the Cryptshare server and this product.

Specified by:

requestLicenseInfo in interface IClient

Returns:

A LicenseInfo object containing the license information

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestServerData

public ServerData requestServerData()
                             throws CryptshareServerException,
                                    ClientException

Description copied from interface: IClient

Requests the general server settings from the Cryptshare server.

Specified by:

requestServerData in interface IClient

Returns:

A ServerData object containing the server settings.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestActiveTransfers

public java.util.Map<java.lang.String,java.lang.String> requestActiveTransfers()
                                                                        throws CryptshareServerException,
                                                                               ClientException

Description copied from interface: IClient

Requests all active transfers where this client's sender address is a recipient. This operation will fail if the client is not yet verified.

Specified by:

requestActiveTransfers in interface IClient

Returns:

A map where the keys are the transfer meta ids, and the values are the download URLs of the these transfers, without the password.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestGeneratedPassword

public java.lang.String requestGeneratedPassword(int length)
                                          throws CryptshareServerException,
                                                 ClientException

Description copied from interface: IClient

Requests a generated password with the given length from the Cryptshare Server. The server assures that the generated password fulfils the policy.

Specified by:

requestGeneratedPassword in interface IClient

Parameters:

length - The length of the password to generate.

Returns:

The generated password.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

checkPassword

public PasswordCheckResult checkPassword(java.lang.String password)
                                  throws CryptshareServerException,
                                         ClientException

Description copied from interface: IClient

Checks the given password against the password policy defined on the server.

Specified by:

checkPassword in interface IClient

Parameters:

password - String with password to check

Returns:

A PasswordPolicy object containing the password policy information and a security rating for the password.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestEmailTemplate

public java.util.Map<java.util.List<java.lang.String>,java.lang.String> requestEmailTemplate(java.lang.String templateName,
                                                                                             java.util.Map<java.util.Set<java.lang.String>,java.util.Set<TemplateReplacement>> replacements,
                                                                                             java.util.Locale locale,
                                                                                             EmailFormat mailFormat)
                                                                                      throws CryptshareServerException,
                                                                                             ClientException

Description copied from interface: IClient

Requests several resolved template content strings at once. Each set of different replacements (a certain Set with TemplateReplacements) has a corresponing Set of identifiers (e.g. recipients), to which the replacements belong. The result will return the distinct and (partially) resolved templates with all identifiers that led to that certain template result.

Specified by:

requestEmailTemplate in interface IClient

Parameters:

templateName - The name of the template, for example "recipient" or "sender"

replacements - Associations between a list of identifiers (e.g. recipients) and replacements.

locale - The Locale for which the template is requested

mailFormat - The email format of the template as EmailFormat.

Returns:

the Map containing the email template variants for each set of identifiers.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

updateTransferError

public void updateTransferError(java.lang.String trackingId,
                                TransferError transferError)
                         throws CryptshareServerException,
                                ClientException

Description copied from interface: IClient

Updates the error status for the Transfer with the given tracking ID.

Specified by:

updateTransferError in interface IClient

Parameters:

trackingId - The tracking ID of the transfer whose error status is to be updated

transferError - The error information. For this webservice call, TransferError.isAllNotificationsFailed(), TransferError.isEmlCreationFailed(), TransferError.isSenderNotificationFailed() flags and TransferError.getFailedRecipients() is updated.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

cancelTransfer

public void cancelTransfer()

Description copied from interface: IClient

Cancels a currently ongoing transfer.

Specified by:

cancelTransfer in interface IClient

beginTransfer

public void beginTransfer(Transfer transfer,
                          IUploadProgressChangedHandler uploadProgressChangedCallback,
                          IUploadCompleteHandler uploadCompleteCallback,
                          IUploadInterruptedHandler uploadInterruptedCallback,
                          IUploadCancelledHandler uploadCancelledCallback,
                          int pollingTimer)

Description copied from interface: IClient

Performs a transfer asynchronously in a separate thread. The method returns immediately, and the transfer progress is signalled by the various callbacks.

Specified by:

beginTransfer in interface IClient

Parameters:

transfer - The transfer to be performed asynchronously

uploadProgressChangedCallback - This callback is called regularly with current information about the progress.

uploadCompleteCallback - This callback is called when the transfer completes without cancellation.

uploadInterruptedCallback - This callback is called when the transfer is interrupted due to exceptions.

uploadCancelledCallback - This callback is called when the user cancelled the transfer.

pollingTimer - The time in milliseconds between two checks of transfer state during the pre-processing.

performTransfer

public void performTransfer(Transfer transfer,
                            IUploadProgressChangedHandler uploadProgressChangedCallback,
                            IUploadCompleteHandler uploadCompleteCallback,
                            IUploadInterruptedHandler uploadInterruptedCallback,
                            IUploadCancelledHandler uploadCancelledCallback,
                            int pollingTimer)
                     throws CryptshareServerException,
                            ClientException

Description copied from interface: IClient

Performs a transfer synchronously in the current thread. The transfer progress is signalled by the various callbacks.

Specified by:

performTransfer in interface IClient

Parameters:

transfer - The transfer to be performed synchronously

uploadProgressChangedCallback - This callback is called regularly with current information about the progress.

uploadCompleteCallback - This callback is called when the transfer completes without cancellation.

uploadInterruptedCallback - This callback is called when the transfer is interrupted due to exceptions.

uploadCancelledCallback - This callback is called when the user cancelled the transfer.

pollingTimer - The time in milliseconds between two checks of transfer state during the pre-processing.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

performTransfer

public void performTransfer(Transfer transfer,
                            IUploadProgressChangedHandler uploadProgressChangedCallback,
                            IUploadCompleteHandler uploadCompleteCallback,
                            IUploadInterruptedHandler uploadInterruptedCallback,
                            IUploadCancelledHandler uploadCancelledCallback,
                            int pollingTimer,
                            IUploadFilesFinishedHandler uploadFilesFinishedHandler)
                     throws CryptshareServerException,
                            ClientException

Description copied from interface: IClient

Performs a transfer synchronously in the current thread. The transfer progress is signalled by the various callbacks.

Specified by:

performTransfer in interface IClient

Parameters:

transfer - The transfer to be performed synchronously

uploadProgressChangedCallback - This callback is called regularly with current information about the progress.

uploadCompleteCallback - This callback is called when the transfer completes without cancellation.

uploadInterruptedCallback - This callback is called when the transfer is interrupted due to exceptions.

uploadCancelledCallback - This callback is called when the user cancelled the transfer.

pollingTimer - The time in milliseconds between two checks of transfer state during the pre-processing.

uploadFilesFinishedHandler - This callback is called when the file upload is finished, but before they are processed by the server.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestQuickConnectionStates

public java.util.Map<java.lang.String,QuickConnectionState> requestQuickConnectionStates(java.util.List<java.lang.String> userEmailAddresses)
                                                                                  throws CryptshareServerException,
                                                                                         ClientException

Description copied from interface: IClient

Requests the QuickConnectionState for each of the specified recipients.

Specified by:

requestQuickConnectionStates in interface IClient

Parameters:

userEmailAddresses - A collection of email addresses to request the QUICK connection state for.

Returns:

A map with the email addresses as keys, and the respective QuickConnectionState"/> as values.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

generateQuickActivationCode

public java.lang.String generateQuickActivationCode()
                                             throws CryptshareServerException,
                                                    ClientException

Description copied from interface: IClient

Generates a activation code for client activation. It is required that the client user is already verified and enabled for the use of QUICK on this client.

Specified by:

generateQuickActivationCode in interface IClient

Returns:

The generated activation code.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

applyQuickActivationCode

public void applyQuickActivationCode(java.lang.String recoveryCode)
                              throws CryptshareServerException,
                                     ClientException

Description copied from interface: IClient

Applies a QUICK activation code to activate QUICK access for the user on this client.

Specified by:

applyQuickActivationCode in interface IClient

Parameters:

recoveryCode - The activation code.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

enableVerificationForQuick

public void enableVerificationForQuick()
                                throws CryptshareServerException,
                                       ClientException

Description copied from interface: IClient

Enables the verification of the user for QUICK so that it can be used to send and retrieve QUICK transfers.

Specified by:

enableVerificationForQuick in interface IClient

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

resetQuickState

public void resetQuickState()
                     throws CryptshareServerException,
                            ClientException

Description copied from interface: IClient

Resets the QUICK state of the user on the Cryptshare server. As a last resort, this allows the use of QUICK again if the access is lost and no recovery options are available. Caution: This will remove all established and pending QUICK connections to other users, and may lead to transfers that can't be retrieved anymore.

Specified by:

resetQuickState in interface IClient

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

confirmQuickConnection

public void confirmQuickConnection(java.lang.String metaId,
                                   java.lang.String password)
                            throws CryptshareServerException,
                                   ClientException

Description copied from interface: IClient

Confirms/activates the QUICK connection that has been offered with a transfer.

Specified by:

confirmQuickConnection in interface IClient

Parameters:

metaId - The recipient's meta ID of the transfer.

password - The password to retrieve the transfer.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestRecipientQuickState

public RecipientQuickState requestRecipientQuickState(java.lang.String metaId)
                                               throws CryptshareServerException,
                                                      ClientException

Description copied from interface: IClient

Requests information about the QUICK state of a transfer recipient.

Specified by:

requestRecipientQuickState in interface IClient

Parameters:

metaId - The recipient's meta ID of the transfer.

Returns:

A RecipientQuickState object with further information.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

requestSenderVerification

public void requestSenderVerification()
                               throws CryptshareServerException,
                                      ClientException

Description copied from interface: IClient

Requests a sender verification. This triggers the server to send an email to the user's email address with a verification code. The verification code then has to be provided using IClient.confirmSenderVerification(String).

Specified by:

requestSenderVerification in interface IClient

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

confirmSenderVerification

public void confirmSenderVerification(java.lang.String verificationCode)
                               throws CryptshareServerException,
                                      ClientException

Description copied from interface: IClient

Completes the sender verification process by confirming it with the the received verification code.

Specified by:

confirmSenderVerification in interface IClient

Parameters:

verificationCode - The verification code that has been received after calling IClient.requestSenderVerification()

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

checkCompatibility

public boolean checkCompatibility()
                           throws ClientException

Description copied from interface: IClient

Performs a compatibility check of this API against the Cryptshare Server.

Specified by:

checkCompatibility in interface IClient

Returns:

true, if the configured Cryptshare server is compatible to this version of the API.

Throws:

ClientException - If the API failed to process the request.

checkCompatibility

public boolean checkCompatibility(java.lang.String minimumServerVersion)
                           throws ClientException

Description copied from interface: IClient

Performs a compatibility check against the Cryptshare Server. The Cryptshare Server reports compatible, if the current Cryptshare Server version has no breaking changes compared to the requested Cryptshare Server version. This method can be used by API integration products, that require a certain minimum Cryptshare Server version. To check the compatibility of the API itself, use IClient.checkCompatibility() instead.

Specified by:

checkCompatibility in interface IClient

Parameters:

minimumServerVersion - The minimum server version.

Returns:

true, if the configured Cryptshare Server is compatible with the specified version of the API.

Throws:

ClientException - If the API failed to process the request.

requestPasswordPolicy

public PasswordPolicy requestPasswordPolicy()
                                     throws CryptshareServerException,
                                            ClientException

Description copied from interface: IClient

Requests the password policy from the server.

Specified by:

requestPasswordPolicy in interface IClient

Returns:

PasswordPolicy with the current password policy from the server.

Throws:

CryptshareServerException - If the Cryptshare Server failed to process the request.

ClientException - If the API failed to process the request.

revokeTransfer

public void revokeTransfer(java.lang.String trackingId)
                    throws ClientException,
                           CryptshareServerException

Description copied from interface: IClient

Revokes the transfer with the given trackingId such that its files are no longer accessible.

Specified by:

revokeTransfer in interface IClient

Parameters:

trackingId - The tracking ID of the transfer to revoke.

Throws:

ClientException - If the API failed to process the request.

CryptshareServerException - CryptshareServerException indicating: Either no transfer matching the given trackingId was found, The requesting user is not the sender of the transfer Failed to delete transfer files. Failed to send email notification to recipients.

revokeTransfer

public void revokeTransfer(java.lang.String trackingId,
                           boolean notifyRecipient,
                           boolean notifySender)
                    throws ClientException,
                           CryptshareServerException

Description copied from interface: IClient

Revokes the transfer with the given trackingId such that its files are no longer accessible.

Specified by:

revokeTransfer in interface IClient

Parameters:

trackingId - The tracking ID of the transfer to revoke.

notifyRecipient - Whether the recipient receives an email notification.

notifySender - Whether the sender receives an email notification.

Throws:

ClientException - If the API failed to process the request.

CryptshareServerException - CryptshareServerException indicating:

• No transfer matching the given trackingId was found.
• The requesting user is not the sender of the transfer.
• Failed to delete transfer files.
• Failed to send email notification to recipients.

revokeTransfer

public void revokeTransfer(java.lang.String trackingId,
                           java.lang.String message)
                    throws ClientException,
                           CryptshareServerException

Description copied from interface: IClient

Revokes the transfer with the given trackingId such that its files are no longer accessible.

Specified by:

revokeTransfer in interface IClient

Parameters:

trackingId - The tracking ID of the transfer to revoke.

message - The email notification message. If a default message is set..

Throws:

ClientException - If the API failed to process the request.

CryptshareServerException - CryptshareServerException indicating:

• No transfer matching the given trackingId was found.
• The requesting user is not the sender of the transfer.
• Failed to delete transfer files.
• Failed to send email notification to recipients.

revokeTransfer

public void revokeTransfer(java.lang.String trackingId,
                           boolean notifyRecipient,
                           boolean notifySender,
                           java.lang.String message)
                    throws ClientException,
                           CryptshareServerException

Description copied from interface: IClient

Revokes the transfer with the given trackingId such that its files are no longer accessible.

Specified by:

revokeTransfer in interface IClient

Parameters:

trackingId - The tracking ID of the transfer to revoke.

notifyRecipient - Whether the recipient receives an email notification.

notifySender - Whether the sender receives an email notification.

message - The email notification message. If a default message is set..

Throws:

ClientException - If the API failed to process the request.

CryptshareServerException - CryptshareServerException indicating:

• No transfer matching the given trackingId was found.
• The requesting user is not the sender of the transfer.
• Failed to delete transfer files.
• Failed to send email notification to recipients.

getClientId

public java.lang.String getClientId()

Description copied from interface: IClient

Returns the identifier if the client, which is generated automatically together with the store file.

Specified by:

getClientId in interface IClient

getUserEmailAddress

public java.lang.String getUserEmailAddress()

Description copied from interface: IClient

Returns the email address of the user that is set for this client.

Specified by:

getUserEmailAddress in interface IClient

Returns:

The email address.

getVerificationToken

public java.lang.String getVerificationToken()

Description copied from interface: IClient

Returns the verification token for the user that is set for this client.

Specified by:

getVerificationToken in interface IClient

Returns:

The verification token.

getUserLanguage

public java.util.Locale getUserLanguage()

Description copied from interface: IClient

Returns the language/region that is set for this client.

Specified by:

getUserLanguage in interface IClient

Returns:

The language/region as Locale.

getServerUrl

public java.lang.String getServerUrl()

Description copied from interface: IClient

Returns the Cryptshare Server URL that is set for this client.

Specified by:

getServerUrl in interface IClient

Returns:

The Cryptshare Server URL.

setUserLanguage

public void setUserLanguage(java.util.Locale userLanguage)

Description copied from interface: IClient

Sets the language/region for this client.

Specified by:

setUserLanguage in interface IClient

Parameters:

userLanguage - The language/region as Locale.