Project

General

Profile

User Guide » History » Version 7

Tobias Wich, 03/18/2013 04:41 PM

1 2 Tobias Wich
h1. About the Open eCard App
2
3
h2. Features
4
5
h2. Changelog
6
7
8
h1. Setup
9
10
h2. Richclient
11
12 5 Tobias Wich
The Richclient is a Java SE application intended to run as a desktop application. It is usually installed on a machine in an operating system specific manner and executed by the user on his own behalf.
13
14
h3. Prerequisites
15
16
* Java SE 6 or higher
17
  Windows and Mac users can get it at https://www.java.com. 
18 7 Tobias Wich
  Debian Squeeze users should install the package @openjdk-6-jre@ and @icedtea6-plugin@, while Wheezy users should install @openjdk-7-jre@ and @icedtea-7-plugin@.
19 5 Tobias Wich
20
h3. Installation
21
22
# Direct your Browser to https://www.openecard.org/download/pc
23
# Click the Open eCard App launch Button
24
25 2 Tobias Wich
h2. Android
26
27
28
h1. Operation
29
30
h2. General
31
32
h2. App Activation
33
34 3 Tobias Wich
h1. Configuration
35 2 Tobias Wich
36 3 Tobias Wich
Each client implementation of the Open eCard App uses a common base set of configuration options and possibly additional client specific settings. The clients provide their own configuration dialogs that are appropriate for the platform or operating system they are running on.
37 1 Detlef Hühnlein
38 3 Tobias Wich
In the rest of this section the settings common to all client implementations are defined and explained. The sections afterwards describe the client specific settings as well as the UIs that provide a more user friendly way to modify these settings.
39 1 Detlef Hühnlein
40
41 3 Tobias Wich
h2. List of Common Settings
42
43 4 Tobias Wich
The Open eCard App loads and saves all its settings to a "Java style property":https://en.wikipedia.org/wiki/.properties file. This file is user specific and can be found under the path @$HOME/.openecard/openecard.properties@. Besides this config file, the $.openecard$ directory may contain other client or plugin specific files, like log settings or log files.
44 3 Tobias Wich
45
46
h3. Proxy Settings
47
48
@proxy.socks.host@
49
50
bq. Hostname or IP address of the server where the SOCKS proxy server is running on.
51
52
@proxy.socks.port@
53
54
bq. Port on the proxy host where the proxy service is listening on.
55
56
57
h2. Richclient Settings
58 2 Tobias Wich
59 1 Detlef Hühnlein
h1. Troubleshooting
60 6 Tobias Wich
61
h2. Logging
62
63
Each client may use a different logging framework. In the applet, Java Util Logging is used to save space of the executable while in the richclient, Logback provides a feature rich logging framework. Both are configured differently.
64
65
The logging configuration can be modified by a config file in the directory $HOME/.openecard (%HOME/.openecard for Microsoft Windows systems). The file must be named applet_log.properties for the applet and richclient_logback.xml for the richclient. Samples can be found at the end of this page.
66
67
After adding the config file, the log granularity of the packages and/ or classes must be configured. The syntax and possibilities of each logging framework are different from each other. The samples include an exemplary line for a package. For further details consult the documentation of the logging framework in use.
68
69
The following is a list of important packages to find errors. A complete list is available in the "JavaDoc":https://dev.openecard.org/projects/open-ecard/apidocs/index.html.
70
* @org.openecard.transport.paos@
71
* @org.openecard.ifd.scio@
72
* @org.openecard.sal@
73
* @org.openecard.sal.protocol.eac@
74 2 Tobias Wich
75
h2. Error Messages
76
77
h2. Reporting Problems