SchemaDOC - jrun-resources.dtd

XML DTD - jrun-resources.dtd
Schema has:	58 element definitions and 0 element attribute definitions.
Possible root elements:	< jrun-resources >

Element list

Element jrun-resources

diagram
attributes
uses	jms-destination jms-connection-factory data-source mail-session url-resource

content	a sequence of elements
occurrence	required (default)

Element jms-destination

diagram
description	The jms-destination specifies a JMS destination resource. Used in: jrun-resources
attributes
uses	jndi-name destination-name destination-type

content	a sequence of elements
occurrence	required (default)

Element destination-name

diagram
description	The destination-name element specifies the JMS destination's name. Used in: jms-destination
attributes
uses

content	character data
occurrence

Element destination-type

diagram
description	The destination-type element specifies the Java type of the JMS destination's class. It can be one of: javax.jms.Queue, javax.jms.Topic. Used in: jms-destination
attributes
uses

content	character data
occurrence

Element jms-connection-factory

diagram
description	The jms-connection-factory element specifies a JMS connection factory resource. Used in: jrun-resources
attributes
uses	factory-name jndi-name type transport username password authentication

content	a sequence of elements
occurrence	required (default)

Element factory-name

diagram
description	The factory-name element specifies the JMS connection factory name. Used in: jms-connection-factory
attributes
uses

content	character data
occurrence

Element type

diagram
description	The type element specifies the JMS connection factory class. It can be one of the following types: javax.jms.QueueConnectionFactory, javax.jms.XAQueueConnectionFactory, javax.jms.TopicConnectionFactory , javax.jms.XATopicConnectionFactory. Used in: jms-connection-factory
attributes
uses

content	character data
occurrence

Element transport

diagram
description	The transport element specifies the underlying commmunication mechanism used by connections created with this factory. It can be one of the following strings: RMI, TCPIP, or INTRAVM. Used in: jms-connection-factory
attributes
uses

content	character data
occurrence

Element authentication

diagram
description	The authentication element is used to specify the java class name of a user-provided authenticator to be used by the connection factory in place of the provider's default authenticator. Used in: jms-connection-factory
attributes
uses

content	character data
occurrence

Element data-source

diagram
description	The data-source element specifies a JDBC resource. Used in: jrun-resources and jrun-jms.
attributes
uses	dbname jndi-name driver url description username password encrypted encryption-class isolation-level native-results transaction-domain transaction-timeout disable-pooling initial-connections minimum-size maximum-size maximum-soft connection-timeout user-timeout skimmer-frequency shrink-by validation-query initial-pool-sql initial-connection-sql debugging cache-enabled cache-size cache-refresh-interval remove-on-exceptions pool-statements

content	a sequence of elements
occurrence	required (default)

Element dbname

diagram
description	The dbname element specifies the data source name. Used in: data-source
attributes
uses

content	character data
occurrence

Element jndi-name

diagram
description	The jndi-name element specifies where the resource will be bound in JNDI. Used in: data-source, jms-destination, jms-connection-factory, mail-session
attributes
uses

content	character data
occurrence

Element driver

diagram
description	The driver element specifies the class name of the JDBC driver for the data source. Used in: data-source
attributes
uses

content	character data
occurrence

Element url

diagram
description	The url element specifies the connection URL for the data source. Used in: data-source
attributes
uses

content	character data
occurrence

Element description

diagram
description	The description element is used to provide human-readable text describing the parent element. Used in: mail-session, data-source
attributes
uses

content	character data
occurrence

Element username

diagram
description	The username element specifies the username used when creating connections. Used in: data-source
attributes
uses

content	character data
occurrence

Element password

diagram
description	The password element specifies the password used when creating connections. If the encrypted tag has a value of "true" then this password should be encrypted using the class specified in "encryption-class" tag and the resulting encrypted password should be copied as the password value Used in: data-source
attributes
uses

content	character data
occurrence

Element encrypted

diagram
description	The encrypted element specifies whether the password for this connection is encrypted or not. It takes a value of "true" or "false". Used in: data-source
attributes
uses

content	character data
occurrence

Element encryption-class

