Chapter 19. Configuring jeus-ejb-dd.xml
Prev   Next

Chapter 19. Configuring jeus-ejb-dd.xml

Table of Contents

19.1. Introduction
19.2. XML Schema/XML Tree
19.3. Element Reference
19.4. Example File

This chapter explains the contents of jeus-ejb-dd.xml, an EJB module deployment descriptor.

19.1. Introduction

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.

19.2. XML Schema/XML Tree

19.3. Element Reference

(1) <jeus-ejb-dd>
Description Root element for a single EJB module, which exists in each 'jeus-ejb-dd.xml' file.
Value Type jeus-ejb-ddType
Child Elements

(3) module-info

(22) beanlist

(250) ejb-relation-map

(258) message-destination

(262) client-view-path

(263) class-ftp-unit

(264) java-security-permission

(267) batch-thread-pool

(277) library-ref

(2) < jeus-ejb-dd > <module-info>
Description Use this to configure the general settings for the EJB module.
Value Type ejb-module-infoType
Child Elements

(4) ejb11-compatible

(5) role-permission

(12) unspecified-method-permission

(16) unspecified-container-transaction

(17) use-dynamic-proxy-for-ejb2

(18) timer-service

(3) < jeus-ejb-dd >< module-info > <ejb11-compatible>
Description Indicates that the EJB is identified as 1.1 when the CMP version is not configured in ejb-jar.xml. This option is used for EJB version 1.1.
Value Type boolean
Default Value false

(4) < jeus-ejb-dd >< module-info > <role-permission>
Description Role permission for the user principal for the EJB module.
Value Type rolePermissionType
Child Elements

(6) role

(7) principal

(8) actions

(9) classname

(10) excluded

(11) unchecked

(5) < jeus-ejb-dd >< module-info >< role-permission > <role>
Description Name of the role to be assigned to the principals.
Value Type token

(6) < jeus-ejb-dd >< module-info >< role-permission > <principal>
Description User principal for the role.
Value Type token
Value Description Name of the principal specified in accounts.xml in the security directory.

(7) < jeus-ejb-dd >< module-info >< role-permission > <actions>
Description Action for the RolePermission object. The default value is no action for RolePermissions.
Value Type token

(8) < jeus-ejb-dd >< module-info >< role-permission > <classname>
Description Role permission class name. If a class name is not specified, the default class name will be used.
Value Type token

(9) < jeus-ejb-dd >< module-info >< role-permission > <excluded>
Description Indicates that the role will be disabled.
Value Type emptyType

(10) < jeus-ejb-dd >< module-info >< role-permission > <unchecked>
Description Indicates that the role will be available without any permission.
Value Type emptyType

(11) < jeus-ejb-dd >< module-info > <unspecified-method-permission>
Description Permission for a method for which permission is not specified in ejb-jar.xml.
Value Type unspecified-method-permissionType
Child Elements

(13) role

(14) excluded

(15) unchecked

(12) < jeus-ejb-dd >< module-info >< unspecified-method-permission > <role>
Description Role for methods for which permission is not specified in ejb-jar.xml. Principals of other roles will not have the permission to call methods.
Value Type token
Value Description Enter the name of the role specified in <assembler-description> in ejb-jar.xml.

(13) < jeus-ejb-dd >< module-info >< unspecified-method-permission > <excluded>
Description Indicates that the methods for which no permissions are specified in ejb-jar.xml are excluded from calling. As a result, some principals will not have the permissoin to call the methods.
Value Type emptyType

(14) < jeus-ejb-dd >< module-info >< unspecified-method-permission > <unchecked>
Description Indicates that the methods for which no permissions have been specified are treated as unchecked. All principals have the permission to call methods.
Value Type emptyType

(15) < jeus-ejb-dd >< module-info > <unspecified-container-transaction>
Description Indicates that a container manages transactions if it has not been configured in ejb-jar.xml. The default value is -Djeus.ejb.transaction.attribute.default. For EJB 3.0, the default value is REQUIRED. For EJB 2.1, it is SUPPORTS, which is the same as the configuration for JEUS 5.
Value Type trans-attributeType
Defined Value

NotSupported

Supports

Required

RequiresNew

Mandatory

Never

(16) < jeus-ejb-dd >< module-info > <use-dynamic-proxy-for-ejb2>
Description For JEUS 6 Fix#7 or later, EJB 2.x beans may replace the existing RMI stub method with the dynamic proxy method. The dynamic proxy method does not require loading RMI stub classes, but calls a method using a dynamic proxy (java.lang.reflect.Proxy) for RMI stubs already generated. This method enables local call optimization, which improves performance by invoking an EJB remote call in the same JVM not through RMI but as a local call. If a client is allowed to call EJB remotely and is using library version earlier than JEUS 6 Fix#6, this option to use the direct proxy method should be set to "false" to avoid compatibility issues. By default, the dynamic proxy method is used for EJB 2.x style beans.
Value Type boolean
Default Value true

(17) < jeus-ejb-dd >< module-info > <timer-service>
Description Use this to enable cluster-wide timer service. Before using the service, the data source must be set in domain.xml.
Value Type ejb-module-timer-serviceType
Child Elements

(19) timer-type

(20) primary-server

(18) < jeus-ejb-dd >< module-info >< timer-service > <timer-type>
Description Timer type. The Local value starts a timer in the server where the EJB module is deployed. Multiple timers that carry out the same task might be enabled on several servers if the EJB module is clustered and deployed on several servers. Configure failover or load balancing if a cluster-wide timer is needed to prevent this situation from occurring. If two options are configured, only one timer will be enabled for clustered EJB modules.
Value Type ejbTimerType
Default Value Local
Defined Value

Local

Failover

(19) < jeus-ejb-dd >< module-info >< timer-service > <primary-server>
Description Primary server that will start the EJB timer in the cluster in which the EJB module is deployed. This setting is only valid if the timer type is failover, and if set, every timer created in the relevant module will be started on the primary server. An automatic failover to another server occurs if the primary server is shut down, and failback is initiated if the primary server restarts. If this option is not configured, the primary server is determined internally when deployed and does not support failback.
Value Type ejbTimerTargetType
Child Elements

(21) server-name

(20) < jeus-ejb-dd >< module-info >< timer-service >< primary-server > <server-name>
Description Primary server that will start the EJB timer in the cluster where the EJB module is deployed.
Value Type token

(21) < jeus-ejb-dd > <beanlist>
Description Properties of each bean.
Value Type beanlistType
Child Elements

(23) jeus-bean

(22) < jeus-ejb-dd >< beanlist > <jeus-bean>
Description JEUS's specifications for each bean, which must be configured in ejb-jar.xml. For information about how to configure specifications for different types of beans, refer to "JEUS EJB Guide."
Value Type jeus-beanType
Child Elements

(24) ejb-name

(25) export-name

(26) local-export-name

(27) export-port

(28) export-iiop

(30) preferred-call-by-reference

(31) use-access-control

(32) run-as-identity

(34) security-interop

(39) env

(43) ejb-ref

(47) res-ref

(51) res-env-ref

(55) message-destination-ref

(59) service-ref

(136) thread-max

(137) clustering

(165) invoke-http

(168) jeus-rmi

(169) object-management

(182) persistence-optimize

(191) schema-info

(221) database-insert-delay

(222) cm-persistence-optimize

(226) enable-instant-ql

(227) connection-factory-name

(228) mdb-resource-adapter

(239) destination

(240) jndi-spi

(244) max-message

(245) ack-mode

(246) durable

(247) msg-selector

(248) timer-service

(23) < jeus-ejb-dd >< beanlist >< jeus-bean > <ejb-name>
Description EJB name that is part of annotations in either ejb-jar.xm or the bean class.
Value Type token

(24) < jeus-ejb-dd >< beanlist >< jeus-bean > <export-name>
Description Only name that will be registered in the JNDI naming system. Every bean that participates in clustering must have the same export name.
Value Type token
Value Description This name must be unique in the JNDI naming system.

(25) < jeus-ejb-dd >< beanlist >< jeus-bean > <local-export-name>
Description JNDI name that is used when the bean has a local bean interface.
Value Type token
Value Description The name must be unique in the JNDI naming system.

(26) < jeus-ejb-dd >< beanlist >< jeus-bean > <export-port>
Description RMI listener port for the bean. It can be used when there is a firewall between the client and the EJB. This can only be used when the administrator provides the port number that allows RMI communication.
Value Type nonNegativeIntType
Value Description Port number
Default Value 0

(27) < jeus-ejb-dd >< beanlist >< jeus-bean > <export-iiop>
Description Indicates that a bean's interface can be exported to the COS naming server as an IIOP stub and skeleton. This way, every client that can use IIOP has access to the bean.
Value Type export-iiopType
Child Elements

(29) only-iiop

(28) < jeus-ejb-dd >< beanlist >< jeus-bean >< export-iiop > <only-iiop>
Description Indicates whether RMI stubs other than IIOP are to be also registered with EJB Home. If registered together, the IIOP stub will be registered with CosNaming and the RMI stubs will be registered with the JEUS JNDI.
Value Type boolean
Default Value true

