Sun Java System Application Server Platform Edition 8.1 2005Q2 Update 2 Developer's Guide

- Previous: Q
- Next: S

# R

## read-only

Specifies that a field is read-only if `true`. If this element is absent, the default value is `false` .

### Superelements

cmp-field-mapping (`sun-cmp-mappings.xml`)

### Subelements

none - contains data

## realm

Specifies the name of the realm used to process all authentication requests associated with this application. If this element is not specified or does not match the name of a configured realm, the default realm is used. For more information about realms, see Realm Configuration.

### Superelements

sun-application (`sun-application.xml`), as-context (`sun-ejb-jar.xml`)

### Subelements

none - contains data

## refresh-field

Specifies a field that gives the application component a programmatic way to refresh a cached entry.

### Superelements

cache-mapping (`sun-web.xml`)

### Subelements

none

### Attributes

The following table describes attributes for the `refresh-field` element.

Table A–85 `refresh-field` Attributes

Attribute | Default | Description
--- | --- | ---
`name` | none | Specifies the input parameter name.
`scope` | `request.parameter` | (optional) Specifies the scope from which the input parameter is retrieved. Allowed values are `context.attribute`, `request.header`, `request.parameter`, `request.cookie`, `session.id`, and `session.attribute`.

## refresh-period-in-seconds

Specifies the rate at which a read-only-bean must be refreshed from the data source. If the value is less than or equal to zero, the bean is never refreshed; if the value is greater than zero, the bean instances are refreshed at the specified interval. This rate is just a hint to the container. Default is 0 (no refresh).

### Superelements

ejb (`sun-ejb-jar.xml`)

### Subelements

none - contains data

## removal-timeout-in-seconds

Specifies the amount of time a bean instance can remain idle in the container before it is removed (timeout). A value of 0 specifies that the container does not remove inactive beans automatically. The default value is 5400.

If `removal-timeout-in-seconds` is less than or equal to `cache-idle-timeout-in-seconds`, beans are removed immediately without being passivated.

Applies to stateful session beans.

For related information, see cache-idle-timeout-in-seconds.

### Superelements

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

### Subelements

none - contains data

## remote-home-impl

Specifies the fully-qualified class name of the generated `EJBHome` `impl` class.

Note –

This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment.

### Superelements

gen-classes (`sun-ejb-jar.xml`)

### Subelements

none - contains data

## remote-impl

Specifies the fully-qualified class name of the generated `EJBObject` `impl` class.

Note –

This value is automatically generated by the server at deployment or redeployment time. Do not specify it or change it after deployment.

### Superelements

gen-classes (`sun-ejb-jar.xml`)

### Subelements

none - contains data

## request-policy

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

### Superelements

provider-config (`sun-acc.xml`)

### Subelements

none

### Attributes

The following table describes attributes for the `request-policy` element.

Table A–86 `request-policy` Attributes

Attribute | Default | Description
--- | --- | ---
`auth-source` | none | Specifies the type of required authentication, either `sender` (user name and password) or `content` (digital signature).
`auth-recipient` | none | Specifies whether recipient authentication occurs before or after content authentication. Allowed values are `before-content` and `after-content`.

## request-protection

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

### Superelements

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

### Subelements

none

### Attributes

The following table describes attributes for the `request-protection` element.

Table A–87 `request-protection` Attributes

Attribute | Default | Description
--- | --- | ---
`auth-source` | none | Specifies the type of required authentication, either `sender` (user name and password) or `content` (digital signature).
`auth-recipient` | none | Specifies whether recipient authentication occurs before or after content authentication. Allowed values are `before-content` and `after-content`.

## required

Specifies whether the authentication method specified must be used for client authentication. The value is `true` or `false`.

### Superelements

as-context (`sun-ejb-jar.xml`)

### Subelements

none - contains data

## res-ref-name

Specifies the `res-ref-name` in the corresponding J2EE deployment descriptor file `resource-ref` entry. The `res-ref-name` element specifies the name of a resource manager connection factory reference. The name must be unique within an enterprise bean.

### Superelements

resource-ref (`sun-web.xml`, `sun-ejb-jar.xml`, `sun-application-client.xml`)

### Subelements

none - contains data

## resize-quantity

Specifies the number of bean instances to be:

- Created, if a request arrives when the pool has less than steady-pool-size quantity of beans (applies to pools only for creation). If the pool has more than `steady-pool-size` minus resize-quantity of beans, then `resize-quantity` is still created.

