Sun Java System Application Server Platform Edition 9 Application Deployment Guide

M

manager-properties

Specifies session manager properties.

Superelements

session-manager (sun-web.xml)

Subelements

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

Table A–63 manager-properties Subelements

Element  

Required  

Description  

property (with attributes)

zero or more 

Specifies a property, which has a name and a value. 

Properties

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

Table A–64 manager-properties Properties

Property 

Default 

Description 

reapIntervalSeconds

60

Specifies the number of seconds between checks for expired sessions. This is also the interval at which sessions are passivated if maxSessions is exceeded.

To prevent data inconsistency, 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 the last few hits might be lost each time the server is restarted.

Applicable only if the persistence-type attribute of the parent session-manager element is file.

maxSessions

-1

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

The session manager passivates sessions to the persistent store when this maximum is reached. 

Applicable only if the persistence-type attribute of the parent session-manager element is file.

sessionFilename

One of the following: 

domain-dir/generated/jsp/j2ee-modules/module-name/context-path_SESSIONS.ser

domain-dir/generated/jsp/j2ee-apps/app-name/module-name/context-path_SESSIONS.ser

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. To disable preservation of the session state, set this property's value to an empty string. 

Applicable only if the persistence-type attribute of the parent session-manager element is memory.

mapping-properties

This element is not implemented.

Superelements

cmp (sun-ejb-jar.xml)

max-cache-size

Specifies the maximum number of beans allowable in cache. A value of zero indicates an unbounded cache. In reality, there is no hard limit. The max-cache-size limit is just a hint to the cache implementation. Default is 512.

Applies to stateful session beans and entity beans.

Superelements

bean-cache (sun-ejb-jar.xml)

Subelements

none - contains data

max-pool-size

Specifies the maximum number of bean instances in the pool. Values are from 0 (1 for message-driven bean) to MAX_INTEGER. A value of 0 means the pool is unbounded. Default is 64.

Applies to all beans.

Superelements

bean-pool (sun-ejb-jar.xml)

Subelements

none - contains data

max-wait-time-in-millis

This element is deprecated. Do not use.

Superelements

bean-pool (sun-ejb-jar.xml)

mdb-connection-factory

Specifies the connection factory associated with a message-driven bean. Queue or Topic type must be consistent with the Java Message Service Destination type associated with the message-driven bean class.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the mdb-connection-factory element.

Table A–65 mdb-connection-factory Subelements

Element 

Required 

Description 

jndi-name

only one 

Specifies the absolute jndi-name.

default-resource-principal

zero or one 

Specifies the default sign-on (name/password) to the resource manager. 

mdb-resource-adapter

Specifies runtime configuration information for a message-driven bean.

Superelements

