Each JRun server has a SERVER-INF/jrun.xml file, which contains server-specific configuration information. In general, you do not need to modify the jrun.xml file directly. The JMC contains most of the functionality necessary to configure and customize JRun. However, there are situations that require that you modify jrun.xml manually. For example, to use method timing, you modify settings in the Instrumentation service. For more information on method timing, see JRun Programmer's Guide.
The following table lists the services defined in the jrun.xml file:
Service
Description
JRunServer
Wraps all other jrun.xml elements.
ClusterManager
Facilitates service clustering, and encapsulates the JINI lookup service.
JRunRMIBroker
Creates a common RMI Broker for use in all JRun remote communications. This is a clusterable service.
JRunTransactionService
Starts the transaction manager.
LicenseService
Manages JRun licensing.
MetricsService
Manages metrics collection and logging.
SchedulerService
Creates the scheduler.
LoggerService
Manages JRun logging facilities. Includes the following nested services:
ThreadedLogEventHandler
FileLogEventHandler
ConsoleLogEventHandler
JRunSecurityManagerService
Manages JRun runtime security.
JRunUserManagerService
Provides user-store management.
ResourceService
Handles file resources.
ServletEngineService
Establishes the JRun servlet engine. Includes the SessionIDGeneratorService.
JRunJMS
Provides settings for the JMS provider used with JRun. Includes the following nested services:
JMSSecurityManager
JMSAdapter
JMSServiceWrapper
MailService
Specifies defaults for mail settings in SERVER-INF/jrun-resources.xml.
ResourceDeployer
Deploys data sources, JMS connection factories, JMS destinations, and resource adapters, as defined in jrun-resources.xml.
XDocletService
Automates XDoclet generation of EJB interfaces and EJB, servlet, and custom tag deployment descriptors.
DeployerService
Settings for component deployment. Includes the following nested services, which are used for specialized deployment situations:
RI enterprise application factory
JRun 3.x EJB container factory
JRun 3.x enterprise application factory
WebService
Manages the JRun web server (JWS).
SSLService
Manages SSL for the JWS.
ProxyService
Manages web server connector settings.
InstrumentationService
Manages method timing.
HTMLAgentService
Controls the HTML Adapter for the JMX agent. You can use this facility to view JRun server settings from a browser.
JRunAdminService
Facilitates remote access to a JRun server.
The sections following the discussion of editing the jrun.xml file explain the elements used by these services.
Editing the jrun.xml file
The jrun.xml file has a simple XML format that uses the following elements:
jrun-server Top-level element. Wraps all other elements in the jrun.xml file.
service Defines a service. Accepts the following parameters:
class Specifies the fully qualified name of the class that JRun invokes when managing the service.
name Specifies the name that JRun and other services use to manage and access the service.
service Specifies an embedded service. An embedded service includes class and name parameters and can accept attributes. For examples of embedded services, see the jrun.xml file.
attribute Specifies service attributes that JRun initializes at server startup time.
The following example shows the service and attribute elements for the JRunSecurityManager service:
Although you can manage certain jrun.xml attributes through the JMC, you typically use a text editor to modify attributes in the jrun.xml file. You can also use the HTMLAgentService, which is explained in "HTMLAgentService".
The remainder of this section discusses the services and attributes defined in the jrun.xml file.
Attributes common to all services
The following table lists the attributes available in all JRun services:
Attribute
Description
BindToJNDI
Determines whether the service is accessible through JNDI.
Deactivated
Determines whether the server is running. The default is false. When deactivated is set to false, JRun calls the service's init method, but does not call the start method.
DomainName
Specifies the parent service. Top-level services are in DefaultDomain.
JRunService
Contains a reference to the current object instance.
Logger
Maintains a reference to jrunx.logger.Logger. Clients can lookup this service and call the getLogger method to obtain a reference to the JRun logger.
Name
Specifies the service name.
ParentService
Specifies the class name of the parent service.
ServerName
Specifies the server name.
Status
Specifies the server status. For more information on the constants for this value, see the jrunx.kernel.Service JavaDocs.
JRunServer
The JRunServer service defines server attributes and includes subservices that define clustering functionality. This service accepts the following attributes:
Attribute
Description
ProductBuildNumber
Specifies the build number.
ProductName
Specifies the product name. The default is JRun Application Server.
ProductVendorName
Specifies the vendor name. The default is Macromedia.
ProductVendorUrl
Specifies the URL for the vendor. The default is http://www.macromedia.com.
ProductVersion
Specifies the version number.
RootDirectory
Specifies the JRun root directory.
ServerRootDirectory
Specifies the server root directory.
ClusterManager
The ClusterManager service facilitates service clustering, and encapsulates the JINI lookup service. For nonclustered usage, disable this service by setting the enabled attribute to false. You cannot comment out this service. Instead, set the enabled attribute to false.
Note: If you enable clustering, the server computer must be on a network.
This service accepts the following attributes:
Attribute
Description
ClusterDomain
Specifies the cluster name.
ClusteredHostAddresses
Specifies a list of hosts containing JRun servers in the cluster.
ClusteredServerNames
Specifies the names of the JRun servers in the cluster.
Locators
Specifies locators for this service.
TemporaryDirectory
Specifies the temporary directory of the JRun server.
UnicastPeer
Specifies JRun servers in the cluster that are outside of the subnet. JRun automatically locates servers on the same subnet but requires a unicastPeer specification for JRun servers outside of the subnet.
ClusterDeployerService
The ClusterDeployer service manages automatic deployment across the JRun servers in a cluster.
This service accepts the following attributes:
Attribute
Description
ContextRoot
Specifies the context root.
DeployDirectory
Specifies the location of the directory under which applications are automatically deployed across all JRun servers in the cluster.
HotDeploy
Indicates whether hot deploy is enabled. Specify true or false. The default is false.
PollFrequency
Specifies the frequency with which this service looks for changes. This value is specified in seconds. The default is 10 seconds.
NamingService
The NamingService manages JNDI clustering across the JRun servers in a cluster.
This service accepts the following attributes:
Attribute
Description
JRMPPort
Specifies the JRMP port.
OrbPort
Specifies the ORB port. The default is 900.
Port
Specifies the JNDI port. Remote clients access the JRun server by looking up the hostname:jndi-port combination.
UsingCORBA
Indicates whether the JRun server is using CORBA. Specify true or false. The default is false.
JRunRMIBroker
The JRunRMIBroker service creates a common RMI broker for use by all JRun remote communications. It is a clusterable service. For more information on clustering, see Chapter 3, "Clustering".
This service accepts the following attributes:
Attribute
Description
ClientSocketFactory
Specifies the client socket factory.
ClientSocketFactoryClass
Specifies the class of the client socket factory.
ClusterAlgorithm
Specifies the load-balancing algorithm. The default is jrunx.cluster.RoundRobinAlgorithm. You can also specify jrunx.cluster.StickyRoundRobinAlgorithm and jrunx.cluster.BuddyAlgorithm.
Port
Specifies the port for this service. You typically specify 0, which causes JRun to pick a random port at runtime.
ServerSocketFactoryClass
Specifies the class of the server socket factory.
JRunTransactionService
The JRunTransactionService starts the distributed transaction managers.
You can look up the default transaction manager under java:/TransactionManager. You can look up the default user transaction under java:/UserTransaction. Any domain-specific transaction manager and user transactions can be found under the following JNDI bindings:
java:{txDomainName}/TransactionManager
java:[txDomainName]/UserTransaction
Resources are assigned a domain using the transactionDomain element in jrun-resources.xml, and EJBs are assigned a domain using the same element in jrun-ejb-jar.xml. JRun uses the default transaction domain if the transactionDomain element does not exist.
This service accepts the following attributes:
Attribute
Description
TransactionDomain
Specifies the transaction domain.
TransactionManager
Specifies the transaction manager class. The default is jrunx.tyrex.tm.impl.TransactionManagerImpl.
UserTransaction
Specifies the user transaction service.
DefaultDomain
The DefaultDomain service manages the default transaction domain.
This service accepts the following attributes:
Attribute
Description
ClusterEnabled
Indicates whether transaction support is enabled for clustering. Specify true or false. The default is false. To enable transaction propagation across a cluster, set this to true.
Maximum
Specifies the maximum number of transactions.
TXDomainName
Specifies the transaction domain name (DefaultDomain).
Timeout
Specifies the transaction timeout interval, in seconds. The default is 30 seconds.
WaitTime
Specifies the transaction wait time.
LicenseService
The LicenseService manages JRun licensing.
This service accepts the following attributes:
Attribute
Description
Edition
Specifies the JRun edition.
EvalDays
Specifies the original number of evaluation days.
EvalDaysLeft
Specifies the remaining evaluation days.
ExpirationDate
Specifies the expiration date.
Expired
Indicates whether the evaluation license has expired.
LastWarningMessage
Specifies the last warning message.
LicenseEvaluation
Specifies the license evaluation number.
LicenseKey
Specifies the evaluation license key.
MajorVersion
Specifies the major version.
MaxConcurrency
Specifies concurrency limits.
Upgrade
Indicates whether this is an upgrade license.
Valid
Indicates whether the installation is using a valid license.
MetricsService
The MetricsService manages the collection of statistics for use by the metrics logger. For more information, see Chapter 7, "Connection Monitoring".
This service accepts the following attributes:
Attribute
Description
HistorySize
Specifies the size of the metrics history buffer.
InitialSize
Specifies the initial size of the metrics array.
MetricsService
Contains a reference to the current object instance.
SchedulerService
The SchedulerService is used for scheduling and running all internal tasks in background threads, including session timeouts, file logging, metrics logging, and JDBC connection pool management.
This service accepts the following attributes:
Attribute
Description
ActiveHandlerThreads
Specifies the number of active handler threads for the thread pool.
MaxHandlerThreads
Specifies the maximum number of handler threads for the thread pool.
MinHandlerThreads
Specifies the minimum number of handler threads for the thread pool.
LoggerService
The LoggerService manages all JRun logging facilities. You typically use the JMC to establish log settings. However, you can also set these attributes manually in the jrun.xml file.
This section describes the LoggerService subservices, as follows:
Specifies whether debug-level messages are logged.
ErrorEnabled
Specifies whether error messages are logged. Enabling this attribute causes large volumes of log output. Do not enable this attribute for production JRun servers.
Format
Sets the format of logging messages. You can use the following components to define the message format:
{date} The current date in the format yyyyMMdd.
{date <format>} The format for the current date. For a description of the legal values, see the JavaDocs for java.text.SimpleDateFormat.
{day} The day of the month, a two-digit number in the range 01-31.
{month} The month of the year, a two-digit number in the range 01-12.
{year} The year, a four-digit number.
{hour} The hour of the day, a two-digit number in the range 00-23.
{julian} The current Julian date.
{thread.name} The current thread name.
{thread.hashcode} The current thread hashcode.
{thread.id} The current thread ID, which is the hashcode in an eight-character hexadecimal format.
{log.level} The log event type (debug, error, info, warning).
{log.name} The name of the JRun service that generated the log message. By default, this name is enclosed within parentheses.
{log.message} The log event message.
{log.exception} The exception stack trace.
{log.logger.className} The class name (excluding package) where the log event originated.
{log.logger.fullClassName} The full class name (including package) where the log event originated.
{log.logger.methodName} The method name where the log event originated.
{log.logger.sourceFile} The name of the source file where the log event originated.
{log.logger.line} The line number where the log event originated.
InfoEnabled
Specifies whether info-level messages are logged.
LoggerService
Contains a reference to the current object instance.
MetricsEnabled
Specifies whether metrics messages are logged. Use this attribute with care in a production JRun server. For more information on metrics logging, see Chapter 7, "Connection Monitoring".
WarningEnabled
Specifies whether warning-level messages are logged.
MetricsLogFrequency
Specifies the frequency with which JRun writes statistics to the log when metrics logging is enabled, in seconds.
This service contains subservices that define the file logger and the console logger. It contains no attributes.
File logger attributes
This section describes how to configure a file writer. A file writer takes an event and writes it to a file. You typically set these attributes through the JMC. By default, this service is defined within the threaded logger service, which enables the service to maximize performance by offloading log processing to a separate thread. You can also define this service directly within the logger service, but will lose the performance advantages of the threaded logger.
This service accepts the following attributes:
Attribute
Description
CloseDelay
The number of milliseconds JRun waits before closing the log file when JRun shuts down. JRun closes the log file after the specified number of milliseconds passes with no other messages written to the file. The default is 5000 (5 seconds). Setting this attribute to 0 causes the file to be closed after every write (not recommended).
DeleteOnExit
Specifies whether to delete the log file when JRun shuts down. Specify true or false. The default is false.
FileSize
Specifies the file size.
Filename
The name of the destination file for all events written by this file logger. You can use the {jrun.rootdir} and {jrun.server.name} variables to specify the JRun root directory and JRun server name. The default name is {jrun.rootdir}/logs/{jrun.server.name}-event.log.
A log file heading that appears at the beginning of the log file when JRun writes to the file for the first time. Headings can contain any text, including dynamic values such as timestamps.
RotationFiles
The number of rotation files that JRun retains. For example, if you set rotationFiles to 2, the logging mechanism keeps the log file and two log rotation files for the log writer. When an event causes a log file to exceed its rotation size, if two log rotation files already exist, the oldest log file is deleted and a new one is created.
The installation default value is 3.
RotationSize
The maximum size of the log file, in bytes, before rotation. When a file is rotated, the logging mechanism stops writing to the current log file and creates a new log file. All new events are written to the new log file. This attribute lets you control the maximum size of your log files.
The default value of rotationSize is 200000. You can specify the size in bytes, kilobytes (for example, 10k), or megabytes (for example, 10m).
Console logger attribute
This section describes how to configure a console writer. A screen writer takes an event and writes it to standard output, which typically corresponds to your monitor. For more information, see "Using the console writer".
This service accepts the following attribute:
Attribute
Description
Format
The format of logging messages. For more information, see "LoggerService".
By default, this service is defined within the threaded logger, which enables the service to maximize performance by offloading log processing to a separate thread. You can also define this service directly within the logger service, but will lose the performance advantages of the threaded logger.
JRunSecurityManager
This section specifies the attributes used to configure the JRun security mechanism
This service accepts the following attributes:
Attribute
Description
AuthConfig
Specifies the name of the auth.config file used by the security manager. The auth.config file defines the login module and login module parameters for the security domain and role domain, as specified in the securityDomain and roleMappingDomain attributes.
JRunSecurityManager
Contains a reference to the current object instance.
RoleMappingDomain
Specifies the name of the auth.config section that contains definitions of login modules for roles. The default is defaultRole.
SecurityDomain
Specifies the name of the auth.config section that contains definitions of login modules for users. The default is defaultUser.
TrustedHost
Specifies a trusted hosts. You can specify this attribute multiple times to specify multiple trusted hosts.
JRunUserManager
This section specifies the attributes used to configure the JRun user manager mechanism. The user manager is a mechanism for dynamically updating the security store for users and roles.
This service accepts the following attribute:
Attribute
Description
SecurityStore
Specifies the location of the user and role store. The default is SERVER-INF/jrun-users.xml.
ResourceService
The ResourceService handles file resources.
This service accepts the following attributes:
Attribute
Description
ResourceCacheSize
Specifies the size of the internal buffer used to cache static resources.
ResourceCheckInterval
Specifies the number of milliseconds between checks for changes in cached resource.
ServletEngineService
The ServletEngineService contains settings for the JRun servlet container.
This service accepts the following attributes:
Attribute
Description
DefaultLocale
Specifies the default locale. The default is en_US.
MimeMapping
Specifies MIME type mappings.
MimeTypesPath
Specifies the file that contains MIME type definitions, which control what Internet media types are sent to the client for specified file extensions. The default location is /lib/mime.types.
ServletCheckInterval
Specifies the servlet check interval. The default is 1500 milliseconds.
ServletEngine
Contains a reference to the current object instance.
The ServletEngineService also includes the SessionIdGenerator subservice, which accepts default attributes only.
JRunJMS
The JRunJMS service includes the following subservices:
The JMSSecurityManager subservice starts the JMS SecurityManager.
This subservice accepts default attributes only.
JMSAdapter
The JMSAdapter subservice starts the JMS provider.
This subservice accepts the following attributes:
Attribute
Description
ClassPath
Specifies the classpath for the JMS adapter.
ConfigFileName
Specifies the name of the JMS provider's configuration file. For the default JRun JMS adapter, this is typically jrun-jms.xml. For SonicMQ, this is typically broker.ini.
HomeDir
Specifies the home directory of the JMS provider. This is not typically required for the JRun JMS adapter. For SonicMQ, this specifies an absolute path to the SonicMQ directory.
ProviderName
Specifies the provider name.
ProviderVersion
Specifies the provider version.
For information on the attributes used when SonicMQ is the JMS provider, see "Using SonicMQ".
JMSServiceWrapper
The JMSServiceWrapper subservice provides JMS access for J2EE clients.
Specifies whether the remote or local adapter is used by the wrapper. Specify remote or local. For more information, see "Using JMS in a clustered environment".
DefaultQCFName
Specifies the name of the default QueueConnectionFactory. The default is QueueConnectionFactory.
DefaultTCFName
Specifies the name of the default TopicConnectionFactory. The default is TopicConnectionFactory.
DefaultTransport
Specifies the default transport mechanism. The default for the built-in JRun JMS provider is RMI.
DefaultXAQCFName
Specifies the name of an XA-compliant QueueConnectionFactory. There is no default.
DefaultXATCFName
Specifies the name of an XA-compliant TopicConnectionFactory. There is no default.
The MailService specifies defaults for the JavaMail settings in a JRun server's jrun-resources.xml file.
This service accepts the following attribute:
Attribute
Description
MailSessionDefaults
Includes sub-attributes for JavaMail settings. For more information on each attribute, see "JavaMail".
ResourceDeployer
The ResourceDeployer service deploys data sources, connection pools and JMS connection factories from jrun-resources.xml.
This service accepts the following attributes:
Attribute
Description
ConnectionFactoryNames
Specifies connection factories.
DestinationNames
Specifies queue and topic names.
MailSessionNames
Specifies mail session names.
XDocletService
The XDoclet service controls the automatic generation of EJB interfaces and deployment descriptors for servlets, custom tags, and EJBs.
This service accepts the following attributes:
Attribute
Description
AntMessageLevel
Specifies the granularity of messages generated by the XDoclet ant-based build process. Valid values are as follows:
quiet (default)
standard
verbose
debug
EjbSourceFiles
Specifies the suffix pattern for which JRun generates EJB interfaces and deployment descriptor entries. Any Java source file with this suffix in a watched EJB directory is considered an enterprise bean with comments that XDoclet can use to create the EJBHome, EJBObject, ejb-jar.xml, and jrun-ejb-jar.xml files. The default is *Bean.java. Specify this element once for each directory.
PollFrequency
The interval at which xdoclet re-examines its sources.
WarSourceFileList
Displays the list of WAR source files, specified in WarSourceFiles attributes.
WarSourceFiles
Specifies the suffix patterns for which JRun generates deployment descriptor entries for servlets, custom tags, and servlet filters. Any Java source file with one of these suffixes in a watched WAR directory contains comments that XDoclet can use to create appropriate deployment descriptor elements. The defaults are *Servlet.java, *Tag.java, and *Filter.java. Specify this element once for each directory.
WatchedEJBDirectory
Specifies a directory for which JRun automatically generates EJB interfaces and deployment descriptors based on XDoclet-style comments.
WatchedEJBDirectoryList
Displays the list of EJB directories, specified in WatchedEJBDirectory attributes.
WatchedWARDirectory
Specifies a directory for which JRun automatically generates servlet and custom tag deployment descriptor entries based on XDoclet-style comments.
WatchedWARDirectoryList
Displays the list of WAR directories, specified in WatchedWARDirectory attributes.
WebLogicExport
Specify true to generate WebLogic-specific deployment descriptors.
WebSphereExport
Specify true to generate WebSphere-specific deployment descriptors.
DeployerService
The DeployerService handles deployment for all types of J2EE components, including web applications, EJBs, resource adapters, and enterprise applications.
This service accepts the following attributes:
Attribute
Description
ClientSocketFactory
Specifies the client socket factory.
ClientSocketFactoryClass
Specifies the class of the client socket factory.
ClusterAlgorithm
Specifies the load-balancing algorithm. The default is jrunx.cluster.RoundRobinAlgorithm. You can also specify jrunx.cluster.StickyRoundRobinAlgorithm and jrunx.cluster.BuddyAlgorithm.
DeployDirectory
Specifies a directory for which JRun automatically deploys applications when hot deploy is enabled. You can specify this element multiple times.
DeployDirectoryList
Specifies deploy directories for the JRun server.
DeployedURLs
Lists URLs for applications deployed on the JRun server.
EARs
Lists enterprise applications deployed on the JRun server.
EJBs
Lists EJBs deployed on the JRun server.
File
Specifies WAR, EAR, JAR, and RAR files that the JRun deploys at system startup. You can specify this element multiple times.
HotDeploy
Specifies whether hot deploy is enabled. Specify true or false. The default is true.
PersistXML
Specifies whether the JRun deployer automatically creates JRun-specific deployment descriptors (such as jrun-ejb-jar.xml). Specify true or false. The default is false.
PollFrequency
Specifies the frequency with which this service looks for changes. The default is 5 seconds.
RARs
Lists resource adapters deployed on the JRun server.
TemporaryDirectory
Specifies the temporary directory into which JRun deploys applications.
Url
Specifies a list of URLs.
ValidateXML
Specifies whether the deployer validates the XML in deployment descriptors.
WARs
Lists web applications deployed on the JRun server.
Server-specific deployers
In addition to the default DeployerService, JRun provides a variety of server-specific deployers, which let you deploy applications written for other J2EE application servers to JRun. JRun supports the following application-server-specific deployers:
J2EE reference implementation deployer (EJB, WAR, and EAR)
JRun 3.1 deployer (EJB, WAR, and EAR)
The deployer recognizes server-specific applications by scanning for server-specific deployment files. For example, if the deployer finds a {warFileName}.runtime.xml file, it assumes a J2EE reference implementation web application and uses the appropriate deployer. To be identified, the deployer requires that an application contain a required file, such as META-INF/ejb-jar.xml (referred to as a mandatoryFingerPrint) and at least one other descriptor, such as {earFileName}_ejb.runtime.xml (referred to as a potentialFingerPrint).
If you set the PersistXML attribute to true, the deployer converts the server-specific deployment descriptor to a JRun-specific deployment descriptor.
Server-specific deployers accept the following attributes:
Attribute
Description
IIOP
Specifies whether IIOP is enabled. Specify true or false. The default is false.
MandatoryFingerPrint
Specifies the name of a file that is required to identify an application. The combination of MandatoryFingerPrint and PotentialFingerPrint identifies an application server.
MandatoryFingerPrintList
Specifies a list of all mandatory fingerprints.
PersistXML
Specifies whether the JRun deployer automatically creates JRun-specific deployment descriptors (such as jrun-ejb-jar.xml). Specify true or false. The default is false.
PotentialFingerPrint
Specifies the name of a file that is required to identify an application. You typically specify this element multiple times, and JRun must find one in order to identify an application server. The combination of MandatoryFingerPrint and PotentialFingerPrint identifies an application server.
PotentialFingerPrintList
Specifies a list of all potential fingerprints.
TemporaryDirectory
Specifies the temporary directory into which JRun deploys applications.
ValidateXML
Specifies whether the deployer validates the XML in deployment descriptors.
WebService
The WebService controls the JRun web server (JWS).
Note: If your production environment does not use the JWS, you should disable this service by setting the deactivated attribute to true.
This service accepts the following attributes:
Attribute
Description
ActiveHandlerThreads
Indicates the current number of active handler threads.
Backlog
Specifies the maximum length of the queue of pending connections. If this value is SOMAXCONN (in Winsock it's 5, Winsock 2 it's 2^31), then the underlying service provider responsible for sockets will set the backlog to a provider-specific default maximum value.
BindAddress
Specifies the bind address for the JWS. The default is *, which
Interface
Corresponds to the External Web Server Address field in the JMC. It allows you to restrict which Web servers can connect to JRun. The default is all Web servers (*). The JRun server accepts requests only from Web servers that match the interface attribute. Separate multiple web servers with | (for example 10.64.7.106|10.64.7.102).
KeepAlive
Specifies whether the JWS sets the keep-alive HTTP header. Specify true or false. The default is false.
MaxHandlerThreads
Specifies the maximum number of active handler threads.
MinHandlerThreads
Specifies the minimum number of active handler threads.
Port
Specifies the port used by the JWS.
SocketFactoryName
Specifies the socket factory class.
Timeout
Specifies the JWS timeout, in seconds. The default is 300.
Specifies the name of the JRun key store. The default is {jrun.rootdir}/lib/keystore.
KeyStorePassword
Specifies the keystore password. It must be at least six characters long and is case-sensitive.
Port
Specifies the SSL port for the JWS.
SocketFactoryName
Specifies the socket factory name for JWS SSL. The default is jrun.servlet.http.JRunSSLServerSocketFactory.
TrustStore
Specifies the name of the JRun trust store. The default is {jrun.rootdir}/lib/truststore.
ProxyService
The ProxyService section of each JRun server's jrun.xml file contains attributes that control the JRun web server connector. These attributes, which you typically administer through the JMC, are described in the following table:
Attribute
Description
ActiveHandlerThreads
Indicates the current number of active handler threads.
Backlog
Specifies the maximum length of the queue of pending connections. If this value is SOMAXCONN (in Winsock it's 5, Winsock 2 it's 2^31), then the underlying service provider responsible for sockets will set the backlog to a provider-specific default maximum value.
bindaddress
Corresponds to the Web Server IP field in the JMC. It specifies the address of the JRun server that will listen for external web servers. The default is *. When JRun and the web server are on the same computer, it is set to the default.
interface
Corresponds to the IP Filter List field in the JMC. It lets you restrict which web servers can connect to JRun. The default is 127.0.0.1. The JRun server accepts requests only from web servers that match the interface attribute. Separate multiple web servers with | (for example 10.64.7.106|10.64.7.102). Specify * to accept requests from all web servers.
KeyStore
Specifies the location of the keystore.
KeyStorePassword
Specifies the keystore password.
LoadBalancingAlgorithm
Specifies the load balancing algorithm.
MaxHandlerThreads
Specifies the maximum number of active handler threads.
MinHandlerThreads
Specifies the minimum number of active handler threads.
Port
Corresponds to the Listening Port field in the JMC. It specifies the port that the JRun server listens on for connections from external Web servers.
ServerWeight
Specifies the relative weight of the JRun server when using the weighted round-robin and random weighted load-balancing algorithms.
SocketFactoryName
Specifies the socket factory class.
StickySessions
Indicates whether the web server connector detects if a request has an existing session and automatically routes that request to the original JRun server.
Timeout
Specifies the socket read timeout.
TrustStore
Specifies the location of the trust store.
Note: If the SocketFactoryName is set to jrun.servlet.jrpp.JRunProxySSLServerSocketFactory and KeyStore, KeyStorePassword, and TrustStore are set, it implies that the ProxyService is running in SSL mode. In that case, you must also set ssl=true in the external web server configuration file.
InstrumentationService
The InstrumentationService controls JRun method timing functionality. For more information on method timings, see the JRun Programmer's Guide.
This service contains the MethodInstrumentor service, which accepts the following attributes:
Attribute
Description
ClassName
Specifies the name of a class to instrument. This can include a single wildcard (*) at the end of the class value.
ClassNameList
Displays a list of classes being timed.
DirectSubclasses
Indicates whether to also time immediate descendants of the classes specified in the className attribute. Specify true or false. The default is true.
ExcludeCallsTo
Specifies packages that are not timed. The default is to exclude java.*, javax.*, and sun.*.
ExcludeCallsToList
Displays a list of excluded classes.
InstrumentCalls
Indicates whether method call instrumentation is enabled. This includes method instrumentation as well as all method calls within each instrumented method. Specify true or false. The default is false.
InstrumentCallsTo
If using method call instrumentation, specifies which method calls are instrumented. Specify * to time all calls in all methods in classes specified in the className attribute.
InstrumentCallsToList
Displays a list of calls being timed.
InstrumentMethod
Specifies the name of a method to time. Specify * to time all methods in classes specified in the className attribute.
InstrumentMethodList
Displays a list of methods being timed.
InstrumentMethods
Indicates whether to time methods for classes specified in the className attribute. Specify true or false. The default is false.
LoggingCallEnterLabel
Specifies the prefix used when writing call-enter messages to the log file. The default is CALL ENTER.
LoggingCallExitLabel
Specifies the prefix used when writing call-exit messages to the log file. The default is CALL EXIT.
LoggingDelimiter
Specifies the delimiter used between the components of the method timing message. The default delimiter is a space.
LoggingMethodEnterLabel
Specifies the prefix used when writing method-enter messages to the log file. The default is METHOD ENTER.
LoggingMethodExitLabel
Specifies the prefix used when writing method-exit messages to the log file. The default is METHOD EXIT.
OutputToRequestThread
Indicates whether to write method timing information to thread-local storage so that the timing filter can be used for in-line display. Specify true or false. The default is true. For more information on the timing filter, see JRun Programmer's Guide.
OutputToStandardLogger
Indicates whether to write method timing information to the log file. Specify true or false. The default is true.
HTMLAgentService
The JMX HTMLAgentService allows you to view all attributes for a running JRun server. To use this service, uncomment the service element, restart the JRun server, and open a browser to the hostname:htmlagentportnumber URL. Use the user ID and password from the adminUsers attribute.
This service accepts the following attributes:
Attribute
Description
AdminUsers
Specifies a comma-delimited list of userid:passwords for accessing the HTMLAgentService.
MaxActiveClients
Specifies the maximum number of client connections. The default is 10.
Port
Specifies the port number for the HTMLAgentService. Use this port number in the URL to view server settings through a browser.
JRunAdminService
The JRunAdminService enables remote access to a JRun server.
Comments
danger42
said on
Nov 20, 2002
at
5:57 PM :
The TXDomainService under JRunTransactionService now accepts a maximum transaction timeout setting. For example:
The default maximumTimeout attribute is 600 seconds.
colin_froggatt
said on
May 16, 2003
at
6:44 AM :
The SOMAXCONN value for the backlog attribute in the ProxyService config causes a NumberFormatException !
Fuseboxer
said on
Apr 12, 2004
at
1:57 PM :
In the section of the document for the 'ClusterManager' service, the UnicastPeer attribute description reads:
"Specifies JRun servers in the cluster that are outside of the subnet. JRun automatically locates servers on the same subnet but requires a unicastPeer specification for JRun servers outside of the subnet."
You CANNOT use the name of the JRun Server here. You MUST use the hostname of the server on which JRun is installed.
Also, JRun by default uses IP multicasting to find other servers on the local subnet. If your network engineering team has disabled multicasting (as mine did), then you MUST specify physical hostnames in the UnicastPeer attributes. This will cause JRun to use unicast to connect to other servers to enable session replication and failover.
ForrestNg
said on
Apr 30, 2004
at
4:21 AM :
MinHandlerThreads has no effect? only one thread remain active after timeout period
jrunrandy
said on
Apr 30, 2004
at
11:15 AM :
The minHandlerThreads is the min threads that are available to JRun at start up. After that it can get reduced if the threads are not used and timed out. That's whats missing from the docs.
APDutch
said on
Sep 13, 2004
at
6:25 AM :
you've made a mistake in the loggger service section. You say that error loggin should be turned off in production to minimise the amount of space used by the files. But you surely mean debug logging. Telling people to turn off error logging means nobody will ever be aware of errors in their applications. You just need to move the comment up a line.
Comments
danger42 said on Nov 20, 2002 at 5:57 PM : colin_froggatt said on May 16, 2003 at 6:44 AM : Fuseboxer said on Apr 12, 2004 at 1:57 PM : ForrestNg said on Apr 30, 2004 at 4:21 AM :