diagram
description	The encryption-class element specifies the class to use if the password is encrypted. The encrypted password is decrypted using this class and then passed to the database. The class specified here should implement the jrun.security.JRunCrypter interface. Used in: data-source
attributes
uses

content	character data
occurrence

Element isolation-level

diagram
description	The isolation-level element specifies the transaction isolation level for the data source. Used in: data-source
attributes
uses

content	character data
occurrence

Element native-results

diagram
description	The native-results element specifies whether the result set returned from the JDBC driver should be wrapped to facilitate pooling. Used in: data-source
attributes
uses

content	character data
occurrence

Element transaction-domain

diagram
description	The transaction-domain element specifies the transaction domain, which connections should run in the context of. Used in: data-source
attributes
uses

content	character data
occurrence

Element transaction-timeout

diagram
description	The transaction-timeout element specifies the timeout interval for transactions associated with this datasource. Used in: data-source
attributes
uses

content	character data
occurrence

Element disable-pooling

diagram
description	The disable-pooling element specifies whether data source pooling is disabled. Used in: data-source
attributes
uses

content	character data
occurrence

Element initial-connections

diagram
description	The initial-connections element specifies the number of initial connections that are created when the data source is created. Used in: data-source
attributes
uses

content	character data
occurrence

Element minimum-size

diagram
description	The minimum allowed number of connections to the data source in the pool. Used in: data-source
attributes
uses

content	character data
occurrence

Element maximum-size

diagram
description	The maximum-size element specifies the maximum number of allowed pooled connections in the pool. Used in: data-source
attributes
uses

content	character data
occurrence

Element maximum-soft

diagram
description	The maximum-soft element specifies whether the maximum number of connections is allowed to grow past the maximum pool size in order to handle load. Used in: data-source
attributes
uses

content	character data
occurrence

Element connection-timeout

diagram
description	The connection-timeout element specifies the number of seconds, since the connection was last accessed, before the connection will timeout. Used in: data-source
attributes
uses

content	character data
occurrence

Element user-timeout

diagram
description	The number of seconds that a user must keep a connection before it is automatically returned to the pool. Used in: data-source
attributes
uses

content	character data
occurrence

Element skimmer-frequency

diagram
description	The skimmer-frequency element specifies the number of seconds between processing the connection pool. Used in: data-source
attributes
uses

content	character data
occurrence

Element shrink-by

diagram
description	The shrink-by element specifies the number of connections that the pool size is decreased by when the skimmer needs to reduce the size of the pool. Used in: data-source
attributes
uses

content	character data
occurrence

Element validation-query

diagram
description	The validation-query element specifies an SQL statement used to validate whether a connection is valid. Used in: data-source
attributes
uses

content	character data
occurrence

Element initial-pool-sql

diagram
description	The init-pool-sql element specifies an SQL statement used to validate the jdbc pool. Used in: data-source
attributes
uses

content	character data
occurrence

Element initial-connection-sql

diagram
description	The initialt-connection-sql element specifies a SQL statement used to validate a JDBC connection. Used in: data-source
attributes
uses

content	character data
occurrence

Element debugging

diagram
description	The debugging element specifies whether data source debugging information will be logged. Used in: data-source
attributes
uses

content	character data
occurrence

Element cache-enabled

diagram
description	The cache-enabled element specifies whether SQL statement caching is enabled. Used in: data-source
attributes
uses

content	character data
occurrence

Element cache-size

diagram
description	The cache-size element specifies the size of the SQL statement cache. Used in: data-source
attributes
uses

content	character data
occurrence

Element cache-refresh-interval

diagram
description	The cache-refresh-interval element specifies number of seconds between cache refreshs. Used in: data-source
attributes
uses

content	character data
occurrence

Element remove-on-exceptions

diagram
description	The remove-on-exceptions element specifies whether connections will be recycled back into the connection pool when exceptions occur. Used in: data-source
attributes
uses

content	character data
occurrence

Element pool-statements

diagram
description	The pool-statements element specifies whether statement objects will be reused. Used in: data-source
attributes
uses

content	character data
occurrence

Element mail-session

