uCosminexus Application Server, Web Service Development Guide

[Contents][Glossary][Index][Back][Next]

10.1.2 Settings for the common definition file

Use the common definition file to set up the action definition common to the system. This subsection describes the file name, storage directory name, and settings for the common definition file.

Organization of this subsection
(1) File name
(2) Storage destination directory
(3) Settings
(4) Changing settings

(1) File name

The following is the file name for the common definition file:

cjwconf.properties

(2) Storage destination directory

The following is the storage destination directory for the common definition file. The storage destination directory is fixed.

Cosminexus-installation-directory\jaxws\conf

(3) Settings

The following table lists the key names to be set up and the specified contents:

Table 10-1 Settings for the common definition file

No. Settings Key name Specified contents Default value Context
1 Log output level of operation log com.cosminexus.jaxws.logger.runtime.message.level Specifies the log output level of operation log.
Specify ERROR, WARN, INFO, DEBUG, or NONE. For the output contents corresponding to each specified value, see 39.3.4 Importance level and output conditions of log.
INFO --
2 Number of operation log files com.cosminexus.jaxws.logger.runtime.message.file_num Specifies the number of operation log files.
Specify a number (1 to 16).
2 --
3 Operation file size com.cosminexus.jaxws.logger.runtime.message.file_size Specifies the operation file size.
Specify a number from 4096 to 16777216 (unit: bytes).
2097152 --
4 Output of maintenance log com.cosminexus.jaxws.logger.runtime.maintenance.level Specifies whether to output the maintenance log.

If ALL is specified
The maintenance log is output.

If NONE is specified
The maintenance log is not output.
ALL --
5 Number of maintenance log files com.cosminexus.jaxws.logger.runtime.maintenance.file_num Specifies the number of maintenance log files.
Specify a number from 1 to 16.
2 --
6 Maintenance log capacity com.cosminexus.jaxws.logger.runtime.maintenance.file_size Specifies the maintenance log capacity.
Specify a number from 4096 to 16777216 (unit: bytes).
16777216 --
7 Log output level of exception log com.cosminexus.jaxws.logger.runtime.exception.level Specifies the log output level of exception log. Specify ERROR, WARN, INFO, DEBUG, or NONE. For the output contents corresponding to each specified value, see 39.3.4 Importance level and output conditions of log. INFO --
8 Number of exception log files com.cosminexus.jaxws.logger.runtime.exception.file_num Specifies the number of exception log files. Specify a number from 1 to 16. 2 --
9 Exception log capacity com.cosminexus.jaxws.logger.runtime.exception.file_size Specifies the exception log capacity. Specify a number from 4096 to 16777216 (unit: bytes). 16777216 --
10 Output level of communication log
(In the Web Services client)
com.cosminexus.jaxws.logger.runtime.transport.client_dump Specifies the output level of the communication log in the Web Services client.

If NONE is specified
The communication log is not output in the Web Service client.

If ALL is specified
The messages sent and received with the Web Service client are always output in the communication log.

If HEADER is specified
The HTTP header of the messages received with the Web Service client is always output in the communication log.

If ERROR_HEADER is specified
The HTTP header of the message received when SOAPFault is received is output in the communication log.

Notes
When ALL is specified, java.lang.OutOfMemoryError exception might occur depending on the length of the sent and received message. In such a case, adjust the JVM heap size.
ERROR_HEADER --
11 Output level of communication log
(In Web Services)
com.cosminexus.jaxws.logger.runtime.transport.server_dump Specifies the output level of the communication log in Web Services.

If NONE is specified
The communication log is not output in the Web Service.

If ALL is specified
The messages sent and received in the Web Service are always output in the communication log.

If HEADER is specified
The HTTP header of the messages received in the Web Service is always output in the communication log.

ERROR_HEADER
The HTTP header of the message received when SOAPFault is sent is output in the communication log.
Note that when a received message is output, the HTTP request information is also output.

