Chapter 23. Configuring jeus-webservices-dd.xml

Table of Contents

23.1. Introduction
23.2. XML Schema/XML Tree
23.3. Element Reference
23.4. Example File

This chapter explains the contents of jeus-webservices-dd.xml, a web service deployment descriptor.

XML references are configured in the following format.

  1. XML Schema/XML Tree: Summarizes all the tags of XML configuration file. Each node is defined in the following format.

    1. Tag reference enables quick search for tags. Each tag is attached with index numbers ( ex: (11) ). Tags are explained with this number in tag reference.

    2. The XML tag name defined in the XML schema is expressed in the format of <tag name>.

    3. Tags are set with cardinality defined in XML schema.

      “?” is for 0 or 1 element, “+” is for 1 or more elements, “*” is for 0 or more elements, (no symbol) is for exactly one element

    4. Several tags have "P" character, meaning that they are the tags related to performance. These tags are used to tune the setting.

  2. Element Reference: Explains XML tags in the tree.

    1. Dynamic: Allowed to change the configuration dynamically.

    2. Non-Dynamic: Not allowed to change the configuration dynamically. This is expressed only for the special case to comment out.

    3. Description: A short description for tags.

    4. Value Description: The value and type.

    5. Value Type: Data type of the value. (ex: String)

    6. Value Type Description: Description for the data type of the value.

    7. Default Value: The value to be used by default when the XML is not used.

    8. Defined Value: The default value.

    9. Example: The XML tag example.

    10. Performance Recommendation: The value recommended to improve performance.

    11. Child Elements:The tags contained in its own tag element.

(1) <jeus-webservices-dd>
Description First item to appear in the JEUS web service configuration document.
Value Type jeus-webservices-ddType
Child Elements

(3) ejb-context-path

(4) ejb-login-config

(7) service-info-page

(8) service

(2) < jeus-webservices-dd > <ejb-context-path>
Description Path to the EJB-based context. This only applies to EJB-based Web services.
Value Type token

(3) < jeus-webservices-dd > <ejb-login-config>
Description Indicates which authentication scheme to use and the authentication scope when using an EJB-based Web service.
Value Type ejb-login-configType
Child Elements

(5) auth-method

(6) realm-name

(4) < jeus-webservices-dd >< ejb-login-config > <auth-method>
Description Authentication mode. Choose among BASIC, CLIENT-CERT, DIGEST, or FORM.
Value Type string

(5) < jeus-webservices-dd >< ejb-login-config > <realm-name>
Description Domain where the security policy takes effect.
Value Type string

(6) < jeus-webservices-dd > <service-info-page>
Description Relative path to the context of a customized Web service information page. Use this option to use the customized Web service information page instead of the default Web service information page. The value starts with "/".
Value Type string

(7) < jeus-webservices-dd > <service>
Description Web services that will be deployed.
Value Type serviceType
Child Elements

(9) webservice-description-name

(10) wsdl-publish

(19) port

(8) < jeus-webservices-dd >< service > <webservice-description-name>
Description Web service endpoint name in the WSDL file. This corresponds to <webservice-description-name> in the standard deployment descriptor file webservices.xml.
Value Type string

(9) < jeus-webservices-dd >< service > <wsdl-publish>
Description Indicates how the WSDL file is published.
Value Type wsdl-publishType
Child Elements

(11) http-publish

(15) file-publish

(10) < jeus-webservices-dd >< service >< wsdl-publish > <http-publish>
Description HTTP publishing. The schemas imported from the published WSDL are referenced by their URL.
Value Type http-publishType
Child Elements

(12) server-url

(13) secure-server-url

(14) wsdl-url

(11) < jeus-webservices-dd >< service >< wsdl-publish >< http-publish > <server-url>
Description URL where WSDL files for the deployed web services are published.
Value Type string

(12) < jeus-webservices-dd >< service >< wsdl-publish >< http-publish > <secure-server-url>
Description SSL URL where WSDL files for the deployed web services are published.
Value Type string

(13) < jeus-webservices-dd >< service >< wsdl-publish >< http-publish > <wsdl-url>
Description Additional URL where WSDL files for the deployed web services are published. The format is '/specified_url'. The existing WSDL public URL is configured in the context by default and its format is usually '/{service name}?wsdl'.
Value Type string

(14) < jeus-webservices-dd >< service >< wsdl-publish > <file-publish>
Description File publishing. The schemas imported from the published WSDL are referenced by the relative file path.
Value Type file-publishType
Child Elements

