Red Hat Training

A Red Hat training course is available for JBoss Enterprise SOA Platform

Appendix B. Global Configuration File

B.1. jbossesb-properties.xml

The jbossesb-properties.xml file is the JBoss Enterprise SOA Platform's global configuration file. Many tasks will require you to edit this file. The location of this file varies depending on how the system has been installed. If you have installed a server deployment, this file will be located at SOA_ROOT/jboss-as/server/PROFILE/deployers/esb.deployer/jbossesb-properties.xml, while standalone clients can access it directly through the class-path.

B.2. Global Configuration File Reference

The global configuration file (SOA_ROOT/jboss-as/server/PROFILE/deployers/esb.deployer/jbossesb-properties.xml) is split into sections, each concerned with a specific area of configuration. A named property section contains one or more properties which are used to configure the behavior of the ESB, and one property section can "depend" on another section - the dependency specifies which sections are loaded by the PropertyManager first.

core

  • org.jboss.soa.esb.jndi.server.context.factory : The JNDI Server initial context factory.
  • org.jboss.soa.esb.jndi.server.url : The JNDI Server URL.
  • org.jboss.soa.esb.loadbalancer.policy : The ESB load balancer policy.
  • org.jboss.soa.esb.mime.text.types : A semicolon-separated list of MIME types that are used to decide whether the payload can be decoded or whether it will remain as a byte array.
  • jboss.esb.invm.scope.default : The default InVM scope for an ESB deployment.
  • org.jboss.soa.esb.deployment.schema.validation : A true/false flag to enable JBoss ESB schema validation upon deployment.

Important

The org.jboss.soa.esb.jndi.server.type and org.jboss.soa.esb.persistence.connection.factory properties within core are now obsolete.

security

  • org.jboss.soa.esb.services.security.implementationClass : The concrete SecurityService implementation to be used.
  • org.jboss.soa.esb.services.security.callbackHandler : The default callback handler implementation.
  • org.jboss.soa.esb.services.security.sealAlgorithm : The algorithm to be used when sealing the SecurityContext.
  • org.jboss.soa.esb.services.security.sealKeySize : The size of the key to be used to encrypt/decrypt the SecurityContext.
  • org.jboss.soa.esb.services.security.contextTimeout : The amount of time for which SecurityContext is valid.
  • org.jboss.soa.esb.services.security.contextPropagatorImplementationClass : Used to configure a global SecurityContextPropagator.
  • org.jboss.soa.esb.services.security.publicKeystore : Keystore to encrypt and decrypt data external to the ESB.
  • org.jboss.soa.esb.services.security.publicKeystorePassword : The keystore password.
  • org.jboss.soa.esb.services.security.publicKeyAlias : The public key alias to use.
  • org.jboss.soa.esb.services.security.publicKeyPassword : The public key password to use.
  • org.jboss.soa.esb.services.security.publicKeyTransformation : The cipher transformation to use.

registry

  • org.jboss.soa.esb.registry.queryManagerURI : The registry query manager URI, which is used to obtain information on services and bindings.
  • org.jboss.soa.esb.registry.lifeCycleManagerURI : The registry lifecycle manager URI, which is used to publish information on services and bindings.
  • org.jboss.soa.esb.registry.securityManagerURI : The registry security manager URI, which is used to authenticate queries to the registry.
  • org.jboss.soa.esb.registry.implementationClass : The JBoss ESB registry implementation class. The JAXR registry implementation is used here.
  • org.jboss.soa.esb.registry.factoryClass : The registry factory class, which specifies which JAXR implementation should be used.
  • org.jboss.soa.esb.registry.user : The registry user.
  • org.jboss.soa.esb.registry.password : The registry password.
  • org.jboss.soa.esb.scout.proxy.transportClass The Scout transport class which defines which transport should be used to communicate with the UDDI registry.
  • org.jboss.soa.esb.scout.proxy.uddiVersion : The Scout UDDI Version. This is an Apache Scout-specific setting.
  • org.jboss.soa.esb.scout.proxy.uddiNameSpace : The Scout UDDI namespace. This is an Apache Scout-specific setting.
  • org.jboss.soa.esb.registry.interceptors : The registry interceptor class names.
  • org.jboss.soa.esb.registry.cache.maxSize : The maximum cache size for the caching registry.
  • org.jboss.soa.esb.registry.cache.validityPeriod : The validity period for the caching registry.
  • org.jboss.soa.esb.registry.orgCategory : The UDDI organization value to use - note that this is a UDDI-specific value.