diagram
description	The mail-session element specifies a JavaMail resource. Used in: jrun-resources
attributes
uses	jndi-name description store-protocol transport-protocol host user smtp-host smtp-user imap-host imap-user pop3-host pop3-user from debug

content	a sequence of elements
occurrence	required (default)

Element store-protocol

diagram
description	The store-protocol is the protocol used by the mail server to save recieved mail. It may be "pop3" or "imap". Used in: mail-session
attributes
uses

content	character data
occurrence

Element transport-protocol

diagram
description	The transport-protocol is the protocol used by the mail server to forward mail to other mail severs. It must be "smtp". Used in: mail-session
attributes
uses

content	character data
occurrence

Element host

diagram
description	The host element is the network name of the computer that is acting as the mail server if the same computer is acting as both the mail sender and receiver. Used in: mail-session
attributes
uses

content	character data
occurrence

Element user

diagram
description	The user element is the network identity this mail session should use if the same identity is to be used for both sending and receiving mail. Used in: mail-session
attributes
uses

content	character data
occurrence

Element smtp-host

diagram
description	The smtp-host element is the network name of the computer that is acting as the mail server for sending mail via SMTP. If the same computer is acting as both the mail sender and receiver, it is not necessary to set this as you may simply use the "host" element instead. Used in: mail-session
attributes
uses

content	character data
occurrence

Element smtp-user

diagram
description	The smtp-user element is the network identity this mail session will use for sending mail via SMTP. If the same computer is acting as both the mail sender and receiver, it is not necessary to set this as you may simply use the "user" element instead. Used in: mail-session
attributes
uses

content	character data
occurrence

Element imap-host

diagram
description	The imap-host element is the network name of the computer that is acting as the mail server for receiving mail using IMAP. If the same computer is acting as both the mail sender and receiver, it is not necessary to set this as you may simply use the "host" element instead. Used in: mail-session
attributes
uses

content	character data
occurrence

Element imap-user

diagram
description	The imap-user element is the network identity this mail session will use for receiving mail via IMAP. If the same computer is acting as both the mail sender and receiver, it is not necessary to set this as you may simply use the "user" element instead. Used in: mail-session
attributes
uses

content	character data
occurrence

Element pop3-host

diagram
description	The pop3-host element is the network name of the computer that is acting as the mail server for receiving mail via POP3. If the same computer is acting as both the mail sender and receiver, it is not necessary to set this as you may simply use the "host" element instead. Used in: mail-session
attributes
uses

content	character data
occurrence

Element pop3-user

diagram
description	The pop3-user element is the network identity this mail session will use for receiving mail via POP3. If the same computer is acting as both the mail sender and receiver, it is not necessary to set this as you may simply use the "user" element instead. Used in: mail-session
attributes
uses

content	character data
occurrence

Element from

diagram
description	The from element is used as the default value for the from mail header field for all mail sent by this session. Used in: mail-session
attributes
uses

content	character data
occurrence

Element debug

diagram
description	The debug element is used as the default value for the debug mail header field for all mail sent by this session. This field is used by many mail transport agents to provide verbose output useful for debugging mail connection problems. Used in: mail-session
attributes
uses

content	character data
occurrence

Element url-resource

diagram
description	The url element is used to specify a URL as a sharable resource. Used in: jrun-resources.
attributes
uses	description jndi-name url-value url-type validate

content	a sequence of elements
occurrence	required (default)

Element url-value

diagram
description	The url-value element is used to specify the URL itself. Used in: url.
attributes
uses

content	character data
occurrence

Element url-type

diagram
description	The url-name element is used to specify the Java type of this URL resource. It defaults to java.util.URL. Used in: url.
attributes
uses

content	character data
occurrence

Element validate

diagram
description	The validate element is used to specify that the supplied url-value should be validated at server startup. If set to "true", JRun will try to create a short-lived connection to the object specified as a means of verifying that the URL string supplied is correct. Since network-based resources may well be transient, this validation is just a startup-time check only. It does not imply that the referenced object is constantly available. Also, failure to validate at startup-time is non-fatal; meaning that the URL will still be made available from JNDI as a J2EE resouorce even if the validation step fails. The default is "false", meaning do not validate. Used in: url.
attributes
uses

content	character data
occurrence