(16) server-url

(17) secure-server-url

(18) publish-path

(15) < jeus-webservices-dd >< service >< wsdl-publish >< file-publish > <server-url>
Description URL where WSDL files for the deployed web services are published.
Value Type string

(16) < jeus-webservices-dd >< service >< wsdl-publish >< file-publish > <secure-server-url>
Description SSL URL where WSDL files for the deployed web services are published.
Value Type string

(17) < jeus-webservices-dd >< service >< wsdl-publish >< file-publish > <publish-path>
Description Directory where web service WSDL files are stored.
Value Type string

(18) < jeus-webservices-dd >< service > <port>
Description Port for the web service.
Value Type portType
Child Elements

(20) port-component-name

(21) ejb-endpoint-url

(22) tie-class

(23) service-property

(26) ejb-transport-guarantee

(27) soapver

(28) security

(86) rm

(88) transaction

(19) < jeus-webservices-dd >< service >< port > <port-component-name>
Description Name that is used to distinguish the web service endpoint. This corresponds to <port-component-name> of the standard deployment descriptor file webservices.xml.
Value Type token

(20) < jeus-webservices-dd >< service >< port > <ejb-endpoint-url>
Description Endpoint URL at which to access the EJB endpoint. This is only used for EJB endpoints.
Value Type string

(21) < jeus-webservices-dd >< service >< port > <tie-class>
Description Class that connects web service endpoint URLs to the web service endpoint interface. This is created automatically during deployment, so the web service deployer does not need to set it.
Value Type string

(22) < jeus-webservices-dd >< service >< port > <service-property>
Description Properties that are applied to a service endpoint port.
Value Type nameValueType
Child Elements

(24) name

(25) value

(23) < jeus-webservices-dd >< service >< port >< service-property > <name>
Description Key name that is used to configure properties for javax.xml.rpc.Stub or javax.xml.rpc.Call.
Value Type string

(24) < jeus-webservices-dd >< service >< port >< service-property > <value>
Description Key value that is used to configure properties for javax.xml.rpc.Stub or javax.xml.rpc.Call.
Value Type string

(25) < jeus-webservices-dd >< service >< port > <ejb-transport-guarantee>
Description Confidentiality and integrity of messages that are sent to and come from the EJB endpoint. NONE, CONFIDENTIAL, or INTEGRAL can be used.
Value Type ejb-transport-guaranteeType
Defined Value

NONE

INTEGRAL

CONFIDENTIAL

(26) < jeus-webservices-dd >< service >< port > <soapver>
Description SOAP message version that is used by deployed web services.
Value Type string

(27) < jeus-webservices-dd >< service >< port > <security>
Description WS-Security.
Value Type securityType
Child Elements

(29) request-receiver

(48) response-sender

(28) < jeus-webservices-dd >< service >< port >< security > <request-receiver>
Description Configuration to handle security message requests of web service clients.
Value Type security-receiverType
Child Elements

(30) action-list

(31) observeActionOrder

(32) password-callback-class

(33) timeStamp

(38) decryption

(43) signature-verification

(29) < jeus-webservices-dd >< service >< port >< security >< request-receiver > <action-list>
Description Security settings for received messages. Timestamp, Encrypt, Signature, and UsernameToken can be used. Separate each item with a space.
Value Type string

(30) < jeus-webservices-dd >< service >< port >< security >< request-receiver > <observeActionOrder>
Description Indicates whether the Action List order of the sender and the Action List order of the receiver should match.
Value Type boolean
Default Value true

(31) < jeus-webservices-dd >< service >< port >< security >< request-receiver > <password-callback-class>
Description Password callback class name. Type the entire package name.
Value Type string

(32) < jeus-webservices-dd >< service >< port >< security >< request-receiver > <timeStamp>
Description TTL (time-to-live) aberration for timestamps.
Value Type timeStampType
Child Elements

(34) timeToLive

(35) aberration

(36) requireSignature

(37) precision

(33) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< timeStamp > <timeToLive>
Description Expiry time of sent messages in seconds.
Value Type positiveInteger

(34) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< timeStamp > <aberration>
Description Difference from UTC in seconds. The default value is 0 seconds.
Value Type integer

(35) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< timeStamp > <requireSignature>
Description Indicates whether to sign the timestamp. The default value is true.
Value Type boolean

(36) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< timeStamp > <precision>
Description Extra time that is allowed for network and processing delays.
Value Type positiveInteger