- Removed, when the pool-idle-timeout-in-seconds timer expires and a cleaner thread removes any unused instances.

  - For caches, when max-cache-size is reached, `resize-quantity` beans are selected for passivation using the victim-selection-policy. In addition, the cache-idle-timeout-in-seconds or removal-timeout-in-seconds timers passivate beans from the cache.

  - For pools, when the max-pool-size is reached, `resize-quantity` beans are selected for removal. In addition, the pool-idle-timeout-in-seconds timer removes beans until `steady-pool-size` is reached.

Values are from 0 to MAX_INTEGER. The pool is not resized below the `steady-pool-size`. Default is 16.

Applies to stateless session beans, entity beans, and message-driven beans.

For EJB pools, the value can be defined in the EJB container. Default is 16.

For EJB caches, the value can be defined in the EJB container. Default is 32.

For message-driven beans, the value can be defined in the EJB container. Default is 2.

### Superelements

bean-cache, bean-pool (`sun-ejb-jar.xml`)

### Subelements

none - contains data

## resource-adapter-mid

Specifies the module ID of the resource adapter that is responsible for delivering messages to the message-driven bean.

### Superelements

mdb-resource-adapter (`sun-ejb-jar.xml`)

### Subelements

none - contains data

## resource-env-ref

Maps the `res-ref-name` in the corresponding J2EE deployment descriptor file `resource-env-ref` entry to the absolute `jndi-name` of a resource.

### 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 `resource-env-ref` element.

Table A–88 `resource-env-ref` Subelements

Element | Required | Description
--- | --- | ---
resource-env-ref-name | only one | Specifies the `res-ref-name` in the corresponding J2EE deployment descriptor file `resource-env-ref` entry.
jndi-name | only one | Specifies the absolute `jndi-name` of a resource.

### Example

    <resource-env-ref>
       <resource-env-ref-name>jms/StockQueueName</resource-env-ref-name>
       <jndi-name>jms/StockQueue</jndi-name>
    </resource-env-ref>

## resource-env-ref-name

Specifies the `res-ref-name` in the corresponding J2EE deployment descriptor file `resource-env-ref` entry.

### Superelements

resource-env-ref (`sun-web.xml`, `sun-ejb-jar.xml`, `sun-application-client.xml`)

### Subelements

none - contains data

## resource-ref

Maps the `res-ref-name` in the corresponding J2EE deployment descriptor file `resource-ref` entry to the absolute `jndi-name` of a resource.

Note –

Connections acquired from JMS connection factories are not shareable in the current release of the Application Server. The `res-sharing-scope` element in the `ejb-jar.xml` file `resource-ref` element is ignored for JMS connection factories.

When `resource-ref` specifies a JMS connection factory for the Sun Java System Message Queue, the `default-resource-principal` (name/password) must exist in the Message Queue user repository. Refer to the Security Management chapter in the Sun Java System Message Queue 3 2005Q4 Administration Guide for information on how to manage the Message Queue user repository.

### 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 `resource-ref` element.

Table A–89 `resource-ref` Subelements

Element | Required | Description
--- | --- | ---
res-ref-name | only one | Specifies the `res-ref-name` in the corresponding J2EE deployment descriptor file `resource-ref` entry.
jndi-name | only one | Specifies the absolute `jndi-name` of a resource.
default-resource-principal | zero or one | Specifies the default principal (user) for the resource.

### Example

    <resource-ref>
       <res-ref-name>jdbc/EmployeeDBName</res-ref-name>
       <jndi-name>jdbc/EmployeeDB</jndi-name>
    </resource-ref>

## response-policy

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

### Superelements

provider-config (`sun-acc.xml`)

### Subelements

none

### Attributes

The following table describes attributes for the `response-policy` element.

Table A–90 `response-policy` Attributes

Attribute | Default | Description
--- | --- | ---
`auth-source` | none | Specifies the type of required authentication, either `sender` (user name and password) or `content` (digital signature).
`auth-recipient` | none | Specifies whether recipient authentication occurs before or after content authentication. Allowed values are `before-content` and `after-content`.

## response-protection

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

### Superelements

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

### Subelements

none

### Attributes

The following table describes attributes for the `response-protection` element.

Table A–91 `response-protection` Attributes

Attribute | Default | Description
--- | --- | ---
`auth-source` | none | Specifies the type of required authentication, either `sender` (user name and password) or `content` (digital signature).
`auth-recipient` | none | Specifies whether recipient authentication occurs before or after content authentication. Allowed values are `before-content` and `after-content`.

## role-name

Contains the `role-name` in the `security-role` element of the corresponding J2EE deployment descriptor file.

### Superelements

security-role-mapping (`sun-application.xml`, `sun-web.xml`, `sun-ejb-jar.xml`)

### Subelements

none - contains data

- Previous: Q
- Next: S

- © 2010, Oracle Corporation and/or its affiliates