Sun GlassFish Communications Server 2.0 Administration Reference

P

persistence-manager-factory-resource

Defines a persistence manager factory resource for container-managed persistence (CMP). Deprecated, and included for backward compatibility only. Use a jdbc-resource element instead.

Superelements

resources

Subelements

The following table describes subelements for the persistence-manager-factory-resource element.

Table 1–155 persistence-manager-factory-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 persistence-manager-factory-resource element.

Table 1–156 persistence-manager-factory-resource Attributes


Attribute	Default	Description
`jndi-name`	none	Specifies the JNDI name for the resource.
`factory-class`	`com.sun.jdo.spi.persistence.support.sqlstore.impl.PersistenceManagerFactoryImpl`	(optional) Deprecated. Do not specify this attribute for the built-in CMP implementation.
`jdbc-resource-jndi-name`	none	Specifies the jdbc-resource from which database connections are obtained. Must be the `jndi-name` of an existing `jdbc-resource`.
`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.

principal

Contains the principal of the servlet, trusted entity, or EJB client.

Superelements

security-map, trusted-entity

Subelements

none - contains data

profiler

Configures a profiler for use with the Communications Server. For more information about profilers, see the Sun GlassFish Communications Server 2.0 Developer’s Guide.

Superelements

java-config

Subelements

The following table describes subelements for the profiler element.

Table 1–157 profiler Subelements


Element	Required	Description
jvm-options	zero or more	Contains profiler-specific JVM command line options.
property	zero or more	Specifies a property or a variable.

Note –

Subelements of a profiler element can occur in any order.

Attributes

The following table describes attributes for the profiler element.

Table 1–158 profiler Attributes


Attribute	Default	Description
`name`	none	Specifies the name of the profiler.
`classpath`	none	(optional) Specifies the classpath for the profiler.
`native-library-path`	none	(optional) Specifies the native library path for the profiler.
enabled	`true`	(optional) Determines whether the profiler is enabled.

property

Specifies a property. A property adds configuration information to its parent element that is one or both of the following:

Optional with respect to the Communications Server
Needed by a system or object that the Communications Server doesn’t have knowledge of, such as an LDAP server or a Java class

For example, an auth-realm element can include property subelements:
```
<auth-realm name="file"
     classname="com.sun.enterprise.security.auth.realm.file.FileRealm">
     <property name="file" value="domain-dir/config/keyfile"/>
     <property name="jaas-context" value="fileRealm"/>
 </auth-realm>