(37) < jeus-webservices-dd >< service >< port >< security >< request-receiver > <decryption>
Description Setting for decrypting encrypted received messages.
Value Type decryptionType
Child Elements

(39) keystore

(38) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< decryption > <keystore>
Description Keystore for decrypting messages.
Value Type keystoreType
Child Elements

(40) key-type

(41) keystore-password

(42) keystore-filename

(39) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< decryption >< keystore > <key-type>
Description Key type of key that is stored in the keystore. JKS or pkcs12 can be used.
Value Type string

(40) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< decryption >< keystore > <keystore-password>
Description Password to access the keystore. To store the password in an encrypted form, use the format {algorithm}ciphertext. For example, {DES}FQrLbQ/D8O1lDVS71L28rw==
Value Type string

(41) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< decryption >< keystore > <keystore-filename>
Description File name of the keystore. If the file exists in the same directory as the class, enter the file name. If the file exists in a different directory, enter the file name with its absolute path. <!-- 원본 메시지 "파일 이름만 입력할 경우, 클래스 경로에서 찾게 되므로 --> <!-- 파일 이름이나 절대 경로를 포함하는 파일 이름을 입력한다." 가 모호하여 연구소에 문의. 임시로 절대 경로를 포함하는 값을 지칭한다는 내용으로 번역. -->
Value Type string

(42) < jeus-webservices-dd >< service >< port >< security >< request-receiver > <signature-verification>
Description Setting for verifying received message signatures.
Value Type signature-verificationType
Child Elements

(44) keystore

(43) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< signature-verification > <keystore>
Description Keystore for verifying signatures.
Value Type keystoreType
Child Elements

(45) key-type

(46) keystore-password

(47) keystore-filename

(44) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< signature-verification >< keystore > <key-type>
Description Key type of key that is stored in the keystore. JKS or pkcs12 can be used.
Value Type string

(45) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< signature-verification >< keystore > <keystore-password>
Description Password to access the keystore. To store the password in an encrypted form, use the format {algorithm}ciphertext. For example, {DES}FQrLbQ/D8O1lDVS71L28rw==
Value Type string

(46) < jeus-webservices-dd >< service >< port >< security >< request-receiver >< signature-verification >< keystore > <keystore-filename>
Description File name of the keystore. If the file exists in the same directory as the class, enter the file name. If the file exists in a different directory, enter the file name with its absolute path. <!-- 원본 메시지 "파일 이름만 입력할 경우, 클래스 경로에서 찾게 되므로 --> <!-- 파일 이름이나 절대 경로를 포함하는 파일 이름을 입력한다." 가 모호하여 연구소에 문의. 임시로 절대 경로를 포함하는 값을 지칭한다는 내용으로 번역. -->
Value Type string

(47) < jeus-webservices-dd >< service >< port >< security > <response-sender>
Description Configuration for web services to send secured messages as responses after handling SOAP messages.
Value Type security-senderType
Child Elements

(49) action-list

(50) password-callback-class

(51) user

(52) timeStamp

(57) userNameToken

(61) signature-infos

(72) encryption-infos

(48) < jeus-webservices-dd >< service >< port >< security >< response-sender > <action-list>
Description String value that indicates security settings. Timestamp, Encrypt, Signature, and UsernameToken can be used. Separate each element with a space.
Value Type string

(49) < jeus-webservices-dd >< service >< port >< security >< response-sender > <password-callback-class>
Description Full package name of the callback class that sets passwords.
Value Type string

(50) < jeus-webservices-dd >< service >< port >< security >< response-sender > <user>
Description User name, which is used for UsernameToken and as an alias for the signing key.
Value Type string

(51) < jeus-webservices-dd >< service >< port >< security >< response-sender > <timeStamp>
Description TTL (time-to-live) aberration for timestamps.
Value Type timeStampType
Child Elements

(53) timeToLive

(54) aberration

(55) requireSignature

(56) precision

(52) < jeus-webservices-dd >< service >< port >< security >< response-sender >< timeStamp > <timeToLive>
Description Expiry time of sent messages in seconds.
Value Type positiveInteger

(53) < jeus-webservices-dd >< service >< port >< security >< response-sender >< timeStamp > <aberration>
Description Difference from UTC in seconds. The default value is 0 seconds.
Value Type integer

