|
|
| Zeile 5: |
Zeile 5: |
| = Cryptshare Java API Manual = | | = Cryptshare Java API Manual = |
| This is the homepage of the English manual for the Cryptshare Java API. | | This is the homepage of the English manual for the Cryptshare Java API. |
| {{Panel|title=|content=
| |
| }}
| |
|
| |
| == Page Index ==
| |
| -----
| |
| == Space Index ==
| |
|
| |
| ==== Total number of pages: 33 ====
| |
|
| |
| {| class="wikitable"
| |
| |-
| |
| |{| class="wikitable"
| |
| |-
| |
| |[[#index-0-9|0-9]] ... 0
| |
| |[[#index-A|A]] ... 5
| |
| |[[#index-B|B]] ... 0
| |
| |[[#index-C|C]] ... 4
| |
| |[[#index-D|D]] ... 0
| |
| |[[#index-E|E]] ... 2
| |
| |-
| |
| |[[#index-F|F]] ... 1
| |
| |[[#index-G|G]] ... 2
| |
| |[[#index-H|H]] ... 0
| |
| |[[#index-I|I]] ... 1
| |
| |[[#index-J|J]] ... 1
| |
| |[[#index-K|K]] ... 0
| |
| |-
| |
| |[[#index-L|L]] ... 2
| |
| |[[#index-M|M]] ... 1
| |
| |[[#index-N|N]] ... 0
| |
| |[[#index-O|O]] ... 0
| |
| |[[#index-P|P]] ... 4
| |
| |[[#index-Q|Q]] ... 1
| |
| |-
| |
| |[[#index-R|R]] ... 1
| |
| |[[#index-S|S]] ... 2
| |
| |[[#index-T|T]] ... 2
| |
| |[[#index-U|U]] ... 1
| |
| |[[#index-V|V]] ... 2
| |
| |[[#index-W|W]] ... 1
| |
| |-
| |
| |[[#index-X|X]] ... 0
| |
| |[[#index-Y|Y]] ... 0
| |
| |[[#index-Z|Z]] ... 0
| |
| |[[#index-%21@%23%24|!@#$]] ... 0
| |
| |
| |
| |
| |
| |}
| |
| |-
| |
| |==== 0-9 ====
| |
|
| |
| |==== A ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/About+API+Functions About API Functions]
| |
|
| |
| This section describes what methods the Cryptshare Java API provides, and how to use them to perform the desired operations. All methods are provided by the API's Client object, so in order to use any of the API's functionality, you will need to first cre
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/About+Verifications About Verifications]
| |
|
| |
| Verification Modes Most of the services offered by the Cryptshare Server require a form of verification, before they can be used. The Cryptshare Server supports two types of verification: Sender Verification and Client Verification. If the Cryptshare Serv
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Activate+QUICK+access Activate QUICK access]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen If you want to learn more about the QUICK activation process, please head over to the article Activation of QUICK. When attempting to perform a QUICK transfer, it's important to make sure that no QUIC
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/API+Functions API Functions]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen Contents in this chapter @self Footer
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/API+Java+Doc API Java Doc]
| |
|
| |
| <iframe height="700px" width="100%" src="https://wiki.cryptshare.com/java-api/v5/javadoc/"></iframe> Footer
| |
| |-
| |
| |==== B ====
| |
|
| |
| |==== C ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Client+Verification Client Verification]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen If the Verification mode is set to Client Verification, any sender email address can be used to perform a transfer operation, without having to perform a verification process, as described under Sende
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Commissioning Commissioning]
| |
|
| |
| Contents in this chapter @self Footer
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Compatibility Compatibility]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen On this page you will find an overview with which Cryptshare Server versions the Cryptshare Java API is compatible to. Cryptshare Server Version Java API V3 Java API V5 Support until 1.2.2022 Latest v
| |
|
| |
| Page: [https://wiki.cryptshare.com/pages/viewpage.action?pageId=21235494 Cryptshare Server & Java Version]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen Compatible Java Runtime Environment The Cryptshare Java API requires Java Runtime Environment 1.8 or higher. When using java Runtime Environment 9 or higher, please note this article: Java 9+ support
| |
| |-
| |
| |==== D ====
| |
|
| |
| |==== E ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Email+Notifications Email Notifications]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen Disabling email notifications on server-side Usually the Cryptshare Server manages all email communication between the participants of a transfer. However, when developing an own client application fo
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Example+Project Example Project]
| |
|
| |
| General This page contains a simple Maven Java Project showing how the Java API for Cryptshare can be used. Please note, that the Maven setup is configured to use the API version 5.0.1. Make sure you have the corresponding API version installed in the use
| |
| |-
| |
| |==== F ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/File+Transfer File Transfer]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen General You can perform both synchronous, as well as asynchronous Cryptshare file transfers using the API. A transfer can contain one or more files that will be encrypted, uploaded to the Cryptshare S
| |
|
| |
| |==== G ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/General+Notes General Notes]
| |
|
| |
| Contents in this chapter @self Footer
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/General+Server+Data General Server Data]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen With the Client's method requestServerData() you can request general server data from the Cryptshare Server. The method returns a ServerData object which contains the official base URL of the Cryptsha
| |
| |-
| |
| |==== H ====
| |
|
| |
| |==== I ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Importing+into+Maven+Repository Importing into Maven Repository]
| |
|
| |
| If you would wish to import the jar file into your own remote repository (Nexus, Artifactory etc) please refer to the following information: https://maven.apache.org/guides/mini/guide-3rd-party-jars-remote.html https://maven.apache.org/guides/mini/guide-3
| |
| |-
| |
| |==== J ====
| |
| Page: [https://wiki.cryptshare.com/pages/viewpage.action?pageId=65669222 Java 9+ support]
| |
|
| |
| The Cryptshare Java API version 5.0.1 supports all Java runtime environments version 8 and higher. Due to structural changes to the runtime environments as of version 9, the following error message may occur: Exception in thread "main" java.lang.NoClassDe
| |
|
| |
| |==== K ====
| |
| |-
| |
| |==== L ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Language+Resources Language Resources]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen The Cryptshare Server can provide the Client with the language resources contained in the Language Packages that have been installed on the server. These Language Packages can then be used for a user
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/License+Information License Information]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen The license information of the current Cryptshare Server installation and the Add-On Product's own license information can be queried from the server using the Client's requestLicenseInfo() method. Th
| |
|
| |
| |==== M ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Migration+from+Java+API+v3+to+v5.0 Migration from Java API v3 to v5.0]
| |
|
| |
| Introduction In this article, you will learn how to migrate an existing project that uses the Cryptshare Java API version 3 to the latest version of the Cryptshare Java API. This article is a technical article that lists the changes for people who are fam
| |
| |-
| |
| |==== N ====
| |
|
| |
| |==== O ====
| |
| |-
| |
| |==== P ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Password+Functions Password Functions]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen When doing a Cryptshare Transfer, you can specify a password that will be required to access the transferred files. However, this password needs to fulfill the requirements of the Password Policy set
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Perform+a+QUICK+transfer Perform a QUICK transfer]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen Introduction For general information about how QUICK Technology works and in order to get a better understanding of the terminology in use, please take a look at the article Introduction to QUICK. In
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Policy+Rules Policy Rules]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen Cryptshare uses Policy Settings that can be defined on the server side to allow or deny usage of the system to certain senders and recipients and to control the transfer options pertaining to specific
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Provide+your+own+Client+Store Provide your own Client Store]
| |
|
| |
| Introduction There may be situations in which you don't want your application to write a "client.store" file containing the verification states to disk. To support this scenario, we offer several ways store the verification states in a secure manner. Belo
| |
|
| |
| |==== Q ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Quick+Start+Guide Quick Start Guide]
| |
|
| |
| Overview In this article, you will learn how to get started with the Cryptshare JavaAPI. We will cover all important areas in order to have a working development environment with the Java API ready to use. We will also perform our first transfer and build
| |
| |-
| |
| |==== R ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Revoke+a+Transfer Revoke a Transfer]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen The transfer may be revoked if e.g. access to previously provided and outdated information needs to be prohibited for all recipients. Usage It is possible for the sender to revoke their transfer and n
| |
|
| |
| |==== S ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Sender+Verification Sender Verification]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen With Sender Verification mode, a verification has to be performed for each sender email address that is used. This makes sure that the sender address that is being used for a transfer through the API
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/System+Requirements System Requirements]
| |
|
| |
| Contents in this chapter @self Footer
| |
| |-
| |
| |==== T ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Terms+of+Use Terms of Use]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen The Terms of Use that are defined under the Legal tab on the Cryptshare Server administration website can be downloaded by the Client, so that they can be presented to a user in a client side applicat
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Transfer+Polling Transfer Polling]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen Transfer Polling You can use the Java API Client's method requestActiveTransfers() to obtain a list of all active transfers that have been sent to the client's email address. With this request you rec
| |
|
| |
| |==== U ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Update Update]
| |
|
| |
| Contents in this chapter @self Footer
| |
| |-
| |
| |==== V ====
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/v5.0.1 v5.0.1]
| |
|
| |
| New Features Verification Storage The verification store behavior has been improved. Please note the breaking changes regarding the verification store below. When given a path to the verification store, the Client instance uses a default IStore implementa
| |
|
| |
| Page: [https://wiki.cryptshare.com/display/CSJM/Verification Verification]
| |
|
| |
| Bitte die Verlinkung des Sprachbuttons nicht vergessen Contents in this chapter @self Footer
| |
|
| |
| |==== W ====
| |
| Home page: [https://wiki.cryptshare.com/display/CSJM/Welcome Welcome]
| |
|
| |
| Cryptshare Java API Manual This is the homepage of the English manual for the Cryptshare Java API. @self Page Index Footer
| |
| |-
| |
| |==== X ====
| |
|
| |
| |==== Y ====
| |
| |-
| |
| |==== Z ====
| |
|
| |
| |==== !@#$ ====
| |
| |}
| |
|
| |
| -----
| |