```
Which properties an auth-realm element uses depends on the value of the auth-realm element’s name attribute. The file realm uses file and jaas-context properties. Other realms use different properties.

Superelements

admin-object-resource, admin-service, alert-service, appclient-module, audit-module, auth-realm, availability-service, cluster, config, connector-connection-pool, connector-module, connector-resource, converged-lb-config, converged-lb-policy, custom-resource, das-config, diagnostic-service, domain, ejb-container, ejb-container-availability, ejb-module, ejb-timer-service, event, extension-module, external-jndi-resource, filter-config, group-management-service, http-listener, http-service, iiop-listener, j2ee-application, jacc-provider, java-config, jdbc-connection-pool, jdbc-resource, jms-host, jms-service, jmx-connector, lb-config, lifecycle-module, listener-config, load-balancer, log-service, mail-resource, management-rule, manager-properties, mbean, mdb-container, module-log-levels, module-monitoring-levels, monitoring-service, node-agent, orb, persistence-manager-factory-resource, profiler, provider-config, proxy, resource-adapter-config, security-service, server, session-properties, sip-container, sip-container-availability, sip-listener, sip-protocol, sip-service, stack-config, stack-layer, store-properties, transaction-service, trust-handler, virtual-server, web-container, web-container-availability, web-module

Subelements

The following table describes subelements for the property element.

Table 1–159 property Subelements


Element	Required	Description
description	zero or one	Contains a text description of this element.

Attributes

The following table describes attributes for the property element.

Table 1–160 property Attributes


Attribute	Default	Description
`name`	none	Specifies the name of the property or variable.
`value`	none	Specifies the value of the property or variable.

provider-config

Specifies a configuration for one message security provider.

Although the request-policy and response-policy subelements are optional, the provider-config element does nothing if they are not specified.

Use property subelements to configure provider-specific properties. Property values are passed to the provider when its initialize method is called.

Superelements

message-security-config

Subelements

The following table describes subelements for the provider-config element.

Table 1–161 provider-config Subelements


Element	Required	Description
request-policy	zero or one	Defines the authentication policy requirements of the authentication provider’s request processing.
response-policy	zero or one	Defines the authentication policy requirements of the authentication provider’s response processing.
property	zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the provider-config element.

Table 1–162 provider-config Attributes


Attribute	Default	Description
`provider-id`	none	Specifies a unique identifier for this `provider-config` element.
`provider-type`	none	Specifies whether the provider is a `client`, `server`, or `client-server` authentication provider.
`class-name`	none	Specifies the Java implementation class of the provider. Client authentication providers must implement the `com.sun.enterprise.security.jauth.ClientAuthModule` interface. Server authentication providers must implement the `com.sun.enterprise.security.jauth.ServerAuthModule` interface. Client-server providers must implement both interfaces.

Properties

The following table describes properties for the provider-config element.

Table 1–163 provider-config Properties


Property	Default	Description
`security.config`	`domain-dir/config/wss-server-config-1.0.xml`	Specifies the location of the message security configuration file. To point to a configuration file in the `domain-dir/config` directory, use the prefix `${com.sun.aas.instanceRoot}/config/`, for example: `${com.sun.aas.instanceRoot}/config/wss-server-config-1.0.xml`
`debug`	`false`	If `true`, enables dumping of server provider debug messages to the server log.
`dynamic.username.password`	`false`	If `true`, signals the provider runtime to collect the user name and password from the `CallbackHandler` for each request. If `false`, the user name and password for `wsse:UsernameToken(s)` is collected once, during module initialization. This property is only applicable for a `ClientAuthModule`.
`encryption.key.alias`	`s1as`	Specifies the encryption key used by the provider. The key is identified by its `keystore` alias.
`signature.key.alias`	`s1as`	Specifies the signature key used by the provider. The key is identified by its `keystore` alias.

proxy

Specifies the proxy for converged load balancing. This provides for pass-through of HTTP and SIP requests to remote HTTP and SIP listeners, which are configured using the http-service or sip-service of the remote instance.

Note –

Some topics in the documentation pertain to features that are available only in domains that are configured to support clusters. Examples of domains that support clusters are domains that are created with the cluster profile. For information about profiles, see Usage Profiles in Sun GlassFish Communications Server 2.0 Administration Guide.

Superelements

converged-load-balancer

Subelements

The following table describes subelements for the proxy element.

Table 1–164 proxy Subelements


Element	Required	Description
property	zero or more	Specifies a property or a variable.

Attributes

The following table describes attributes for the proxy element.

Table 1–165 proxy Attributes


Attribute	Default	Description
`request-pool-size`	`50`	Specifies the number of request objects created and pooled by the proxy.
`send-retry-count`	`3`	Specifies the number of retries the proxy attempts with the remote instance when sending of data fails.
`read-time-out`	`1500`	Specifies in milliseconds how long the proxy waits for data from the client in the socket channel.

Properties

The following table describes properties for the proxy element.

Table 1–166 proxy Properties


Attribute	Default	Description
`max-parallel-connections`	none	Specifies the maximum number of outbound connections to a back-end instance.
`high-water-mark`	none	Specifies the maximum number of active outbound connections the controller handles.
`connections-to-reclaim`	none	Specifies the number of LRU connections reclaimed if the `high-water-mark` limit is reached.
`proxy-server-read-timeout`	none	Specifies the timeout for the proxy to read from the server channel once a response is available.
`socket-receive-buffer-size`	none	Specifies the proxy back-end socket receive buffer size.
`socket-send-buffer-size`	none	Specifies the proxy back-end socket send buffer size.
`client-socket-read-timeout`	none	Specifies the client socket send read timeout.