transports

  • org.jboss.soa.esb.mail.smtp.host : The host name of the SMTP server.
  • org.jboss.soa.esb.mail.smtp.user : The username to use for the SMTP server.
  • org.jboss.soa.esb.mail.smtp.password : The password for the user specified on the SMTP server.
  • org.jboss.soa.esb.mail.smtp.port : The port number of the SMTP server.
  • org.jboss.soa.esb.mail.smtp.auth : Flag which specifies whether to authenticate the user against the SMTP server using the AUTH command.
  • org.jboss.soa.esb.ftp.localdir : FTP local directory.
  • org.jboss.soa.esb.ftp.remotedir : FTP remote directory.
  • org.jboss.soa.esb.ftp.timeout : FTP timeout in milliseconds for opening a socket.
  • org.jboss.soa.esb.ftp.timeout.data : FTP timeout in milliseconds for the data connection.
  • org.jboss.soa.esb.ftp.timeout.so : FTP timeout in milliseconds used for currently open sockets.
  • org.jboss.soa.esb.ftp.timeout.default : FTP timeout in milliseconds which sets the default timeout.
  • org.jboss.soa.esb.jms.connectionPool : Size of the ESB JMS connection pool.
  • org.jboss.soa.esb.jms.sessionSleep : If a JMS session cannot be obtained, the ESB will keep trying to obtain one. The sessionSleep property decides how long the ESB will try for.
  • org.jboss.soa.esb.invm.expiryTime : The expiry time for messages in the InVM temporary transport.
  • org.jboss.soa.esb.invm.retry.limit : Maximum number of times to retry redelivery. The default is 5.
  • org.jboss.soa.esb.ws.returnStackTrace : True/false flag that determines whether to return stack traces upon fault of SOAP messages.
  • org.jboss.soa.esb.ws.timeout : Service invoker timeout for delivering SOAP messages within RequestResponseBaseWebService.
  • org.jboss.soa.esb.aggregator.setOnProperties : Aggregate on properties of the message rather than on Context.

jca

  • org.jboss.soa.esb.jca.activation.mapper.jms-ra.rar : Specifies the ActivationMapper globally.
  • org.jboss.soa.esb.jca.activation.mapper.wmq.jmsra.rar : Specifies the ActivationMapper globally.

dbstore

  • org.jboss.soa.esb.persistence.db.conn.manager : Connection Manager implementation class name.
  • org.jboss.soa.esb.persistence.db.datasource.name : Datasource name, only used if using the J2EE connection manager.
  • org.jboss.soa.esb.persistence.db.connection.url : The JDBC connection URL.
  • org.jboss.soa.esb.persistence.db.jdbc.driver : The JDBC driver class.
  • org.jboss.soa.esb.persistence.db.user : The database user.
  • org.jboss.soa.esb.persistence.db.pwd : The database password.
  • org.jboss.soa.esb.persistence.db.pool.initial.size : The initial number of database connections.
  • org.jboss.soa.esb.persistence.db.min.size : The minimum number of database connections.
  • org.jboss.soa.esb.persistence.db.max.size : The maximum number of database connections.
  • org.jboss.soa.esb.persistence.db.pool.test.table : A table name to query for validity of the database connection.
  • org.jboss.soa.esb.persistence.db.pool.timeout.millis : Timeout in milliseconds of the database connections.

filters

  • org.jboss.soa.esb.filter.1, org.jboss.soa.esb.filter.2, org.jboss.soa.esb.filter.3, etc.

rules

  • org.jboss.soa.esb.services.rules.resource.scanner.interval : Defines the polling interval for DRL changes globally across all KnowledgeAgents.
  • org.jboss.soa.esb.services.rules.continueState : Setting this property will enable legacy behaviour and not dispose of working memories during stateful rule execution.

Important

The message routing properties (org.jboss.soa.esb.routing.cbrClass) are obsolete but may still exist in some files.