(54) < jeus-webservices-dd >< service >< port >< security >< response-sender >< timeStamp > <requireSignature>
Description Indicates whether to sign the timestamp. The default value is true.
Value Type boolean

(55) < jeus-webservices-dd >< service >< port >< security >< response-sender >< timeStamp > <precision>
Description Extra time that is allowed for network and processing delays.
Value Type positiveInteger

(56) < jeus-webservices-dd >< service >< port >< security >< response-sender > <userNameToken>
Description UsernameToken.
Value Type userNameTokenSenderType
Child Elements

(58) password

(59) passwordType

(60) userTokenElements

(57) < jeus-webservices-dd >< service >< port >< security >< response-sender >< userNameToken > <password>
Description Password. To store it in an encrypted form, use the format {algorithm}ciphertext. For example, {DES}FQrLbQ/D8O1lDVS71L28rw==
Value Type string

(58) < jeus-webservices-dd >< service >< port >< security >< response-sender >< userNameToken > <passwordType>
Description Password type for UsernameToken. PasswordDigest or PasswordText can be used.
Value Type passwordTypeType
Defined Value

PasswordDigest

PasswordText

(59) < jeus-webservices-dd >< service >< port >< security >< response-sender >< userNameToken > <userTokenElements>
Description UList of elements that is added to UsernameToken. Separate each element with a blank space. nonce or created can be used. Use this option if passwordType is PasswordDigest.
Value Type string

(60) < jeus-webservices-dd >< service >< port >< security >< response-sender > <signature-infos>
Description Setting for signing messages.
Value Type signature-infosType
Child Elements

(62) signature-info

(61) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos > <signature-info>
Description Setting for signing messages. Multiple configurations are possible.
Value Type signature-infoType
Child Elements

(63) signatureParts

(64) signatureAlgorithm

(65) messageDigestAlogrithm

(66) canonicalization

(67) keyIdentifier

(68) keystore

(62) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info > <signatureParts>
Description Setting for signing specific parts of messages. The value can take the format "{}{http://schemas.xmlsoap.org/soap/envelope/}Body; Token". The entire SOAP body is signed by default.
Value Type string

(63) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info > <signatureAlgorithm>
Description Signing algorithm. SHA1withRSA, SHA1WithDSA, and HMACSHA1 can be used.
Value Type signatureAlgorithmType
Defined Value

http://www.w3.org/2000/09/xmldsig#dsa-sha1

http://www.w3.org/2000/09/xmldsig#rsa-sha1

http://www.w3.org/2000/09/xmldsig#hmac-sha1

(64) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info > <messageDigestAlogrithm>
Description Algorithm for message digests. Uses SHA1.
Value Type messageDigestAlgorithmType
Defined Value

http://www.w3.org/2000/09/xmldsig#sha1

(65) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info > <canonicalization>
Description Canonicalization type. Exclusive XML Canonicalization omit comments, Exclusive XML Canonicalization with comments, Inclusive XML Canonicalization omit comments, and Inclusive XML Canonicalization with comments can be used.
Value Type canonicalizationType
Defined Value

http://www.w3.org/2001/10/xml-exc-c14n#

http://www.w3.org/2001/10/xml-exc-c14n#WithComments

http://www.w3.org/TR/2001/REC-xml-c14n-20010315

http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments

(66) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info > <keyIdentifier>
Description Information expression type of the signature key. IssuerSerial, DirectReference, SKIKeyIdentifier, and X509KeyIdentifier can be used.
Value Type sigKeyIdentifierType
Defined Value

IssuerSerial

DirectReference

SKIKeyIdentifier

X509KeyIdentifier

(67) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info > <keystore>
Description Keystore for private keys that are used to sign messages.
Value Type keystoreType
Child Elements

(69) key-type

(70) keystore-password

(71) keystore-filename

(68) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info >< keystore > <key-type>
Description Key type of key that is stored in the keystore. JKS or pkcs12 can be used.
Value Type string

(69) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info >< keystore > <keystore-password>
Description Password to access the keystore. To store the password in an encrypted form, use the format {algorithm}ciphertext. For example, {DES}FQrLbQ/D8O1lDVS71L28rw==
Value Type string

(70) < jeus-webservices-dd >< service >< port >< security >< response-sender >< signature-infos >< signature-info >< keystore > <keystore-filename>
Description File name of the keystore. If the file exists in the same directory as the class, enter the file name. If the file exists in a different directory, enter the file name with its absolute path. <!-- 원본 메시지 "파일 이름만 입력할 경우, 클래스 경로에서 찾게 되므로 --> <!-- 파일 이름이나 절대 경로를 포함하는 파일 이름을 입력한다." 가 모호하여 연구소에 문의. 임시로 절대 경로를 포함하는 값을 지칭한다는 내용으로 번역. -->
Value Type string

