Sun GlassFish Enterprise Server v2.1.1 Administration Reference

M

mail-resource

Defines a JavaMail (javax.mail.Session) resource.

Superelements

resources

Subelements

The following table describes subelements for the mail-resource element.

Table 1–116 mail-resource Subelements

Element 

Required 

Description 

description

zero or one 

Contains a text description of this element. 

property

zero or more 

Specifies a property or a variable. 

Attributes

The following table describes attributes for the mail-resource element.

Table 1–117 mail-resource Attributes

Attribute 

Default 

Description 

jndi-name

none 

Specifies the JNDI name for the resource. 

store-protocol

imap

(optional) Specifies the storage protocol service, which connects to a mail server, retrieves messages, and saves messages in folder(s). Allowed values are imap, pop3, imaps, and pop3s .

store-protocol-class

com.sun.mail.imap.IMAPStore

(optional) Specifies the service provider implementation class for storage. Allowed values are: 

com.sun.mail.imap.IMAPStore

com.sun.mail.pop3.POP3Store

com.sun.mail.imap.IMAPSSLStore

com.sun.mail.pop3.POP3SSLStore

transport-protocol

smtp

(optional) Specifies the transport protocol service, which sends messages. Allowed values are smtp and smtps.

transport-protocol-class

com.sun.mail.smtp.SMTPTransport

(optional) Specifies the service provider implementation class for transport. Allowed values are: 

com.sun.mail.smtp.SMTPTransport

com.sun.mail.smtp.SMTPSSLTransport

host

none 

The mail server host name. 

user

none 

The mail server user name. 

from

none 

The email address the mail server uses to indicate the message sender. 

debug

false

(optional) Determines whether debugging for this resource is enabled. 

object-type

user

(optional) Defines the type of the resource. Allowed values are: 

  • system-all - A system resource for all server instances and the domain application server.

  • system-admin - A system resource only for the domain application server.

  • system-instance - A system resource for all server instances only.

  • user - A user resource.

enabled

true

(optional) Determines whether this resource is enabled at runtime. 

Properties

You can set properties for the mail-resource element and then get these properties in a JavaMail Session object later. Every property name must start with a mail- prefix. The Enterprise Server changes the dash (-) character to a period (.) in the name of the property, then saves the property to the MailConfiguration and JavaMail Session objects. If the name of the property doesn’t start with mail-, the property is ignored.

For example, to define the property mail.password in a JavaMail Session object, first edit domain.xml as follows:

...
 <mail-resource jndi-name="mail/Session" ...>
     <property name="mail-password" value="adminadmin"/>
 </mail-resource>
 ...

After getting the JavaMail Session object, get the mail.password property to retrieve the value adminadmin, as follows:

String password = session.getProperty("mail.password");

For more information about JavaMail properties, see JavaMail API Documentation.

management-rule

Configures a self-management rule, which associates a custom self-tuning, self-configuring, or self-healing action with an event in the Enterprise Server. The action is implemented by an MBean.

Superelements

management-rules

Subelements

The following table describes subelements for the management-rule element.

Table 1–118 management-rule Subelements

Element 

Required 

Description 

description

zero or one 

Contains a text description of this element.  

This description is included in server log messages about the management rule. For more information on logging, see log-service and module-log-levels.

event

only one 

Defines the event that triggers the action associated with a management rule. 

action

zero or one 

Specifies the action of this management rule. If no action is specified, occurrence of the associated event is logged. 

Attributes

The following table describes attributes for the management-rule element.

Table 1–119 management-rule Attributes

Attribute 

Default 

Description 

name

none 

Specifies the name of this management rule. 

enabled

true

(optional) If false, disables this management rule.

management-rules

Configures self-management rules, which associate custom self-tuning, self-configuring, and self-healing actions with events in the Enterprise Server.

Superelements

config

Subelements

The following table describes subelements for the management-rules element.

Table 1–120 management-rules Subelements

Element 

Required 

Description 

management-rule

zero or more 

Specifies a management rule. 

Attributes

The following table describes attributes for the management-rules element.

Table 1–121 management-rules Attributes

Attribute 

Default 

Description 

enabled

true

(optional) If false, disables all management rules. If true, the enabled attribute of each rule determines whether it is enabled.

manager-properties

Specifies session manager properties.

Superelements

session-manager

Subelements

The following table describes subelements for the manager-properties element.

Table 1–122 manager-properties Subelements

Element 

Required 

Description 

property

zero or more 

Specifies a property or a variable. 

Attributes

The following table describes attributes for the manager-properties element.

Table 1–123 manager-properties Attributes

Attribute 

Default 

Description 

session-file-name

none; state is not preserved across restarts 