ejb (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the mdb-resource-adapter element.

Table A–66 mdb-resource-adapter subelements

Element  

Required  

Description  

resource-adapter-mid

zero or one 

Specifies a resource adapter module ID. 

activation-config

one or more 

Specifies an activation configuration. 

message

Specifies the methods or operations to which message security requirements apply.

Superelements

message-security (sun-web.xml, sun-ejb-jar.xml, sun-application-client.xml)

Subelements

The following table describes subelements for the message element.

Table A–67 message Subelements

Element 

Required 

Description 

java-method

zero or one 

Specifies the methods or operations to which message security requirements apply. 

operation-name

zero or one 

Specifies the WSDL name of an operation of a web service. 

message-destination

Specifies the name of a logical message-destination defined within an application. The message-destination-name matches the corresponding message-destination-name in the corresponding Java EE deployment descriptor file. Use when the message destination reference in the corresponding Java EE deployment descriptor file specifies a message-destination-link to a logical message-destination.

Superelements

sun-web-app (sun-web.xml), enterprise-beans (sun-ejb-jar.xml), sun-application-client (sun-application-client.xml)

Subelements

The following table describes subelements for the message-destination element.

Table A–68 message-destination subelements

Element 

Required 

Description 

message-destination-name

only one 

Specifies the name of a logical message destination defined within the corresponding Java EE deployment descriptor file. 

jndi-name

only one 

Specifies the jndi-name of the associated entity.

message-destination-name

Specifies the name of a logical message destination defined within the corresponding Java EE deployment descriptor file.

Superelements

message-destination (sun-web.xml, sun-ejb-jar.xml, sun-application-client.xml)

Subelements

none - contains data

message-destination-ref

Directly binds a message destination reference to the JNDI name of a Queue, Topic, or other physical destination. Use only when the message destination reference in the corresponding Java EE deployment descriptor file does not specify a message-destination-link to a logical message-destination.

Superelements

sun-web-app (sun-web.xml), ejb (sun-ejb-jar.xml), sun-application-client (sun-application-client.xml)

Subelements

The following table describes subelements for the message-destination-ref element.

Table A–69 message-destination-ref subelements

Element 

Required 

Description 

message-destination-ref-name

only one 

Specifies the name of a physical message destination defined within the corresponding Java EE deployment descriptor file. 

jndi-name

only one 

Specifies the jndi-name of the associated entity.

message-destination-ref-name

Specifies the name of a physical message destination defined within the corresponding Java EE deployment descriptor file.

Superelements

message-destination-ref (sun-web.xml, sun-ejb-jar.xml, sun-application-client.xml)

Subelements

none - contains data

message-security

Specifies message security requirements.

Superelements

message-security-binding (sun-web.xml, sun-ejb-jar.xml, sun-application-client.xml)

Subelements

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

Table A–70 message-security Subelements

Element 

Required 

Description 

message

one or more 

Specifies the methods or operations to which message security requirements apply. 

request-protection

zero or one 

Defines the authentication policy requirements of the application’s request processing. 

response-protection

zero or one 

Defines the authentication policy requirements of the application’s response processing. 

message-security-binding

Specifies a custom authentication provider binding for a parent webservice-endpoint or port-info element in one or both of these ways:

Superelements

webservice-endpoint, port-info (sun-web.xml, sun-ejb-jar.xml, sun-application-client.xml)

Subelements

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

Table A–71 message-security-binding Subelements

Element 

Required 

Description 

message-security

zero or more 

Specifies message security requirements. 

Attributes

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

Table A–72 message-security-binding Attributes

Attribute 

Default 

Description 

auth-layer

none 

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

provider-id

none 

(optional) Specifies the authentication provider used to satisfy application-specific message security requirements. 

If this attribute is not specified, a default provider is used, if it is defined for the message layer. 

if no default provider is defined, authentication requirements defined in the message-security-binding are not enforced.

message-security-config

Specifies configurations for message security providers.

Superelements

client-container (sun-acc.xml)

Subelements

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

Table A–73 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 A–74 message-security-config Attributes

Attribute 

Default 

Description 

auth-layer

none 

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

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. 

method

Specifies a bean method.

Superelements

flush-at-end-of-method (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the method element.

Table A–75 method Subelements

Element 

Required 

Description 

description

zero or one 

Specifies an optional text description. 

ejb-name

zero or one 

Matches the ejb-name in the corresponding ejb-jar.xml file.

method-name

only one 

Specifies a method name. 

method-intf

zero or one 

Specifies the method interface to distinguish between methods with the same name in different interfaces. 

method-params

zero or one 

Specifies fully qualified Java type names of method parameters. 

method-intf

Specifies the method interface to distinguish between methods with the same name in different interfaces. Allowed values are Home, Remote, LocalHome, and Local.

Superelements

method (sun-ejb-jar.xml)

Subelements

none - contains data

method-name

Specifies a method name or * (an asterisk) for all methods. If a method is overloaded, specifies all methods with the same name.

Superelements

java-method (sun-web.xml, sun-ejb-jar.xml, sun-application-client.xml); finder, query-method , method (sun-ejb-jar.xml)

Subelements

none - contains data

Examples

<method-name>findTeammates</method-name>

<method-name>*</method-name>

method-param

Specifies the fully qualified Java type name of a method parameter.

Superelements

method-params (sun-web.xml, sun-ejb-jar.xml, sun-application-client.xml)

Subelements

none - contains data

method-params

Specifies fully qualified Java type names of method parameters.

Superelements

java-method (sun-web.xml, sun-ejb-jar.xml, sun-application-client.xml); query-method, method (sun-ejb-jar.xml)

Subelements

The following table describes subelements for the method-params element.

Table A–76 method-params Subelements

Element 

Required 

Description 

method-param

zero or more 

Specifies the fully qualified Java type name of a method parameter.