(71) < jeus-webservices-dd >< service >< port >< security >< response-sender > <encryption-infos>
Description Setting for encrypting messages.
Value Type encryption-infosType
Child Elements

(73) encryption-info

(72) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos > <encryption-info>
Description Setting for encrypting messages.
Value Type encryption-infoType
Child Elements

(74) encryptionParts

(75) keyTransportAlogrithm

(76) encryptionAlgorithm

(77) encryptionUser

(78) keyIdentifier

(79) keystore

(83) embeddedKey

(73) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info > <encryptionParts>
Description Setting for encrypting a specific part of a message. The format is "{mode}{ns}{localname};{mode}{ns}{localname};…". The default mode value is "content".
Value Type string

(74) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info > <keyTransportAlogrithm>
Description Algorithm for message digests. Use one of the RSA 1.5 algorithms.
Value Type keyTransportAlogrithmType
Defined Value

http://www.w3.org/2001/04/xmlenc#rsa-1

(75) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info > <encryptionAlgorithm>
Description Encryption algorithm. AES_128, AES_256, TRIPLE_DES, and AES_192 can be used.
Value Type encryptionAlgorithmType
Defined Value

http://www.w3.org/2001/04/xmlenc#tripledes-cbc

http://www.w3.org/2001/04/xmlenc#aes128-cbc

http://www.w3.org/2001/04/xmlenc#aes192-cbc

http://www.w3.org/2001/04/xmlenc#aes256-cbc

http://www.tmaxsoft.com/xml/algorithms/xmlenc#seed-cbc

(76) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info > <encryptionUser>
Description Alias for the encryption key.
Value Type string

(77) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info > <keyIdentifier>
Description Information expression type of the encryption key. IssuerSerial, DirectReference, SKIKeyIdentifier, X509KeyIdentifier, and EmbeddedKeyName can be used.
Value Type encKeyIdentifierType
Defined Value

IssuerSerial

DirectReference

SKIKeyIdentifier

X509KeyIdentifier

EmbeddedKeyName

(78) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info > <keystore>
Description Keystore for encryption keys.
Value Type keystoreType
Child Elements

(80) key-type

(81) keystore-password

(82) keystore-filename

(79) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info >< keystore > <key-type>
Description Key type of key that is stored in the keystore. JKS or pkcs12 can be used.
Value Type string

(80) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info >< keystore > <keystore-password>
Description Password to access the keystore. To store the password in an encrypted form, use the format {algorithm}ciphertext. For example, {DES}FQrLbQ/D8O1lDVS71L28rw==
Value Type string

(81) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info >< keystore > <keystore-filename>
Description File name of the keystore. If the file exists in the same directory as the class, enter the file name. If the file exists in a different directory, enter the file name with its absolute path. <!-- 원본 메시지 "파일 이름만 입력할 경우, 클래스 경로에서 찾게 되므로 --> <!-- 파일 이름이나 절대 경로를 포함하는 파일 이름을 입력한다." 가 모호하여 연구소에 문의. 임시로 절대 경로를 포함하는 값을 지칭한다는 내용으로 번역. -->
Value Type string

(82) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info > <embeddedKey>
Description Key that is shared between the web service and its clients. This can be set when keyIdentifier is set to EmbeddedKeyName.
Value Type embeddedKeyType
Child Elements

(84) embeddedKeyCallbackClass

(85) key-name

(83) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info >< embeddedKey > <embeddedKeyCallbackClass>
Description Callback class that has the session key's byte information used to access the key.
Value Type string

(84) < jeus-webservices-dd >< service >< port >< security >< response-sender >< encryption-infos >< encryption-info >< embeddedKey > <key-name>
Description Name of the session key.
Value Type string

(85) < jeus-webservices-dd >< service >< port > <rm>
Description WS-ReliableMessaging.
Value Type rmType
Child Elements

(87) client-provider

(86) < jeus-webservices-dd >< service >< port >< rm > <client-provider>
Description Indicates whether to run the RM web service in client mode. The default value is false.
Value Type string

(87) < jeus-webservices-dd >< service >< port > <transaction>
Description WS-Transaction.
Value Type emptyType