Version 2.1 by msp on 2012/04/23 14:07

Show last authors
1 (% style="" %)
2 This section shows the options which are available for configuring the server of KWebS. The identifier of an option is followed by a default value, if it exists, and a description of valid assignments.
3
4 (% style="" %)
5 * **de.cau.cs.kieler.kwebs.jaxws.publishHttp**
6 ** Default value: **true**
7 ** Valid assignments: **true**, **false**
8 ** With this option you can define whether the service variant SOAP over HTTP is being published by the server.
9 * **de.cau.cs.kieler.kwebs.jaxws.httpAddress**
10 ** Default value: (% class="nolink" %)**http:~/~/localhost:8442/layout**
11 ** Valid assignments: An URL defining HTTP as protocol
12 ** With this option you define the address, port and context of the endpoint the server publishes the SOAP over HTTP service variant on.
13 * **de.cau.cs.kieler.kwebs.jaxws.publishHttps**
14 ** Default value: **true**
15 ** Valid assignments: **true**, **false**
16 ** With this option you can define whether the service variant SOAP over HTTPS is being published by the server.
17 * **de.cau.cs.kieler.kwebs.jaxws.httpsAddress**
18 ** Default value: (% class="nolink" %)**http:~/~/localhost:8443/layout**
19 ** Valid assignments: An URL defining HTTPS as protocol
20 ** With this option you define the address, port and context of the endpoint the server publishes the SOAP over HTTPS service variant on.
21 * **de.cau.cs.kieler.kwebs.httpsKeystore.jks.path**
22 ** Default value: **server/kwebs/security/keystores/server.jks**
23 ** Valid assignments: A string defining a path
24 ** With this option you define the path to the java key store containing the certificate that the server uses to secure the HTTPS based variant of the SOAP service. The server plug in ({{code language="none"}}de.cau.cs.kieler.kwebs.server{{/code}}) contains a default key store with a self signed certificate. For the operation in a production environment that requires the exchange of confidential models, this certificate should be replaced by a certificate that has been signed by a globally trusted CA.
25 * **de.cau.cs.kieler.kwebs.httpsKeystore.jks.pass**
26 ** Default value: **server**
27 ** Valid assignments: A string defining the password
28 ** With this option you define the password which the server requires to access the key store necessary for securing the HTTPS based SOAP service variant.
29 * **de.cau.cs.kieler.kwebs.publishJeti**
30 ** Default value: **true**
31 ** Valid assignments: **true**, **false**
32 ** With this option you can define whether the jETI variant of the service is being published by the server.
33 * **de.cau.cs.kieler.kwebs.jeti.provider.id**
34 ** Default value: **KIELERLAYOUT**
35 ** Valid assignments: A string defining the provider id
36 ** The server internally uses a lightweight version of the jETI tool server. With this option you can define his unique identifier.
37 * **de.cau.cs.kieler.kwebs.jeti.sessions.timeout**
38 ** Default value: **300000**
39 ** Valid assignments: An integer
40 ** With this option you define the maximum time in milliseconds a jETI session may be inactive. After it's expiration the tool server dismisses an inactive session.
41 * **de.cau.cs.kieler.kwebs.jeti.sessions.checkinterval**
42 ** Default value: **30000**
43 ** Valid assignments: An integer
44 ** With this option you define the interval in milliseconds, the jETI tool server checks for inactive sessions.
45 * **de.cau.cs.kieler.kwebs.jeti.debug**
46 ** Default value: **false**
47 ** Valid assignments: **true**, **false**
48 ** With this option you define, wheter the internally used jETI tool server runs in debug mode or not.
49 * **de.cau.cs.kieler.kwebs.jeti.toolxml**
50 ** Default value: **server/jeti/config/tools/tools.xml**
51 ** Valid assignments: A string defining a path
52 ** With this option you can define the path to the tool descriptor which is required by the internally used jETI tool server. Usage of this option is not advised, since there exists a strong coupling between the tool descriptor and the implementing tool class.
53 * **de.cau.cs.kieler.kwebs.jeti.server.hostname**
54 ** Default value: **localhost**
55 ** Valid assignments: A string
56 ** This option defines the address, under which the server publishes the jETI service variant. It may declare an IP address or a concrete host name.
57 * **de.cau.cs.kieler.kwebs.jeti.connector.sepp.port**
58 ** Default value: **9867**
59 ** Valid assignments: An integer
60 ** This option defines the port, under which the server publishes the jETI service variant.
61 * **de.cau.cs.kieler.kwebs.jeti.sessions.folder**
62 ** Default value: **server/jeti/sessions**
63 ** Valid assignments: A string defining a path
64 ** This option defines the root path, in which the internally used jETI tool server places and manages the temporary session folders.
65 * **de.cau.cs.kieler.kwebs.jeti.log4j.config**
66 ** Default value: **server/jeti/config/log4j/log4j.properties**
67 ** Valid assignments: A string defining a path
68 ** This option defines the path to the file containing the configuration for \emph{Log4J, the logger internally used by jETI.
69 * **de.cau.cs.kieler.kwebs.jeti.logpath**
70 ** Default value: **server/jeti/logs/jeti.log**
71 ** Valid assignments: A string defining a path
72 ** This option defines the path to the log file the jETI tool server uses.
73 * **de.cau.cs.kieler.kwebs.server.poolsize**
74 ** Default value: **10**
75 ** Valid assignments: An integer
76 ** This option defines the maximum number of requests, the server is executing concurrently.
77 * **de.cau.cs.kieler.kwebs.server.backlog**
78 ** Default value: **75**
79 ** Valid assignments: An integer
80 ** This option defines the maximum number of requests the server caches before he rejects further incoming requests.
81 * **de.cau.cs.kieler.kwebs.log.path**
82 ** Default value: **server/kwebs/logs/kwebs.log**
83 ** Valid assignments: A string defining a path
84 ** This option defines the path to the log file the server uses.
85 * **de.cau.cs.kieler.kwebs.log.size**
86 ** Default value: **1**
87 ** Valid assignments: An integer
88 ** This option defines the maximum size of the log file in megabytes the server uses.
89 * **de.cau.cs.kieler.kwebs.graphviz.path**
90 ** Default value: none
91 ** Valid assignments: A string defining a path
92 ** This option defines the path to the dot// executable of the graphviz package.//
93 * **de.cau.cs.kieler.kwebs.graphviz.timeout**
94 ** Default value: **60000**
95 ** Valid assignments: An integer
96 ** This option defines the timeout for graphviz-based layout in milliseconds.
97 * **de.cau.cs.kieler.kwebs.ogdf.timeout**
98 ** Default value: **60000**
99 ** Valid assignments: An integer
100 ** This option defines the timeout for OGDF-based layout in milliseconds.
101 * **de.cau.cs.kieler.kwebs.supportServerAddress**
102 ** Default value: (% class="nolink" %)**http:~/~/localhost:8444**
103 ** Valid assignments: An URL defining HTTP as protocol
104 ** With this option you define the address and port of the endpoint, the server publishes the support server on.
105 * **de.cau.cs.kieler.kwebs.publishSupportServer**
106 ** Default value: **true**
107 ** Valid assignments: **true**, **false**
108 ** This option defines, whether the support server is being published.
109 * **de.cau.cs.kieler.kwebs.management.port**
110 ** Default value: **23456**
111 ** Valid assignments: An integer
112 ** This option defines the port, under which the management service of the server is reachable.
113 * **de.cau.cs.kieler.kwebs.graphs.maxnumber**
114 ** Default value: **5**
115 ** Valid assignments: An integer
116 ** The service is capable of doing the layout on a set of graphs that a user transmits in a single request. This option defines the maximum number of graphs a user may transmit in a single request. If a request contains more than the allowed number of graphs the service aborts processing the request and throws a RemoteServiceException.
117 * **de.cau.cs.kieler.kwebs.graphs.maxelements**
118 ** Default value: **5000**
119 ** Valid assignments: An integer
120 ** This option defines the maximum number of elements each transmitted graph may contain. If at least a single graph exceeds the maximum number of elements the service aborts processing the request and throws a RemoteServiceException.
121 * **de.cau.cs.kieler.kwebs.graphs.maxnumber.test**
122 ** Default value: **true**
123 ** Valid assignments: **true**, **false**
124 ** This option defines whether the service shall test the number of graphs contained in a request against the maximum number of graphs allowed in a single request.
125 * **de.cau.cs.kieler.kwebs.graphs.maxelements.test**
126 ** Default value: **true**
127 ** Valid assignments: **true**, **false**
128 ** This option defines whether the service shall test the graphs contained in a request against the maximum number of elements allowed for a single graph.