Notes
When ALL is specified, java.lang.OutOfMemoryError exception might occur depending on the length of the sent and received message. In such a case, adjust the JavaVM heap size.
ERROR_HEADER --
12 Number of communication log files com.cosminexus.jaxws.logger.runtime.transport.file_num Specifies the number of communication log files. Specify a number from 1 to 16. 2 --
13 Communication log capacity com.cosminexus.jaxws.logger.runtime.transport.file_size Specifies the communication log capacity. Specify a number from 4096 to 16777216 (unit: bytes). 16777216 --
14 Character encoding for communication logs com.cosminexus.jaxws.logger.runtime.transport.encoding Specifies the character encoding for communication logs. For the character encoding supported by J2SE 6.0, see the J2SE 6.0 documentation.
If you specify DEFAULT, the character encoding for the communication logs changes to the default platform encoding.
DEFAULT --
15 Log output level of operation log (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.message.level Specifies the log output level of operation log for the cjwsimport command. Specify ERROR, WARN, INFO, DEBUG, or NONE. For the output contents corresponding to each specified value, see 39.3.4Importance level and output conditions of log. INFO --
16 Number of operation log files (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.message.file_num Specifies the number of operation log files for the cjwsimport command. Specify a number from 1 to 16. 2 --
17 Operation file size (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.message.file_size Specifies the operation file size for the cjwsimport command. Specify a number from 4096 to 16777216 (unit: bytes). 2097152 --
18 Log output level of exception log (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.exception.level Specifies the log output level of exception log for the cjwsimport command. Specify ERROR, WARN, INFO, DEBUG, or NONE. For the output contents corresponding to each specified value, see 39.3.4 Importance level and output conditions of log. INFO --
19 Number of exception log files (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.exception.file_num Specifies the number of exception log files for the cjwsimport command. Specify a number from 1 to 16. 2 --
20 Exception log capacity (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.exception.file_size Specifies the exception log capacity for the cjwsimport command. Specify a number from 4096 to 16777216 (unit: bytes). 16777216 --
21 Output of maintenance log (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.maintenance.level Specifies whether to output the maintenance log for the cjwsimport command.

If ALL is specified
The maintenance log is output.

If NONE is specified
The maintenance log is not output.
ALL --
22 Number of maintenance log files (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.maintenance.file_num Specifies the number of maintenance log files for the cjwsimport command. Specify a number from 1 to 16. 2 --
23 Maintenance log capacity (cjwsimport) com.cosminexus.jaxws.logger.cjwsimport.maintenance.file_size Specifies the maintenance log capacity for the cjwsimport command. Specify a number from 4096 to 16777216 (unit: bytes). 16777216 --
24 Log output level of operation log (apt) com.cosminexus.jaxws.logger.apt.message.level Specifies the log output level of operation log for the apt command. Specify ERROR, WARN, INFO, DEBUG, or NONE. For the output contents corresponding to each specified value, see 39.3.4Importance level and output conditions of log. INFO --
25 Number of operation log files (apt) com.cosminexus.jaxws.logger.apt.message.file_num Specifies the number of operation log files for the apt command. Specify a number from 1 to 16. 2 --
26 Operation file size (apt) com.cosminexus.jaxws.logger.apt.message.file_size Specifies the operation file size for the apt command. Specify a number from 4096 to 16777216 (unit: bytes). 2097152 --
27 Log output level of exception log (apt) com.cosminexus.jaxws.logger.apt.exception.level Specifies the log output level of exception log for the apt command. Specify ERROR, WARN, INFO, DEBUG, or NONE. For the output contents corresponding to each specified value, see 39.3.4Importance level and output conditions of log. INFO --
28 Number of exception log files (apt) com.cosminexus.jaxws.logger.apt.exception.file_num Specifies the number of exception log files for the apt command. Specify a number from 1 to 16. 2 --
29 Exception log capacity (apt) com.cosminexus.jaxws.logger.apt.exception.file_size Specifies the exception log capacity for the apt command. Specify a number from 4096 to 16777216 (unit: bytes). 16777216 --
30 Output of maintenance log (apt) com.cosminexus.jaxws.logger.apt.maintenance.level Specifies whether to output the maintenance log for the apt command.

If ALL is specified
The maintenance log is output.

If NONE is specified
The maintenance log is not output.
ALL --
31 Number of maintenance log files (apt) com.cosminexus.jaxws.logger.apt.maintenance.file_num Specifies the number of maintenance log files for the apt command. Specify a number from 1 to 16. 2 --
32 Maintenance log capacity (apt) com.cosminexus.jaxws.logger.apt.maintenance.file_size Specifies the maintenance log capacity for the apt command. Specify a number from 4096 to 16777216 (unit: bytes). 16777216 --
33 Operation option when SOAPAction is absent com.cosminexus.jaxws.fault_omit_soapaction Specifies the operation option when SOAPAction is absent.

If true is specified
If SOAPAction header is absent, returns the SOAP Fault message.

If false is specified
If SOAPAction header is absent, operates the value of SOAPAction header as a null character.
true --
34 Connection timeout value of the client socket com.cosminexus.jaxws.connect.timeout Specifies the connection timeout value of the client socket.
The timeout value specified in this property is applied when the Web Service is invoked and during Meta data (WSDL) acquisition that occurs in the generation of the javax.xml.ws.Service class before the Web Service is invoked.
Specify a number from 0 to 2147483647 (unit: milliseconds). If 0 is specified, a timeout does not occur.
If you change the settings related to the TCP connection of the OS, the values of OS settings will be given the priority.
60000 Y#
35 Read timeout value of client socket com.cosminexus.jaxws.request.timeout Specifies the read timeout value for the client socket.
The timeout value specified in this property is applied when the Web Service is invoked and during Meta data (WSDL) acquisition that occurs in the generation of the javax.xml.ws.Service class before the Web Service is invoked.
Specify a number from 0 to 2147483647 (unit: milliseconds). If 0 is specified, a timeout does not occur.
If you change the settings related to the TCP connection of the OS, the values of OS settings will be given the priority.
300000 Y#
36 User ID for basic authentication javax.xml.ws.security.auth.username Specifies the user ID for basic authentication used in HTTP connection.
The user ID specified in this property is applied when the Web Service is invoked and during Meta data (WSDL) acquisition that occurs in the generation of the javax.xml.ws.Service class before the Web Service is invoked.
Nill Y#
37 Password for basic authentication javax.xml.ws.security.auth.password Specifies the password for basic authentication used in HTTP connection.
The password specified in this property is applied when the Web Service is invoked and during Meta data (WSDL) acquisition that occurs in the generation of the javax.xml.ws.Service class before the Web Service is invoked.
If javax.xml.ws.security.auth.username is not specified, password is not enabled.
Nil Y#
38 Presence or absence of HTTP session maintenance javax.xml.ws.session.maintain Specifies the presence or absence of HTTP session maintenance. An HTTP session is maintained until the same port object is used.

If true
The session is maintained.

If false
The session is not maintained.
false Y#
39 Strict validation of handler chain setup file com.cosminexus.jaxws.validation.handlerchain.strict Specifies whether to validate the handler chain setup file strictly. If javaee:handler-name element is not coded as the child element of the javaee:handler element in the handler chain setup file, an error occurs. false --
40 Issuing of WSDL for HTTP request com.cosminexus.jaxws.security.publish_wsdl Specifies whether to issue WSDL for the Web Service where the HTTP GET request with a query string ?wsdl or ?WSDL is sent to the Web Service URL.

If true is specified
WSDL is issued.

If false is specified
WSDL is not issued and 405 Method Not Allowed is returned.
true --
41 Displaying Web Service information for HTTP request com.cosminexus.jaxws.security.display_webservice_info Specifies whether to display the Web Service information as the response when an HTTP request by GET arrives for the Web Service.

If true is specified
The Web Service information corresponding to the request URL is displayed.

If false is specified
405 Method Not Allowed is returned.
false --
42 Propagation of Java exception occurring in the Web Service com.cosminexus.jaxws.fault.SOAPFaultBuilder.captureStackTrace Specifies whether to propagate the Java exception occurring in the Web Service to the Web Service client.

If true is specified
The exception is propagated.

If false is specified
The exception is not propagated.
false --
43 Log output destination directory com.cosminexus.jaxws.tool.log.directory Specifies the log output destination directory output by the cjwsimport command, apt command, and cjwsgen command. Cosminexus-installation-directory/jaxws/logs --
44 Authenticated user ID of the proxy server com.cosminexus.jaxws.http.proxyUser Specifies an authenticated user ID of the proxy server. As and when required, specify the user ID when the Web Service client invokes Web Services in an external network using the proxy server.
The user ID that you specify in this property is applied during the invocation of Web Services and during the acquisition of Meta data (WSDL) that is created while generating the javax.xml.ws.Service class before the invocation of the Web Services.
None --
45 Password corresponding to the authenticated user ID of the proxy server com.cosminexus.jaxws.http.proxyPassword Specifies a password corresponding to the authenticated user ID of the proxy server. As and when required, specify this password when the Web Service client invokes Web Services in an external network using the proxy server.
The password that you specify in this property is applied during the invocation of Web Services and during the acquisition of Meta data (WSDL) that is created while generating the javax.xml.ws.Service class before the invocation of the Web Services.
None --
46 Authenticated user ID of the proxy server used for establishing a connection through the SSL protocol com.cosminexus.jaxws.https.proxyUser Specifies an authenticated user ID of the proxy server used when establishing a connection through the SSL protocol. As and when required, specify this user ID during the establishment of a connection through the SSL protocol, when the Web Service client invokes Web Services in an external network using the proxy server.
The user ID that you specify in this property is applied during the invocation of Web Services and during the acquisition of Meta data (WSDL) that is created while generating the javax.xml.ws.Service class before the invocation of the Web Services.
None --
47 Password corresponding to the authenticated user ID of the proxy server used for establishing a connection through the SSL protocol com.cosminexus.jaxws.https.proxyPassword Specifies a password corresponding to the authenticated user ID of the proxy server used when establishing a connection through the SSL protocol. As and when required, specify this password during the establishment of a connection through the SSL protocol, when the Web Service client invokes Web Services in an external network using the proxy server. The user ID that you specify in this property is applied during the invocation of the Web Services and during the acquisition of Meta data (WSDL) that is created while generating the javax.xml.ws.Service class before the invocation of the Web Services. None --
48 Log output level of operation logs (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.message.level Specifies the log output level of operation logs for the cjwsgen command. Specify ERROR, WARN, INFO, DEBUG, or NONE. For the output contents corresponding to each specified value, see 39.3.4 Importance level and output conditions of log. INFO --
49 Number of operation log files (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.message.file_num Specifies the number of operation log files for the cjwsgen command. Specify a number from 1 to 16. 2 --
50 Operation file size (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.message.file_size Specifies the operation file size for the cjwsgen command. Specify a number from 4096 to 16777216 (unit: bytes). 2097152 --
51 Log output level of exception logs (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.exception.level Specifies the log output level of exception logs for the cjwsgen command. Specify ERROR, WARN, INFO, DEBUG, or NONE. For the output contents corresponding to each specified value, see 39.3.4 Importance level and output conditions of log. INFO --
52 Number of exception log files (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.exception.file_num Specifies the number of exception log files for the cjwsgen command. Specify a number from 1 to 16. 2 --
53 Exception log capacity (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.exception.file_size Specifies the exception log capacity for the cjwsgen command. Specify a number from 4096 to 16777216 (unit: bytes). 16777216 --
54 Output of maintenance logs (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.maintenance.level Specifies whether to output maintenance logs for the cjwsgen command.

If you specify ALL
The maintenance log is output.

If you specify NONE
The maintenance log is not output.
ALL --
55 Number of maintenance log files (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.maintenance.file_num Specifies the number of maintenance log files for the cjwsgen command. Specify a number from 1 to 16. 2 --
56 Maintenance log capacity (cjwsgen) com.cosminexus.jaxws.logger.cjwsgen.maintenance.file_size Specifies the maintenance log capacity for the cjwsgen command. Specify a number from 4096 to 16777216 (unit: bytes). 16777216 --
57 Specify transport attribute of the soap12:binding element com.cosminexus.jaxws.publish_wsdl.soap12binding For SOAP1.2 specify whether to set http://schemas.xmlsoap.org/soap/http in transport attribute of soap12:binding element that is a child element of wsdl:binding element in the WSDL issued by using HTTP GET request. The query string of the HTTP GET request must be ?wsdl or ?WSDL.

DEFAULT
Set "http://www.w3.org/2003/05/ssoa/bindings/HTTP/" in the soap12:binding/@transport attribute value.

WSI_BP20_TRANSPORT
Set "http://schemas.xmlsoap.org/ssoa/http" in the soap12:binding/@transport attribute value.
DEFAULT --
58 Application of the validation of the host name in an SSL connection com.cosminexus.xml.ws.client.http.HostnameVerificationProperty Specifies whether to omit the following validation when a Web service client connects according to the SSL protocol.

Validation content: Whether the host name to be included in the end point address matches with the host name given in the certificate.

true
Omit validation.

false
Do not omit validation.
Validation of the host name in the SSL is applied when calling the Web Service, and when acquiring the meta data (WSDL) generated when creating the javax.xml.ws.Service class before calling the Web Service.
false Y#

Legend:
Y: Indicates that this item can be set as a message context.
--: Indicates that this item cannot be set as a message context.

#
The specification to message context is enabled only when the Web Service is invoked and is not applied during Meta data (WSDL) acquisition that occurs in the generation of the javax.xml.ws.Service class before the Web Service is invoked.
To set up the basic authentication information during Meta data acquisition, or the requirement for validation of the host name in an SSL connection, either code in the common definition file or the process-wise definition file or separately download WSDL on the local machine and use it (when using the WSDL that exists on the local machine, connection with the remote machine does not occur while acquiring the meta data). If WSDL imported separately from WSDL exists, download the imported WSDL on the local machine.
Also, when setting true or false in the property by using the message context, set with a string having a java.lang.String type. The operation is not guaranteed if you set true or false by using a string other than the java.lang.String type. For details, see 19.2.5 (2)(k) How to set the com.cosminexus.xml.ws.client.http.HostnameVerificationProperty property.

(4) Changing settings

Changing settings at the Web Service machine
Stop all the J2EE servers that are not using a process-wise definition file, and then change the settings of the common definition file. For the process-wise definition files, see the section 10.1.3 Settings for the process-wise definition file.
For changing log-related settings, save a log as and when required, and then change the settings.

Changing settings at the Web Service client machine
Stop all the J2EE servers (when assuming a J2EE application as a Web Service client) or all the Java applications, and then change the settings of the common definition file.
For changing log-related settings, save a log as and when required, and then change the settings.