(optional) Specifies the absolute or relative path to the directory in which the session state is preserved between application restarts, if preserving the state is possible. A relative path is relative to the temporary directory for this web application. Applicable to the web container only if the persistence-type attribute of the web-container-availability element is memory.

reap-interval-in-seconds

60

(optional) Specifies the time between checks for expired sessions. 

If the persistence-frequency attribute of the web-container-availability element is set to time-based, active sessions are stored at this interval.

Set this value lower than the frequency at which session data changes. For example, this value should be as low as possible (1 second) for a hit counter servlet on a frequently accessed web site, or you could lose the last few hits each time you restart the server.

max-sessions

-1

(optional) Specifies the maximum number of sessions that can be in cache, or -1 for no limit. After this, an attempt to create a new session causes an IllegalStateException to be thrown.

session-id-generator-classname

internal class generator 

(optional) Not implemented. Use the uuid-impl-class property of the web-container-availability element instead.

mbean

Specifies an MBean, which implements the javax.management.NotificationListener interface.

Superelements

applications

Subelements

The following table describes subelements for the mbean element.

Table 1–124 mbean Subelements

Element 

Required 

Description 

description

zero or one 

Contains a text description of this element. 

property

zero or more 

Specifies a property. Property subelements of the mbean element store the names and values of attributes defined in the MBean implementation class.

Attributes

The following table describes attributes for the mbean element.

Table 1–125 mbean Attributes

Attribute 

Default 

Description 

name

value of impl-class-name

The name of the MBean. The name must represent a value of a property in the property-list of an MBean ObjectName. The name is a primary key for the MBean. This is read-only.

object-type

user

(optional) Defines the type of the resource. This is read-only. Allowed values are: 

  • system-all - A system resource for all server instances and the domain application server.

  • system-admin - A system resource only for the domain application server.

  • system-instance - A system resource for all server instances only.

  • user - A user resource.

impl-class-name

none 

Defines the fully qualified class name of the MBean implementation. This is read-only. 

object-name

none 

Defines a system-generated object name for this MBean. This is read-only. 

enabled

true

(optional) Determines whether the MBean is enabled. If false, the MBean is not registered in the runtime environment even if the reference is enabled.

mdb-container

Configures the message-driven bean (MDB) container.

Superelements

config

Subelements

The following table describes subelements for the mdb-container element.

Table 1–126 mdb-container Subelements

Element 

Required 

Description 

property

zero or more 

Specifies a property or a variable. 

Attributes

The following table describes attributes for the mdb-container element.

Table 1–127 mdb-container Attributes

Attribute 

Default 

Description 

steady-pool-size

10

(optional) Specifies the initial and minimum number of beans maintained in the pool. 

pool-resize-quantity

2

(optional) Specifies the number of beans to be removed when the idle-timeout-in-seconds timer expires. A cleaner thread removes any unused instances.

Must be 0 or greater and less than max-pool-size . The pool is not resized below the steady-pool-size.

max-pool-size

60

(optional) Specifies the maximum number of beans that can be created to satisfy client requests. 

idle-timeout-in-seconds

600

(optional) Specifies the maximum time that a bean can remain idle in the pool. After this amount of time, the bean is destroyed. A value of 0 means a bean can remain idle indefinitely.

Properties

The following table describes properties for the mdb-container element.

Table 1–128 mdb-container Properties

Property 

Default 

Description 

cmt-max-runtime-exceptions

1

Specifies the maximum number of RuntimeException occurrences allowed from a message-driven bean’s onMessage() method when container-managed transactions are used. Deprecated.

message-security-config

Specifies configurations for message security providers.

Superelements

security-service

Subelements

The following table describes subelements for the message-security-config element.

Table 1–129 message-security-config Subelements

Element 

Required 

Description 

provider-config

one or more 

Specifies a configuration for one message security provider. 

Attributes

The following table describes attributes for the message-security-config element.

Table 1–130 message-security-config Attributes

Attribute 

Default 

Description 

auth-layer

SOAP

Specifies the message layer at which authentication is performed. The value must be SOAP or HttpServlet.

default-provider

none 

(optional) Specifies the server provider that is invoked for any application not bound to a specific server provider. 

default-client-provider

none 

(optional) Specifies the client provider that is invoked for any application not bound to a specific client provider. 

module-log-levels

Controls the level of messages logged by server subsystems to the server log. Allowed values (levels) of each subsystem attribute are, from highest to lowest: FINEST , FINER, FINE, CONFIG, INFO, WARNING, SEVERE, and OFF. Each value logs all messages for all lower values. The default value is INFO, which logs all INFO, SEVERE , and WARNING messages.

Superelements

log-service

Subelements

The following table describes subelements for the module-log-levels element.

Table 1–131 module-log-levels Subelements

Element 

Required 

Description 

property

zero or more 