(29) < jeus-ejb-dd >< beanlist >< jeus-bean > <preferred-call-by-reference>
Description (From JEUS 6 Fix#7 onwards) Equivalent to the existing <call-by-value> option. When an EJB is called using a remote interface, this configuration indicates that the parameters and the return value of methods invoked at local optimization use call by reference. Local call optimization enhances performance by processing EJB Remote calls within the same JVM as local calls instead of by RMI calls. The EJB standard states that EJBs called using the local interface should use call by reference, and those called using remote interface should use call by value. However, when local call optimization is enabled and the EJB is called using the remote interface and call by reference is used to enhance performance, the option can be set to true. <Attention> Even if this is set to true, remote EJB calls do not use call by reference when the isolated class loader mode is enabled and when a dynamic proxy (<use-dynamic-proxy-for-ejb2>) is disabled for EJB 2.x. Therefore, it is not recommended to use <preferred-call-by-reference> to create applications that use call by reference method. Consider the restrictions mentioned above when implementing remote EJB method calls using call by reference.
Value Type boolean
Default Value false

(30) < jeus-ejb-dd >< beanlist >< jeus-bean > <use-access-control>
Description Indicates whether to enable Java SE Security access control for the principal regarding resources used by the EJB method. Before using this option, the Security Manager must be activated using -Djava.security.manager when starting JEUS.
Value Type boolean
Default Value false

(31) < jeus-ejb-dd >< beanlist >< jeus-bean > <run-as-identity>
Description Maps the name of the role in <run-as-specified-identity> in ejb-jar.xml to the actual user name of the principal.
Value Type run-as-identityType
Child Elements

(33) principal-name

(32) < jeus-ejb-dd >< beanlist >< jeus-bean >< run-as-identity > <principal-name>
Description Name of the principal for the role of <run-as-specified-identity> in ejb-jar.xml or web.xml.
Value Type token
Value Description Principal name specified in the security section of subjects.xml.

(33) < jeus-ejb-dd >< beanlist >< jeus-bean > <security-interop>
Description Declared when IIOP/CSI is used, and when enable-interop is set to true. Refer to the CSI specifications for more information.
Value Type security-interopType
Child Elements

(35) integrity-confidentiality

(36) trust-in-client

(37) client-auth

(38) identity-assertion

(34) < jeus-ejb-dd >< beanlist >< jeus-bean >< security-interop > <integrity-confidentiality>
Description Maps the "Integrity" bit to the "Confidentiality" bit defined in the CSI specifications. Both bits are configured according the configuration here.
Value Type security-interopElementType
Default Value NotSupported
Defined Value

NotSupported

Supports

Requires

(35) < jeus-ejb-dd >< beanlist >< jeus-bean >< security-interop > <trust-in-client>
Description Maps "Trust in client", which is defined in the CSI specifications.
Value Type security-interopElementType
Default Value NotSupported
Defined Value

NotSupported

Supports

Requires

(36) < jeus-ejb-dd >< beanlist >< jeus-bean >< security-interop > <client-auth>
Description Maps "Client authentication", which is defined in the CSI specifications.
Value Type security-interopElementType
Default Value NotSupported
Defined Value

NotSupported

Supports

Requires

(37) < jeus-ejb-dd >< beanlist >< jeus-bean >< security-interop > <identity-assertion>
Description Maps "Identity assertion", which is defined in the CSI specifications.
Value Type security-interopElementRestrictedType
Default Value NotSupported
Defined Value

NotSupported

Supports

(38) < jeus-ejb-dd >< beanlist >< jeus-bean > <env>
Description Overrides the env-entry properties defined in the standard DD.
Value Type envType
Child Elements

(40) name

(41) value

(42) type

(39) < jeus-ejb-dd >< beanlist >< jeus-bean >< env > <name>
Description Name of an environment variable.
Value Type valuableToken

(40) < jeus-ejb-dd >< beanlist >< jeus-bean >< env > <value>
Description Parameter value of the wrapper class generator that corresponds to the environment variable.
Value Type valuableToken

(41) < jeus-ejb-dd >< beanlist >< jeus-bean >< env > <type>
Description Java data type of the environment variable.
Value Type valuableToken
Value Description Choose one from java.lang.Boolean, java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Byte, java.lang.Short, java.lang.Long, java.lang.Float, java.lang.Character.

(42) < jeus-ejb-dd >< beanlist >< jeus-bean > <ejb-ref>
Description Binds an EJB reference to an actual EJB JNDI name.
Value Type jndi-refType
Child Elements

(44) jndi-info

(43) < jeus-ejb-dd >< beanlist >< jeus-bean >< ejb-ref > <jndi-info>
Description Maps the logical name of an environment entry to an actual JNDI name. For example, an environment entry named "jdbc/myDataSource" is mapped to "DataSource1", which is an actual JNDI name.
Value Type jndi-infoType
Child Elements

(45) ref-name

(46) export-name

(44) < jeus-ejb-dd >< beanlist >< jeus-bean >< ejb-ref >< jndi-info > <ref-name>
Description Name of a reference.
Value Type valuableToken
Value Description The reference name will be bound to an actual JNDI name. The reference name corresponds to that of the J2EE standard descriptor.

(45) < jeus-ejb-dd >< beanlist >< jeus-bean >< ejb-ref >< jndi-info > <export-name>
Description Actual JNDI name defined in the JEUS DD.
Value Type token

(46) < jeus-ejb-dd >< beanlist >< jeus-bean > <res-ref>
Description Use this to declare reference name for an external resource such as a database.
Value Type jndi-refType
Child Elements

(48) jndi-info

(47) < jeus-ejb-dd >< beanlist >< jeus-bean >< res-ref > <jndi-info>
Description Maps the logical name of an environment entry to an actual JNDI name. For example, an environment entry named "jdbc/myDataSource" is mapped to "DataSource1", which is an actual JNDI name.
Value Type jndi-infoType
Child Elements

(49) ref-name

(50) export-name

(48) < jeus-ejb-dd >< beanlist >< jeus-bean >< res-ref >< jndi-info > <ref-name>
Description Name of a reference.
Value Type valuableToken
Value Description The reference name will be bound to an actual JNDI name. The reference name corresponds to that of the J2EE standard descriptor.

(49) < jeus-ejb-dd >< beanlist >< jeus-bean >< res-ref >< jndi-info > <export-name>
Description Actual JNDI name defined in the JEUS DD.
Value Type token

(50) < jeus-ejb-dd >< beanlist >< jeus-bean > <res-env-ref>
Description Binds a reference to an external resource with an actual JNDI name. This element corresponds to <resource-env-ref> of the standard EJB DD.
Value Type jndi-refType
Child Elements

(52) jndi-info

(51) < jeus-ejb-dd >< beanlist >< jeus-bean >< res-env-ref > <jndi-info>
Description Maps the logical name of an environment entry to an actual JNDI name. For example, an environment entry named "jdbc/myDataSource" is mapped to "DataSource1", which is an actual JNDI name.
Value Type jndi-infoType
Child Elements

(53) ref-name

(54) export-name

(52) < jeus-ejb-dd >< beanlist >< jeus-bean >< res-env-ref >< jndi-info > <ref-name>
Description Name of a reference.
Value Type valuableToken
Value Description The reference name will be bound to an actual JNDI name. The reference name corresponds to that of the J2EE standard descriptor.

(53) < jeus-ejb-dd >< beanlist >< jeus-bean >< res-env-ref >< jndi-info > <export-name>
Description Actual JNDI name defined in the JEUS DD.
Value Type token

(54) < jeus-ejb-dd >< beanlist >< jeus-bean > <message-destination-ref>
Description Reference name for an external resource to be mapped to an actual JNDI name. This element corresponds to <message-destination-ref> of the standard DD.
Value Type jndi-refType
Child Elements

(56) jndi-info

(55) < jeus-ejb-dd >< beanlist >< jeus-bean >< message-destination-ref > <jndi-info>
Description Maps the logical name of an environment entry to an actual JNDI name. For example, an environment entry named "jdbc/myDataSource" is mapped to "DataSource1", which is an actual JNDI name.
Value Type jndi-infoType
Child Elements

(57) ref-name

(58) export-name

(56) < jeus-ejb-dd >< beanlist >< jeus-bean >< message-destination-ref >< jndi-info > <ref-name>
Description Name of a reference.
Value Type valuableToken
Value Description The reference name will be bound to an actual JNDI name. The reference name corresponds to that of the J2EE standard descriptor.

(57) < jeus-ejb-dd >< beanlist >< jeus-bean >< message-destination-ref >< jndi-info > <export-name>
Description Actual JNDI name defined in the JEUS DD.
Value Type token

(58) < jeus-ejb-dd >< beanlist >< jeus-bean > <service-ref>
Description Root element of a JEUS Web service client configuration documentation.
Value Type jeus-webservices-client-ddType
Child Elements

(60) service-client

(59) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref > <service-client>
Description Settings for web service clients that will be deployed.
Value Type serviceClientType
Child Elements

(61) service-ref-name

(62) port-info

(129) service-impl-class

(130) wsdl-override

(131) require-dynamic-proxy

(132) service-qname

(133) call-property

(60) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client > <service-ref-name>
Description Name of a relevant web service endpoint in the WSDL file. This corresponds to the deployment descriptor file web.xml or <service-ref-name> in ejb-jar.xml.
Value Type token

(61) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client > <port-info>
Description Web service port information that is used by deployed web service clients.
Value Type portInfoType
Child Elements

(63) service-endpoint-interface

(64) wsdl-port

(65) stub-property

(68) call-property

(71) security

(62) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info > <service-endpoint-interface>
Description Class that implements the ServiceEndpoint interface for the WSDL port. This corresponds to <service-endpoint-interface> of <port-component-ref> in <service-ref>.
Value Type token

(63) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info > <wsdl-port>
Description WSDL port information for <port-info>.
Value Type QName

(64) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info > <stub-property>
Description Properties that apply to the javax.xml.rpc.Stub object that is used in a certain port.
Value Type nameValueType
Child Elements

(66) name

(67) value

(65) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< stub-property > <name>
Description Key name that is used to configure properties for javax.xml.rpc.Stub or javax.xml.rpc.Call.
Value Type string

(66) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< stub-property > <value>
Description Key value that is used to configure properties for javax.xml.rpc.Stub or javax.xml.rpc.Call.
Value Type string

(67) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info > <call-property>
Description Properties that apply to the javax.xml.rpc.Call object that is used in a certain port.
Value Type nameValueType
Child Elements

(69) name

(70) value

(68) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< call-property > <name>
Description Key name that is used to configure properties for javax.xml.rpc.Stub or javax.xml.rpc.Call.
Value Type string

(69) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< call-property > <value>
Description Key value that is used to configure properties for javax.xml.rpc.Stub or javax.xml.rpc.Call.
Value Type string

(70) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info > <security>
Description Web service clients for Web service security (WS-Security).
Value Type webservice-securityType
Child Elements

(72) request-sender

(110) response-receiver

(71) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security > <request-sender>
Description Setting to secure a message that calls a Web service.
Value Type security-senderType
Child Elements

(73) action-list

(74) password-callback-class

(75) user

(76) timeStamp

(81) userNameToken

(85) signature-infos

(96) encryption-infos

(72) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(73) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender > <password-callback-class>
Description Full package name of the callback class that sets passwords.
Value Type string

(74) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender > <user>
Description User name, which is used for UsernameToken and as an alias for the signing key.
Value Type string

(75) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender > <timeStamp>
Description TTL (time-to-live) aberration for timestamps.
Value Type timeStampType
Child Elements

(77) timeToLive

(78) aberration

(79) requireSignature

(80) precision

(76) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< timeStamp > <timeToLive>
Description Expiry time of sent messages in seconds.
Value Type positiveInteger

(77) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< timeStamp > <aberration>
Description Difference from UTC in seconds. The default value is 0 seconds.
Value Type integer

(78) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< timeStamp > <requireSignature>
Description Indicates whether to sign the timestamp. The default value is true.
Value Type boolean

(79) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< timeStamp > <precision>
Description Extra time that is allowed for network and processing delays.
Value Type positiveInteger

(80) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender > <userNameToken>
Description UsernameToken.
Value Type userNameTokenSenderType
Child Elements

(82) password

(83) passwordType

(84) userTokenElements

(81) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(82) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< userNameToken > <passwordType>
Description Password type for UsernameToken. PasswordDigest or PasswordText can be used.
Value Type passwordTypeType
Defined Value

PasswordDigest

PasswordText

(83) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(84) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender > <signature-infos>
Description Setting for signing messages.
Value Type signature-infosType
Child Elements

(86) signature-info

(85) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< signature-infos > <signature-info>
Description Setting for signing messages. Multiple configurations are possible.
Value Type signature-infoType
Child Elements

(87) signatureParts

(88) signatureAlgorithm

(89) messageDigestAlogrithm

(90) canonicalization

(91) keyIdentifier

(92) keystore

(86) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(87) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(88) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(89) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(90) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(91) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< signature-infos >< signature-info > <keystore>
Description Keystore for private keys that are used to sign messages.
Value Type keystoreType
Child Elements

(93) key-type

(94) keystore-password

(95) keystore-filename

(92) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(93) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(94) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(95) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender > <encryption-infos>
Description Setting for encrypting messages.
Value Type encryption-infosType
Child Elements

(97) encryption-info

(96) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< encryption-infos > <encryption-info>
Description Setting for encrypting messages.
Value Type encryption-infoType
Child Elements

(98) encryptionParts

(99) keyTransportAlogrithm

(100) encryptionAlgorithm

(101) encryptionUser

(102) keyIdentifier

(103) keystore

(107) embeddedKey

(97) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(98) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(99) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(100) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< encryption-infos >< encryption-info > <encryptionUser>
Description Alias for the encryption key.
Value Type string

(101) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(102) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< encryption-infos >< encryption-info > <keystore>
Description Keystore for encryption keys.
Value Type keystoreType
Child Elements

(104) key-type

(105) keystore-password

(106) keystore-filename

(103) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(104) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(105) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(106) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(108) embeddedKeyCallbackClass

(109) key-name

(107) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-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

(108) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< request-sender >< encryption-infos >< encryption-info >< embeddedKey > <key-name>
Description Name of the session key.
Value Type string

(109) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security > <response-receiver>
Description Setting to specify a response to a secured message from a Web service.
Value Type security-receiverType
Child Elements

(111) action-list

(112) observeActionOrder

(113) password-callback-class

(114) timeStamp

(119) decryption

(124) signature-verification

(110) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-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

(111) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-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

(112) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver > <password-callback-class>
Description Password callback class name. Type the entire package name.
Value Type string

(113) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver > <timeStamp>
Description TTL (time-to-live) aberration for timestamps.
Value Type timeStampType
Child Elements

(115) timeToLive

(116) aberration

(117) requireSignature

(118) precision

(114) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver >< timeStamp > <timeToLive>
Description Expiry time of sent messages in seconds.
Value Type positiveInteger

(115) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver >< timeStamp > <aberration>
Description Difference from UTC in seconds. The default value is 0 seconds.
Value Type integer

(116) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver >< timeStamp > <requireSignature>
Description Indicates whether to sign the timestamp. The default value is true.
Value Type boolean

(117) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver >< timeStamp > <precision>
Description Extra time that is allowed for network and processing delays.
Value Type positiveInteger

(118) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver > <decryption>
Description Setting for decrypting encrypted received messages.
Value Type decryptionType
Child Elements

(120) keystore

(119) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver >< decryption > <keystore>
Description Keystore for decrypting messages.
Value Type keystoreType
Child Elements

(121) key-type

(122) keystore-password

(123) keystore-filename

(120) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-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

(121) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-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

(122) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-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

(123) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver > <signature-verification>
Description Setting for verifying received message signatures.
Value Type signature-verificationType
Child Elements

(125) keystore

(124) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-receiver >< signature-verification > <keystore>
Description Keystore for verifying signatures.
Value Type keystoreType
Child Elements

(126) key-type

(127) keystore-password

(128) keystore-filename

(125) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-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

(126) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-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

(127) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< port-info >< security >< response-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

(128) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client > <service-impl-class>
Description Service implementation class for web service clients. This is created automatically for deployment, so web service deployment descriptors do not need to create the class.
Value Type token

(129) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client > <wsdl-override>
Description WSDL file location to replace <wsdl-file> in <service-ref>. The specified location should be a valid URL.
Value Type string

(130) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client > <require-dynamic-proxy>
Description Indicates to enable Dynamic Proxy for ServiceReferenceFactory when Port Component Link is used.
Value Type boolean

(131) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client > <service-qname>
Description Service definitions of the WSDL file.
Value Type QName

(132) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client > <call-property>
Description Properties that apply to all javax.xml.rpc.Call objects used in WSDL services.
Value Type nameValueType
Child Elements

(134) name

(135) value

(133) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< call-property > <name>
Description Key name that is used to configure properties for javax.xml.rpc.Stub or javax.xml.rpc.Call.
Value Type string

(134) < jeus-ejb-dd >< beanlist >< jeus-bean >< service-ref >< service-client >< call-property > <value>
Description Key value that is used to configure properties for javax.xml.rpc.Stub or javax.xml.rpc.Call.
Value Type string

(135) < jeus-ejb-dd >< beanlist >< jeus-bean > <thread-max>
Description Maximum number of threads that the EJB engine processes after receiving a request from a remote client. If the number of threads is equal to the specified value, a request waits until threads are available. The value 0 indicates that there is no limit to the number of threads.
Value Type nonNegativeIntType
Default Value 100

(136) < jeus-ejb-dd >< beanlist >< jeus-bean > <clustering>
Description Clustering provides failover and load balancing. It is available when a single EJB is installed on all other EJB servers. Clustering for EJB engines is similar to clustering between JEUS servers. All EJBs that participate in clustering must have the same export name.
Value Type clusteringType
Child Elements

(138) enable-clustering

(139) create-idempotent

(140) ejb-home-idempotent-method

(144) ejb-home-idempotent-exclude-method

(148) ejb-remote-idempotent-method

(152) ejb-remote-idempotent-exclude-method

(156) replication

(164) use-dlr

(137) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering > <enable-clustering>
Description Option to enable clustering.
Value Type boolean
Default Value false

(138) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering > <create-idempotent>
Description Indicates whether the home interface's create call is idempotent during failover. For business interfaces, this option indicates whether the bean lookup call is idempotent. You can configure this option for session bean classes as well. If it is not configured for session bean classes, stateless session beans are considered idempotent, and stateful session beans are not considered idempotent by default.
Value Type boolean

(139) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering > <ejb-home-idempotent-method>
Description Idempotent home method, which guarantees that there will be no changes to the bean itself or to the contents of any database fields. The idempotent method is a getter method, which returns the result value without making any changes. You can use this method when calling a method fails. It is safe to call an idempotent method again if a previous call has failed. However, if the method is not idempotent, there is no way to safely call it again. There is a risk that operations will be repeated from repeat calls, and it would be better to throw exceptions instead. Therefore, using more idempotent methods leads to a more efficient EJB failover.
Value Type methodParamType
Child Elements

(141) method-name

(142) method-params

(140) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-home-idempotent-method > <method-name>
Description Name of the method
Value Type valuableToken

(141) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-home-idempotent-method > <method-params>
Description Parameters of the method in order.
Value Type method-paramsType
Child Elements

(143) method-param

(142) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-home-idempotent-method >< method-params > <method-param>
Description Fully qualified class name of a method parameter.
Value Type valuableToken

(143) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering > <ejb-home-idempotent-exclude-method>
Description Methods that will be excluded from idempotent home methods. This option overrides <ejb-home-idempotent-method>.
Value Type methodParamType
Child Elements

(145) method-name

(146) method-params

(144) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-home-idempotent-exclude-method > <method-name>
Description Name of the method
Value Type valuableToken

(145) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-home-idempotent-exclude-method > <method-params>
Description Parameters of the method in order.
Value Type method-paramsType
Child Elements

(147) method-param

(146) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-home-idempotent-exclude-method >< method-params > <method-param>
Description Fully qualified class name of a method parameter.
Value Type valuableToken

(147) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering > <ejb-remote-idempotent-method>
Description Idempotent remote method, which guarantees that there are no changes to the bean itself or to the contents of any database fields. The idempotent method is a getter method that returns the result value without making any changes. You can use this method when calling a method fails. It is safe to call an idempotent method again if a previous call has failed. However, if the method is not idempotent, there is no way to safely call it again. There is a risk that operations will be repeated from repeat calls, and it would be better to throw exceptions instead. Therefore, using more idempotent methods leads to a more efficient EJB failover.
Value Type methodParamType
Child Elements

(149) method-name

(150) method-params

(148) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-remote-idempotent-method > <method-name>
Description Name of the method
Value Type valuableToken

(149) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-remote-idempotent-method > <method-params>
Description Parameters of the method in order.
Value Type method-paramsType
Child Elements

(151) method-param

(150) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-remote-idempotent-method >< method-params > <method-param>
Description Fully qualified class name of a method parameter.
Value Type valuableToken

(151) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering > <ejb-remote-idempotent-exclude-method>
Description Methods that will be excluded from idempotent remote methods. This option overrides <ejb-remote-idempotent-method>.
Value Type methodParamType
Child Elements

(153) method-name

(154) method-params

(152) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-remote-idempotent-exclude-method > <method-name>
Description Name of the method
Value Type valuableToken

(153) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-remote-idempotent-exclude-method > <method-params>
Description Parameters of the method in order.
Value Type method-paramsType
Child Elements

(155) method-param

(154) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< ejb-remote-idempotent-exclude-method >< method-params > <method-param>
Description Fully qualified class name of a method parameter.
Value Type valuableToken

(155) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering > <replication>
Description Use this to configure the replication mode for each method.
Value Type replicationType
Child Elements

(157) bean-mode

(158) methods

(156) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< replication > <bean-mode>
Description Bean-level replication mode. The default value is the value of Annotation, and if Annotation is not configured, the default value is SYNC.
Value Type replication-modeType
Defined Value

sync

async

none

(157) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< replication > <methods>
Value Type replicationMethodsType
Child Elements

(159) method

(158) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< replication >< methods > <method>
Value Type replicationOfMethodType
Child Elements

(160) method-name

(161) method-params

(163) mode

(159) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< replication >< methods >< method > <method-name>
Description Name of a method.
Value Type token

(160) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< replication >< methods >< method > <method-params>
Description Parameters of a method in order.
Value Type method-paramsType
Child Elements

(162) method-param

(161) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< replication >< methods >< method >< method-params > <method-param>
Description Fully qualified class name of a method parameter.
Value Type valuableToken

(162) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering >< replication >< methods >< method > <mode>
Description Session replication mode. You can choose from sync, async, or none.
Value Type replication-modeType
Defined Value

sync

async

none

(163) < jeus-ejb-dd >< beanlist >< jeus-bean >< clustering > <use-dlr>
Description Indicates whether to enable DynamicLinkRef for clustering. DynamicLinkRef allows EJB clustering using JNDI. By default, this option is set to true.
Value Type boolean

(164) < jeus-ejb-dd >< beanlist >< jeus-bean > <invoke-http>
Description Indicates that HTTP-RMI requests are used by the client's EJB stub and the RMI runtime environment in a remote RMI environment. It can be used when accessing an EJB through a firewall. If a client calls a method from the EJB stub using HTTP, the HTTP-RMI request sends it to the web server, which will send it to the web container. Then, the web container sends the request to the RMI servlet handler (jeus.rmi.http.ServletHandler), and there, the servlet handler removes the HTTP headers from the request and sends it to the runtime environment. Before configuring this option, the servlet jeus.rmi.http.ServletHandler must be deployed to the JEUS web container. For more information about this condition, refer to "JEUS Web Engine Guide."
Value Type invoke-httpType
Child Elements

(166) url

(167) http-port

(165) < jeus-ejb-dd >< beanlist >< jeus-bean >< invoke-http > <url>
Description URI path of an RMI servlet handler (jeus.rmi.http.ServletHandler) to be called by an HTTP-RMI stub. Specify the servlet request path only. Do not specify the protocol, the web server IP, and the port number here. The protocol takes as given that HTTP, RMI, and the web server share the same IP address. This means that the web server and the web engine receive HTTP-RMI requests from the same machine. The port number can be configured in the following element.
Value Type token
Value Description Servlet context path to an RMI handler servlet.

(166) < jeus-ejb-dd >< beanlist >< jeus-bean >< invoke-http > <http-port>
Description Port number of the Web server which will receive HTTP-RMI requests. Before configuring the port, RMI handler servlets must be deployed and executed on the Web server/Web container.
Value Type nonNegativeIntType
Value Description Port number of the Web server to connect with the HTTP-RMI stub.
Default Value 80

(167) < jeus-ejb-dd >< beanlist >< jeus-bean > <jeus-rmi>
Description Indicates whether to use the JEUS RMI instead of the Sun RMI to communicate with clients. JEUS RMI performs better than Java RMI and has an advantage when there are many clients because of NIO can be used.
Value Type boolean
Default Value false

(168) < jeus-ejb-dd >< beanlist >< jeus-bean > <object-management>
Description Setting for connection and bean instance pooling.
Value Type object-managementType
Child Elements

(170) pooling-bean

(171) bean-pool

(175) connect-pool

(179) capacity

(180) passivation-timeout

(181) disconnect-timeout

(169) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management > <pooling-bean>
Description Option enable <bean-pool>. This is only available in stateful session beans. Stateful session beans do not use recycled pools because the status of the stateful session bean instance varies from a client request to another. When a bean pool is used, bean instances are returned to the bean pool and can be used by other clients after the client calls the remove method or is removed because of a disconnect timeout. To ensure this, PRE DESTROY callback should be used to reset the instances.
Value Type boolean
Default Value false

(170) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management > <bean-pool>
Description Bean pool, which manages the EJB bean class instance. Instances are taken out of the pool and begin the service upon receiving a client request. New instances are created when there are no more instances in the pool and are added to the bean pool.
Value Type bean-poolType
Child Elements

(172) pool-min

(173) pool-max

(174) resizing-period

(171) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management >< bean-pool > <pool-min>
Description Minimum number of instances initially created in the pool and the minimum number of instances to maintain in the pool after resizing it.
Value Type nonNegativeIntType
Default Value 0

(172) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management >< bean-pool > <pool-max>
Description Maximum number of instances that the pool can hold.
Value Type nonNegativeIntType
Default Value 100

(173) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management >< bean-pool > <resizing-period>
Description Interval at which the bean pool is resized to remove idle instances.
Value Type nonNegativeLongType
Default Value 300000

(174) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management > <connect-pool>
Description Connection pool, which contains a class that implements the EJB remote interface and connects clients to the EJB instance.
Value Type bean-poolType
Child Elements

(176) pool-min

(177) pool-max

(178) resizing-period

(175) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management >< connect-pool > <pool-min>
Description Minimum number of instances initially created in the pool and the minimum number of instances to maintain in the pool after resizing it.
Value Type nonNegativeIntType
Default Value 0

(176) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management >< connect-pool > <pool-max>
Description Maximum number of instances that the pool can hold.
Value Type nonNegativeIntType
Default Value 100

(177) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management >< connect-pool > <resizing-period>
Description Interval at which the bean pool is resized to remove idle instances.
Value Type nonNegativeLongType
Default Value 300000

(178) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management > <capacity>
Description Expected maximum number of bean instances to create. This is only available for entity beans. It is used to efficiently form internal client session data that will be connected with the EJB.
Value Type positiveIntType
Value Description Number of beans
Default Value 10000

(179) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management > <passivation-timeout>
Description Bean's passivation timeout value. The bean is deleted from memory is there are no requests before the passivation timeout. If the bean resides in the entity cache of the entity bean, it becomes passivated.
Value Type off-longType
Value Description Milliseconds

(180) < jeus-ejb-dd >< beanlist >< jeus-bean >< object-management > <disconnect-timeout>
Description Bean's disconnect timeout. The connection instance is removed and returned to the connection pool if there are no requests before the disconnect timeout. For stateful session beans, the session is removed after this amount of time and the bean instance is returned to the pool after being pre-destroyed and initialized if the bean pool had been used. Use @StatefulTimeout or ejb-jar.xm's <stateful-timeout> for EJB version 3.1 stateful session beans.
Value Type off-longType
Value Description Milliseconds

(181) < jeus-ejb-dd >< beanlist >< jeus-bean > <persistence-optimize>
Description Settings for optimizing the EJB engine rules, which determine when to call the ejbLoad and ejbStore methods from the entity bean. The less often these methods are called, the better the performance is.
Value Type persistence-optimizeType
Child Elements

(183) engine-type

(184) non-modifying-method

(188) entity-cache-size

(189) update-delay-till-tx

(190) include-update

(182) < jeus-ejb-dd >< beanlist >< jeus-bean >< persistence-optimize > <engine-type>
Description Determines and optimizes the actions that occur when ejbLoad() is called from the EJB engine.
Value Type engineType
Default Value EXCLUSIVE_ACCESS
Defined Value

EXCLUSIVE_ACCESS

SINGLE_OBJECT

MULTIPLE_OBJECT

(183) < jeus-ejb-dd >< beanlist >< jeus-bean >< persistence-optimize > <non-modifying-method>
Description Non-modifying method is a method that does not cause any changes to the database that is connected to the bean. For example, getter/read-only methods are non-modifying methods. All of the bean's read-only methods are defined here so that they can call the ejbStore() method more efficiently.
Value Type methodParamType
Child Elements

(185) method-name

(186) method-params

(184) < jeus-ejb-dd >< beanlist >< jeus-bean >< persistence-optimize >< non-modifying-method > <method-name>
Description Name of the method
Value Type valuableToken

(185) < jeus-ejb-dd >< beanlist >< jeus-bean >< persistence-optimize >< non-modifying-method > <method-params>
Description Parameters of the method in order.
Value Type method-paramsType
Child Elements

(187) method-param

(186) < jeus-ejb-dd >< beanlist >< jeus-bean >< persistence-optimize >< non-modifying-method >< method-params > <method-param>
Description Fully qualified class name of a method parameter.
Value Type valuableToken

(187) < jeus-ejb-dd >< beanlist >< jeus-bean >< persistence-optimize > <entity-cache-size>
Description Number of entity bean instances to maintain in the internal cache. The passivated bean instances are retained in the cache for optimal performance.
Value Type nonNegativeIntType
Value Description Number of maximum entity bean instance to maintain in the internal cache.
Default Value 2000

(188) < jeus-ejb-dd >< beanlist >< jeus-bean >< persistence-optimize > <update-delay-till-tx>
Description If this is set to false, the EJB's inserts and updates are executed when setXXX() is called. The default is true, which indicates that the EJB's inserts and updates are executed when the transaction is committed. Example situation: 1. Begin transaction. 2. Update EJB data. 3. Read EJB data. 4. Commit transaction. If this is set to false, the data read in step 3 must have been recorded in step 2. If this is set to true, the update in step two is delayed until the commit happens in step 4.
Value Type boolean
Default Value true

(189) < jeus-ejb-dd >< beanlist >< jeus-bean >< persistence-optimize > <include-update>
Description Sets the default value for <include-updates> in each <jeus-query>, which is part of the configuration for <schema-info>. If this is set to true, updated information is available while the finder method is running because the update is committed while the finder method is being called.
Value Type boolean
Default Value false

(190) < jeus-ejb-dd >< beanlist >< jeus-bean > <schema-info>
Description Mapping information for Database column and EJB field. This option is only available for CMP entity beans.
Value Type schema-infoType
Child Elements

(192) table-name

(193) cm-field

(198) creating-table

(201) deleting-table

(202) prim-key-field

(207) jeus-query

(214) db-vendor

(215) data-source-name

(216) auto-key-generator

(191) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <table-name>
Description Name of the database table that the EJB is mapped to. Default Value: Name of EJB module concatenated with the last fifteen letters of the name of the EJB.
Value Type token

(192) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <cm-field>
Description Maps the database columns and fields that are managed by the container.
Value Type cm-fieldType
Child Elements

(194) field

(195) column-name

(196) type

(197) exclude-field

(193) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< cm-field > <field>
Description Name of a field that is mapped to a database column.
Value Type token

(194) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< cm-field > <column-name>
Description Name of the database column to which the field is mapped.
Value Type token

(195) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< cm-field > <type>
Description Data type of the database table column. (For example, "VARCHAR(20)", "NUMERIC"). Uses the default value if this is not configured. "CLOB" and "BLOB" types can be used with Oracle. The "CLOB" type maps to java.lang.String and "BLOB" maps to a serialized field object.
Value Type token

(196) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< cm-field > <exclude-field>
Description If this is set to true, the accessor methods for the field specified above will not be created in the EJB's concrete bean class. In other words, this field will not be available for the client using the relevant bean. This means that <cmp-field> specified in ejb-jar.xml is ignored. This option is only available for CMP 2.0 entity beans.
Value Type boolean
Default Value false

(197) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <creating-table>
Description Use this to check if a table that the bean uses exists in the database when the bean starts, and then use the existing table, or create a new table and return and error based on the child tag. The checkup proceeds by ensuring whether the name is the same as <schema-info>/<table-name>, whether the fields defined in <schema-info>/<cm-field> exist, and, for beans that manage relations, whether the foreign keys defined in <ejb-relation-map>/<jeus-relationship-role>/<column-map> exist. If the tag does not exist, it is decided whether to check the tables according to the -Djeus.ejb.checktable setting of the JVM settings of the engine container. The default is true, and an exception will occur if the relevant table does not exist when checking the tables at the bean's startup. If this is set to false, the table is not checked when the bean starts. An exception may occur later when the table is used because it does not exist.
Value Type creating-tableType
Child Elements

(199) use-existing-table

(200) force-creating-table

(198) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< creating-table > <use-existing-table>
Description Indicates to use the table with the specified name if it exists and creates it if it does not exist.
Value Type emptyType

(199) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< creating-table > <force-creating-table>
Description Indicates to delete the existing table with a specified name in the database and to recreate it.
Value Type emptyType

(200) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <deleting-table>
Description Use this to delete the named database table when the EJB engine shuts down. This option includes a property that prevents unintended database table deletion. Deletion take seffect when the <creating-table> is configured.
Value Type boolean
Default Value false

(201) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <prim-key-field>
Description All EJB field names used in the primary key in the EJB bean and the row of the database table among <prim-key-class> fields. Only the sub-level <field> needs to be specified. This is only available when <prim-key-class> is defined in ejb-jar.xml. Default Value: By default, the primary key will consist of all public fields in the Prim Key Class setting.
Value Type cm-fieldType
Child Elements

(203) field

(204) column-name

(205) type

(206) exclude-field

(202) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< prim-key-field > <field>
Description Name of a field that is mapped to a database column.
Value Type token

(203) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< prim-key-field > <column-name>
Description Name of the database column to which the field is mapped.
Value Type token

(204) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< prim-key-field > <type>
Description Data type of the database table column. (For example, "VARCHAR(20)", "NUMERIC"). Uses the default value if this is not configured. "CLOB" and "BLOB" types can be used with Oracle. The "CLOB" type maps to java.lang.String and "BLOB" maps to a serialized field object.
Value Type token

(205) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< prim-key-field > <exclude-field>
Description If this is set to true, the accessor methods for the field specified above will not be created in the EJB's concrete bean class. In other words, this field will not be available for the client using the relevant bean. This means that <cmp-field> specified in ejb-jar.xml is ignored. This option is only available for CMP 2.0 entity beans.
Value Type boolean
Default Value false

(206) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <jeus-query>
Description SQL statement for finder methods must be defined for CMP 1.1 entity beans. This overrides EJB-QL in ejb-jar.xml for CMP 2.0. This can use the EJB-QL and JEUS EJB-QL extensions to query methods (findXXX) if JEUS query is configured. This is similar to ejb-jar.xml's <query> tag. The purpose of this tag is easy migration of the BEA WebLogic application server to JEUS 4 Fix#2. This is applied in the same way as <find-method>.
Value Type find-methodType
Child Elements

(208) query-method

(212) sql

(213) include-updates

(207) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< jeus-query > <query-method>
Description Name and parameters of the find method.
Value Type methodParamType
Child Elements

(209) method-name

(210) method-params

(208) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< jeus-query >< query-method > <method-name>
Description Name of the method
Value Type valuableToken

(209) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< jeus-query >< query-method > <method-params>
Description Parameters of the method in order.
Value Type method-paramsType
Child Elements

(211) method-param

(210) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< jeus-query >< query-method >< method-params > <method-param>
Description Fully qualified class name of a method parameter.
Value Type valuableToken

(211) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< jeus-query > <sql>
Description Use this to partially configure the SQL statement for creating the finder method for EJB 1.1. This is not used for EJB 2.0. Use &amp;gt; when using special characters (For example, "<")
Value Type token
Value Description Keyword of the where clause. In an SQL statement, "?"s are replaced by the parameter values when the finder method is called. A number can be inserted after "?" to indicate the order of the parameter. For example, "?1" indicates where the first parameter value is entered. Parameters with numbers after "?" cannot be used along with those without numbers after "?".

(212) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< jeus-query > <include-updates>
Description If this is set to true, updated information can be checked while the finder method is running because the update created while the finder method is called is committed. Default Value: Value configured in <include-update> of <persistence-optimize>.
Value Type boolean

(213) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <db-vendor>
Description Indicates which database will be used to create SQL.
Value Type db-vendorType
Defined Value

oracle

informix

db2

mssql

sybase

hsql

cloudscape

mysql

tibero

(214) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <data-source-name>
Description JNDI name of the database connection pool used to connect to the database. This connection pool is configured using a resource's data source menu and is run by the JEUS server's JVM.
Value Type token
Value Description JNDI name of the JEUS DB connection pool

(215) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info > <auto-key-generator>
Description External source that automatically creates the primary key when calling create() without configuring the primary key. This external source must be a single database that is shared by many EJB engines that need to create a single primary key. The database's primary key value must be unique. The primary key must always be an int type and must be a java.lang.Integer type in beans.
Value Type auto-key-generatorType
Child Elements

(217) generator-type

(218) generator-name

(219) sequence-column

(220) key-cache-size

(216) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< auto-key-generator > <generator-type>
Description Vendor of the database that has the primary key.
Value Type generator-typeType
Defined Value

ORACLE

MSSQL

USER_KEY_TABLE

(217) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< auto-key-generator > <generator-name>
Description Required if USER_KEY_TABLE or Oracle is used. Defines the sequence name when using Oracle, or defines the table name that contains the primary key for USER_KEY_TABLE.
Value Type token
Value Description Enter the sequence name for Oracle or the table name for USER_KEY_TABLE.

(218) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< auto-key-generator > <sequence-column>
Description Column name that has the primary key for USER_KEY_TABLE.
Value Type token
Value Description Column name

(219) < jeus-ejb-dd >< beanlist >< jeus-bean >< schema-info >< auto-key-generator > <key-cache-size>
Description Indicates the size of the key assigned to the EJB engine. The key passed from the primary key database is configured with the value specified here. The key value increases, and this improves performance by reducing how often the primary key is accessed.
Value Type nonNegativeIntType
Value Description Key size that will be assigned to the local EJB engine. For Oracle, this value must be equal to the sequence increment value of the sequence.
Default Value 1

(220) < jeus-ejb-dd >< beanlist >< jeus-bean > <database-insert-delay>
Description Indicates when new EJB data will be stored in the database when EJBs are created. The data can currently be stored in two ways--after the ejbCreate() method is complete or after the ejbPostCreate() method is complete.
Value Type database-insert-delayType
Default Value ejbPostCreate
Defined Value

ejbCreate

ejbPostCreate

(221) < jeus-ejb-dd >< beanlist >< jeus-bean > <cm-persistence-optimize>
Description Properties used to improve the performance of the ejbLoad() and ejbStore() methods created by the EJB engine. This option is only available for CMP entity beans.
Value Type cm-persistence-optimizeType
Child Elements

(223) subengine-type

(224) fetch-size

(225) init-caching

(222) < jeus-ejb-dd >< beanlist >< jeus-bean >< cm-persistence-optimize > <subengine-type>
Description Lock type that ejbLoad uses when it accesses database rows. This can be configured based on the characteristics of the bean, such as if the bean reads more than it writes. For Oracle, this option has the same effect as setting the database isolation level to Serialization if WriteLock is used.
Value Type subengine-typeType
Default Value ReadLocking
Defined Value

ReadLocking

WriteLocking

WriteLockingFind

(223) < jeus-ejb-dd >< beanlist >< jeus-bean >< cm-persistence-optimize > <fetch-size>
Description Number of rows that will be retrieved at once when the database returns a large ResultSet.
Value Type nonNegativeIntType
Default Value 10

(224) < jeus-ejb-dd >< beanlist >< jeus-bean >< cm-persistence-optimize > <init-caching>
Description If this is set to true, the EJB engine initializes the EJB entity bean from the database. This task is executed when the engine starts. If this is set to false, the EJB instance is created using create() and findByPrimaryKey() or home interface methods that have the same functions.
Value Type boolean
Default Value false

(225) < jeus-ejb-dd >< beanlist >< jeus-bean > <enable-instant-ql>
Description Option to indicate that the home interface of the bean implements the JEUS-specific interface ("jeus.ejb.bean.objectbase.EJBInstanceFinder" ). This interface includes the findWithInstantQL(java.lang.String qlSentence) method that allows EJB QL queries to be defined directly in the client's source code. This option can provide a temporary solution for insufficient finder methods. Note that the "qlSentence" string parameter only supports EJB QL statements without parameters, specifically those without "?". This option is only available for CMP entity beans.
Value Type boolean
Default Value false

(226) < jeus-ejb-dd >< beanlist >< jeus-bean > <connection-factory-name>
Description JNDI name of the JMS connection factory that will be used by a message-driven bean (MDB).
Value Type token

(227) < jeus-ejb-dd >< beanlist >< jeus-bean > <mdb-resource-adapter>
Description Resource adapter module and properties for an MDB.
Value Type mdb-resource-adapterType
Child Elements

(229) resource-adapter-module-id

(233) log-xa-recovery-information

(234) activation-config

(228) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter > <resource-adapter-module-id>
Description Name of the resource adapter module that will be connected to the message-driven bean. This value is determined when the relevant resource adapter is deployed, so refer to the resources menu.
Value Type jeusModuleIdType
Child Elements

(230) standalone-module-name

(231) application-name

(232) module-name

(229) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter >< resource-adapter-module-id > <standalone-module-name>
Description Name of the module deployed to JEUS in a standalone mode.
Value Type token

(230) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter >< resource-adapter-module-id > <application-name>
Description Name of the EAR file to which the module belongs.
Value Type token

(231) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter >< resource-adapter-module-id > <module-name>
Description Name of the module that belongs to the EAR file.
Value Type token

(232) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter > <log-xa-recovery-information>
Description Indicates whether logging for XA Recovery will be done in the JCA container if a global transaction is processed while connecting to the message bean. This option must be set to false because XA recovery logging that is performed in the JEUS MQ is duplicated when using JEUS MQ.
Value Type boolean
Default Value true

(233) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter > <activation-config>
Description Use this to record Activation Config that will configure the JMS or the resource adaptor. This option is only available in message-driven beans. This setting overrides the ejb-jar.xml's Activation Config.
Value Type activation-configType
Child Elements

(235) description

(236) activation-config-property

(234) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter >< activation-config > <description>
Description Description of the activation configuration.
Value Type string

(235) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter >< activation-config > <activation-config-property>
Description Properties of the activation configuration.
Value Type activation-config-propertyType
Child Elements

(237) activation-config-property-name

(238) activation-config-property-value

(236) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter >< activation-config >< activation-config-property > <activation-config-property-name>
Description Name of the Activation Config property. For JMS MDBs, acknowledgeMode, messageSelector, destinationType, and subscriptionDurability are usually used.
Value Type token

(237) < jeus-ejb-dd >< beanlist >< jeus-bean >< mdb-resource-adapter >< activation-config >< activation-config-property > <activation-config-property-value>
Description Value for the Activation Config property.
Value Type token

(238) < jeus-ejb-dd >< beanlist >< jeus-bean > <destination>
Description JNDI name of the JMS destination that will be used by an MDB. Refer to "JEUS MQ Guide" and JMS specifications for details.
Value Type token

(239) < jeus-ejb-dd >< beanlist >< jeus-bean > <jndi-spi>
Description Indicates that that an MDB uses a JMS registered in another JNDI naming service, instead of the default value of jeus.jndi.JEUSContextFactory. Use this option to connect a JEUS MDB to IBM MQ or SONIC MQ instead of the JEUS JMS.
Value Type jndi-spiType
Child Elements

(241) mq-vendor

(242) initial-context-factory

(243) provider-url

(240) < jeus-ejb-dd >< beanlist >< jeus-bean >< jndi-spi > <mq-vendor>
Description Name of the MQ/JMS vendor that connects to MDB using the JNDI naming service.
Value Type mq-vendorType
Defined Value

SONICMQ

IBMMQ

(241) < jeus-ejb-dd >< beanlist >< jeus-bean >< jndi-spi > <initial-context-factory>
Description Class name of the initial context factory required to use the JEUS naming service when connecting to the JMS.
Value Type token

(242) < jeus-ejb-dd >< beanlist >< jeus-bean >< jndi-spi > <provider-url>
Description URL and port number used to connect to the JNDI naming service.
Value Type anyURI

(243) < jeus-ejb-dd >< beanlist >< jeus-bean > <max-message>
Description Maximum number of messages that a single session processes concurrently. This is only available for message-driven beans. A session can concurrently process up to the specified number of messages. Additional messages will be handled by other sessions. For details, refer to "JEUS EJB Guide" and JMS specifications.
Value Type nonNegativeIntType
Default Value 10

(244) < jeus-ejb-dd >< beanlist >< jeus-bean > <ack-mode>
Description Indicates whether to use the acknowledge mode for a JMS session within an MDB. For details, refer to "JEUS EJB Guide" and JMS specifications.
Value Type ack-modeType
Default Value Auto-acknowledge
Defined Value

Auto-acknowledge

Dups-ok-acknowledge

(245) < jeus-ejb-dd >< beanlist >< jeus-bean > <durable>
Description Indicates whether to specify an MDB as a JMS durable subscriber. For details, refer to "JEUS EJB Guide" and JMS specifications.
Value Type durableType
Default Value Durable
Defined Value

Durable

NonDurable

(246) < jeus-ejb-dd >< beanlist >< jeus-bean > <msg-selector>
Description Message selector that will be used by an MDB. This option is only available for an MDB. For details, refer to "JEUS EJB Guide" and JMS specifications.
Value Type token

(247) < jeus-ejb-dd >< beanlist >< jeus-bean > <timer-service>
Description Action for the timer of each bean.
Value Type bean-timer-serviceType
Child Elements

(249) support-persistence

(248) < jeus-ejb-dd >< beanlist >< jeus-bean >< timer-service > <support-persistence>
Description Indicates whether the bean timer is persistent.
Value Type boolean
Default Value true

(249) < jeus-ejb-dd > <ejb-relation-map>
Description Defines the relations among CMP 2.0 Entity Beans. This tag exists for each relation defined in ejb-jar.xml.
Value Type ejb-relation-mapType
Child Elements

(251) relation-name

(252) table-name

(253) jeus-relationship-role

(250) < jeus-ejb-dd >< ejb-relation-map > <relation-name>
Description Name of the EJB 2.0 relation defined in ejb-jar.xml.
Value Type token

(251) < jeus-ejb-dd >< ejb-relation-map > <table-name>
Description Name of the junction table that indicates a many-to-many EJB relation.
Value Type token

(252) < jeus-ejb-dd >< ejb-relation-map > <jeus-relationship-role>
Description Use this to define the relation between one EJB and another. Each element indicates a unidirectional relation. Two <jeus-relationship-role> elements are required for a many-to-many relation. Each element maps a foreign key of the junction table to the EJB's actual primary key.
Value Type jeus-relationship-roleType
Child Elements

(254) relationship-role-name

(255) column-map

(253) < jeus-ejb-dd >< ejb-relation-map >< jeus-relationship-role > <relationship-role-name>
Description Name of the relationship role defined in <ejb-relationship-role-name> in ejb-jar.xml.
Value Type token

(254) < jeus-ejb-dd >< ejb-relation-map >< jeus-relationship-role > <column-map>
Description Maps a foreign key of a table with the primary key of another EJB. The resulting relationship is unidirectional. All mappings must be configured if the foreign key or the primary key has combined the use of many columns with EJB fields.
Value Type column-mapType
Child Elements

(256) foreign-key-column

(257) target-primary-key-column

(255) < jeus-ejb-dd >< ejb-relation-map >< jeus-relationship-role >< column-map > <foreign-key-column>
Description Name of the foreign key column in the table of the EJB declared in <column-map>. This key is mapped with the value of the corresponding EJB's primary key DB column defined in the target primary key column. For many-to-many relations, this is the name of foreign key column that exist in the relation table.
Value Type token

(256) < jeus-ejb-dd >< ejb-relation-map >< jeus-relationship-role >< column-map > <target-primary-key-column>
Description Name of the EJB's primary key column that will be mapped to the foreign key column.
Value Type token

(257) < jeus-ejb-dd > <message-destination>
Description Maps the message destination defined in ejb-jar.xml's <message-destination> to the actual destination object registered in JNDI.
Value Type jndi-refType
Child Elements

(259) jndi-info

(258) < jeus-ejb-dd >< message-destination > <jndi-info>
Description Maps the logical name of an environment entry to an actual JNDI name. For example, an environment entry named "jdbc/myDataSource" is mapped to "DataSource1", which is an actual JNDI name.
Value Type jndi-infoType
Child Elements

(260) ref-name

(261) export-name

(259) < jeus-ejb-dd >< message-destination >< jndi-info > <ref-name>
Description Name of a reference.
Value Type valuableToken
Value Description The reference name will be bound to an actual JNDI name. The reference name corresponds to that of the J2EE standard descriptor.

(260) < jeus-ejb-dd >< message-destination >< jndi-info > <export-name>
Description Actual JNDI name defined in the JEUS DD.
Value Type token

(261) < jeus-ejb-dd > <client-view-path>
Description Directory for the EJB component stub classes.
Value Type token

(262) < jeus-ejb-dd > <class-ftp-unit>
Description Indicates whether the EJB module classses are sent to remote servers as JAR files or individual classes.
Value Type class-ftp-unitType
Default Value JAR
Defined Value

JAR

CLASS

(263) < jeus-ejb-dd > <java-security-permission>
Description J2SE permission to grant to an application when JEUS is using J2SE Security.
Value Type securityPermissionType
Child Elements

(265) security-permission-spec

(266) description

(264) < jeus-ejb-dd >< java-security-permission > <security-permission-spec>
Description Security permission specifications in the format for the Java security policy.
Value Type token

(265) < jeus-ejb-dd >< java-security-permission > <description>
Description Description of the security permission configuration.
Value Type token

(266) < jeus-ejb-dd > <batch-thread-pool>
Description Thread pool for running JBatch (JSR-352) applications. If this option is not configured, a container wlil be given the minimum thread pool size for operating a JBatch service.
Value Type dedicated-poolType
Child Elements

(268) min

(269) max

(270) keep-alive-time

(271) queue-size

(272) stuck-thread-handling

(267) < jeus-ejb-dd >< batch-thread-pool > <min>
Description Minimum number of threads in a thread pool.
Value Type nonNegativeIntType
Default Value 0

(268) < jeus-ejb-dd >< batch-thread-pool > <max>
Description Maximum number of threads in a thread pool.
Value Type nonNegativeIntType
Default Value 10

(269) < jeus-ejb-dd >< batch-thread-pool > <keep-alive-time>
Description Keep-alive time for inactive threads. If a thread pool contains more than the maximum number of threads, inactive threads will be automatically removed from the thread pool after the specified period of time. If this option is set to 0, threads will not be removed.
Value Type nonNegativeLongType
Value Description Milliseconds
Default Value 60000

(270) < jeus-ejb-dd >< batch-thread-pool > <queue-size>
Description Size of the queue which stores the application objects processed by a thread pool.
Value Type nonNegativeIntType
Default Value 4096

(271) < jeus-ejb-dd >< batch-thread-pool > <stuck-thread-handling>
Description Option to configure a how to handle a thread when it is occupied by a specific task for longer than specified.
Value Type stuck-thread-handlingType
Child Elements

(273) max-stuck-thread-time

(274) action-on-stuck-thread

(275) stuck-thread-check-period

(276) user-warning-class

(272) < jeus-ejb-dd >< batch-thread-pool >< stuck-thread-handling > <max-stuck-thread-time>
Description Length of time before a thread is identified as stuck.
Value Type nonNegativeLongType
Value Description Milliseconds
Default Value 3600000

(273) < jeus-ejb-dd >< batch-thread-pool >< stuck-thread-handling > <action-on-stuck-thread>
Description Action to take when stuck threads are detected.
Value Type action-on-stuck-threadType
Default Value None
Defined Value

None

Interrupt

IgnoreAndReplace

Warning

(274) < jeus-ejb-dd >< batch-thread-pool >< stuck-thread-handling > <stuck-thread-check-period>
Description Time period during which the status of a stuck thread is checked.
Value Type nonNegativeLongType
Value Description Milliseconds
Default Value 300000

(275) < jeus-ejb-dd >< batch-thread-pool >< stuck-thread-handling > <user-warning-class>
Description If action-on-stuck-thread is set to Warning, the default value for this option is thread dump. However, you can write a class to execute an action you want by configuring this option. The class must implement the jeus.util.pool.Warning interface in jclient.jar. Write the class and then locate it in SERVER_HOME/lib/application of a target server.
Value Type string
Value Description Use a fully Qualifed Class name. Example: test.stuck.UserWarning

(276) < jeus-ejb-dd > <library-ref>
Description Information about a shared library that the application will use.
Value Type library-refType
Child Elements

(278) library-name

(279) specification-version

(282) implementation-version

(285) failon-error

(277) < jeus-ejb-dd >< library-ref > <library-name>
Description Name of the shared library.
Value Type token

(278) < jeus-ejb-dd >< library-ref > <specification-version>
Description Specification version of the shared library.
Value Type library-ref-versionType
Child Elements

(280) value

(281) exact-match

(279) < jeus-ejb-dd >< library-ref >< specification-version > <value>
Description Value of the library version.
Value Type string

(280) < jeus-ejb-dd >< library-ref >< specification-version > <exact-match>
Description Indicates whether the exact match of the version is required.
Value Type boolean
Default Value false

(281) < jeus-ejb-dd >< library-ref > <implementation-version>
Description Implementation version of the shared library.
Value Type library-ref-versionType
Child Elements

(283) value

(284) exact-match

(282) < jeus-ejb-dd >< library-ref >< implementation-version > <value>
Description Value of the library version.
Value Type string

(283) < jeus-ejb-dd >< library-ref >< implementation-version > <exact-match>
Description Indicates whether the exact match of the version is required.
Value Type boolean
Default Value false

(284) < jeus-ejb-dd >< library-ref > <failon-error>
Description Indicates whether deployment will fail if a shared library is not found. The default value is false.
Value Type boolean
Default Value false

19.4. Example File

[Example 19.1] Example File

<?xml version="1.0" encoding="UTF-8"?>
<jeus-ejb-dd xmlns="http://www.tmaxsoft.com/xml/ns/jeus">
    <module-info>
        <role-permission>
            <principal>peter</principal>
            <role>manager</role>
        </role-permission>
    </module-info>

    <beanlist>
        <!-- stateless bean -->
        <jeus-bean>
            <!-- should be equal to ejb-name in ejb-jar.xml -->
            <ejb-name>teller</ejb-name>

            <!-- jndi binding name of remote interface -->
            <export-name>TELLEREJB</export-name>

            <!-- jndi binding name of local interface -->
            <local-export-name>LOCALTELLEREJB</local-export-name>

            <!-- rmi listen port -->
            <export-port>7654</export-port>

            <!-- use only iiop stub/skeleton -->
            <export-iiop>
                <only-iiop>true</only-iiop>
            </export-iiop>

            <!-- use this bean in only one ejb engine -->
            <single-vm-only>true</single-vm-only>

            <!-- if possible, use call by reference -->
            <preferred-call-by-reference>true</preferred-call-by-reference>
            
            <!-- principal name used as the run-as principal for this bean that has specified run-as role name in ejb-jar.xml -->
            <run-as-identity>
                <principal-name>peter</principal-name>
            </run-as-identity>

            <!-- use IIOP/CSI but has meaning only when this ejb-engine is using iiop -->
            <security-interop>
                <integrity-confidentiality>
                    Requires
                </integrity-confidentiality>
                <trust-in-client>Requires</trust-in-client>
                <client-auth>Requires</client-auth>
                <identity-assertion>Supports</identity-assertion>
            </security-interop>

            <!-- jndi name of reference using in this ejb and specified in ejb-jar.xml -->
            <env>
                java.lang.Integer
                <name>minAmount</name>
                <value>100</value>
            </env>
            <ejb-ref>
                <jndi-info>
                    <ref-name>ejb/AccountEJB</ref-name>
                    <export-name>ACCEJB</export-name>
                </jndi-info>
            </ejb-ref>
            <res-ref>
                <jndi-info>
                    <ref-name>jdbc/AccountDB</ref-name>
                    <export-name>ACCOUNTDB</export-name>
                </jndi-info>
            </res-ref>
            <res-env-ref>
                <jndi-info>
                    <ref-name>jms/StockQueue</ref-name>
                    <export-name>STOCKQUEUE</export-name>
                </jndi-info>
            </res-env-ref>

            <!-- maximum of running requests -->
            <thread-max>200</thread-max>

            <!-- foo(java.lang.String,int) is getter method so can be invoked again after fail to invoke it -->
            <clustering>
                <enable-clustering>true</enable-clustering>
                <idempotent-method>
                    <method-name>foo</method-name>
                    <method-params>
                        <method-param>java.lang.String</method-param>
                        <method-param>int</method-param>
                    </method-params>
                </idempotent-method>
            </clustering>

            <!-- does not use rmi directly but via http -->
            <invoke-http>
                <url>/mycontext/RMIHandlerServlet</url>
                <http-port>80</http-port>
            </invoke-http>
        </jeus-bean>

        <!-- statelful bean -->
        <jeus-bean>
            <ejb-name>shoppingcart</ejb-name>
            <export-name>SHOPPINGCARTEJB</export-name>
            
            <!-- ... -->

            <!-- use both bean pool and connection pool -->
            <object-management>
                <pooling-bean>true</pooling-bean>
                <bean-pool>
                    <pool-min>10</pool-min>
                    <pool-max>200</pool-max>
                    <resizing-period>1800000</resizing-period>
                </bean-pool>
                <capacity>2000</capacity>
                <passivation-timeout>10000</passivation-timeout>
                <disconnect-timeout>180000</disconnect-timeout>
            </object-management>

        </jeus-bean>

        <!-- entity bean -->
        <jeus-bean>
            <ejb-name>account</ejb-name>
            <export-name>ACCOUNTEJB</export-name>

            <!-- ... -->
            
            <!-- configuration for optimizing of invocation ejbLoad() and ejbStore() -->
            <persistence-optimize>
                <engine-type>SINGLE_OBJECT</engine-type>
                <non-modifying-method>
                    <method-name>myBusinessMethod</method-name>
                    <method-params>
                        <method-param>java.lang.String</method-param>
                        <method-param>int</method-param>
                        <method-param>double</method-param>
                    </method-params>
                </non-modifying-method>
                <entity-cache-size>100</entity-cache-size>
            </persistence-optimize>

            <!-- mapping bean to db -->
            <schema-info>
                <table-name>ACCOUNT</table-name>
                <cm-field>
                    <field>id</field>
                    <column-name>ID</column-name>
                    NUMERIC
                    <exclude-field>true</exclude-field>
                </cm-field>
                <creating-table>
                    <use-existing-table/>
                </creating-table>
                <deleting-table>true</deleting-table>
                <prim-key-field>
                    <field>id</field>
                </prim-key-field>
                <find-method>
                    <query-method>
                        <method-name>findByAddress</method-name>
                        <method-params>
                            <method-param>java.lang.String</method-param>
                        </method-params>
                    </query-method>
                    <sql>customer_address=?</sql>
                </find-method>
                <db-vendor>oracle</db-vendor>
                <data-source-name>MYDB</data-source-name>
                <auto-key-generator>
                    <generator-type>USER_KEY_TABLE</generator-type>
                    <generator-name>MYKEYTABLE</generator-name>
                    <sequence-column>
                        PRIMARYKEYCOLUMN
                    </sequence-column>
                    <key-cache-size>20</key-cache-size>
                </auto-key-generator>
            </schema-info>

            <!-- configuration for optimizing of invocation ejbLoad() and ejbStore() for only cmp entity bean-->
            <cm-persistence-optimize>
                <subengine-type>WriteLocking</subengine-type>
                <fetch-size>80</fetch-size>
                <init-caching>true</init-caching>
            </cm-persistence-optimize>

        </jeus-bean>

        <!-- ... -->

        <!-- message driven bean -->
        <jeus-bean>
            <ejb-name>order</ejb-name>

            <!-- ... -->

            <!-- jndi name of connection factory using this mdb -->
            <connection-factory-name>jms/QueueConnectionFactory</connection-factory-name>

            <!-- jndi name of JMS destination using this mdb -->
            <destination>MDB_QUEUE</destination>

            <!-- the maximum number of messages -->
            <max-message>20</max-message>

            <!-- this mdb is durable subscriber -->
            <durable>Durable</durable>

            <!-- use another naming server not jeus -->
            <jndi-spi>
                <mq-vendor>SONICMQ</mq-vendor>
                <initial-context-factory>
                    acme.jndi.ACMEContextFactory
                </initial-context-factory>
                <provider-url>
                    protocol://localhost:2345
                </provider-url>
            </jndi-spi>

        </jeus-bean>
    </beanlist>

    <!-- relationships between two entities -->
    <ejb-relation-map>
        <relation-name>bank-account</relation-name>
        <jeus-relationship-role>
            <relationship-role-name>bankHanAccount</relationship-role-name>
            <column-map>
                <foreign-key-column>account-id</foreign-key-column>
                <target-primary-key-column>id</target-primary-key-column>
            </column-map>
        </jeus-relationship-role>
    </ejb-relation-map>

    <!-- setting for JBatch (JSR-352) threadpool resource -->
    <batch-thread-pool>
        <min>10</min>
        <max>20</max>
        <keep-alive-time>20</keep-alive-time>
        <queue-size>4096</queue-size>
    </batch-thread-pool>
</jeus-ejb-dd>

Prev   Next
Chapter 18. Configuring jeus-web-dd.xml Home Chapter 20. Configuring jeus-connector-dd.xml