Specifies a property or a variable. 

Attributes

The following table describes attributes for the module-log-levels element. The attribute names are the names of the Enterprise Server system loggers.

Table 1–132 module-log-levels Attributes

Attribute 

Default 

Description 

root

INFO

(optional) Specifies the default level of messages logged by the entire Enterprise Server installation. 

server

INFO

(optional) Specifies the default level of messages logged by the server instance. 

ejb-container

INFO

(optional) Specifies the level of messages logged by the EJB container. 

cmp-container

INFO

(optional) Specifies the level of messages logged by the CMP subsystem of the EJB container. 

mdb-container

INFO

(optional) Specifies the level of messages logged by the MDB container. 

web-container

INFO

(optional) Specifies the level of messages logged by the web container. 

classloader

INFO

(optional) Specifies the level of messages logged by the classloader hierarchy. 

configuration

INFO

(optional) Specifies the level of messages logged by the configuration subsystem. 

naming

INFO

(optional) Specifies the level of messages logged by the naming subsystem. 

security

INFO

(optional) Specifies the level of messages logged by the security subsystem. 

jts

INFO

(optional) Specifies the level of messages logged by the Java Transaction Service. 

jta

INFO

(optional) Specifies the level of messages logged by the Java Transaction API. 

admin

INFO

(optional) Specifies the level of messages logged by the Administration Console subsystem. 

deployment

INFO

(optional) Specifies the level of messages logged by the deployment subsystem. 

verifier

INFO

(optional) Specifies the level of messages logged by the deployment descriptor verifier. 

jaxr

INFO

(optional) Specifies the level of messages logged by the XML registry. 

jaxrpc

INFO

(optional) Specifies the level of messages logged by the XML RPC module. 

saaj

INFO

(optional) Specifies the level of messages logged by the SOAP with Attachments API for Java module. 

corba

INFO

(optional) Specifies the level of messages logged by the ORB. 

javamail

INFO

(optional) Specifies the level of messages logged by the JavaMail subsystem. 

jms

INFO

(optional) Specifies the level of messages logged by the Java Message Service. 

connector

INFO

(optional) Specifies the level of messages logged by the connector subsystem. 

jdo

INFO

(optional) Specifies the level of messages logged by the Java Data Objects module. 

cmp

INFO

(optional) Specifies the level of messages logged by the CMP subsystem. 

util

INFO

(optional) Specifies the level of messages logged by the utility subsystem. 

resource-adapter

INFO

(optional) Specifies the level of messages logged by the resource adapter subsystem. 

synchronization

INFO

(optional) Specifies the level of messages logged by the synchronization subsystem. 

node-agent

INFO

(optional) Specifies the level of messages logged by the node agent subsystem. 

self-management

INFO

(optional) Specifies the level of messages logged by the self-management (management rules) subsystem. 

group-management-service

INFO

(optional) Specifies the level of messages logged by the Group Management Service. 

management-event

INFO

(optional) Specifies the level of messages logged by the self-management event subsystem. 

module-monitoring-levels

Controls the level of monitoring of server subsystems. Allowed values of each subsystem attribute are LOW, HIGH, and OFF.

Superelements

monitoring-service

Subelements

The following table describes subelements for the module-monitoring-levels element.

Table 1–133 module-monitoring-levels Subelements

Element 

Required 

Description 

property

zero or more 

Specifies a property or a variable. 

Attributes

Table 1–134 module-monitoring-levels Attributes

Attribute 

Default 

Description 

thread-pool

OFF

(optional) Specifies the level of monitoring of the thread pool subsystem. 

orb

OFF

(optional) Specifies the level of monitoring of the ORB. 

ejb-container

OFF

(optional) Specifies the level of monitoring of the EJB container. 

web-container

OFF

(optional) Specifies the level of monitoring of the web container. 

transaction-service

OFF

(optional) Specifies the level of monitoring of the transaction service. 

http-service

OFF

(optional) Specifies the level of monitoring of the HTTP service. 

jdbc-connection-pool

OFF

(optional) Specifies the level of monitoring of the JDBC connection pool subsystem. 

connector-connection-pool

OFF

(optional) Specifies the level of monitoring of the connector connection pool subsystem. 

connector-service

OFF

(optional) Specifies the level of monitoring of the connector service. 

jms-service

OFF

(optional) Specifies the level of monitoring of the JMS service. 

jvm

OFF

(optional) Specifies the level of monitoring of the JVM. 

monitoring-service

Configures the monitoring service.

Superelements

config

Subelements

The following table describes subelements for the monitoring-service element.

Table 1–135 monitoring-service Subelements

Element 

Required 

Description 

module-monitoring-levels

zero or one 

Controls the level of monitoring of server subsystems. 

property

zero or more 

Specifies a property or a variable.