extension-module (Sun GlassFish Communications Server 1.5 Administration Reference)

Sun GlassFish Communications Server 1.5 Administration Reference

extension-module

Specifies a deployed extension module.

Superelements

applications

Subelements

The following table describes subelements for the extension-module element.

Table 1–67 extension-module 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 extension-module element.

Table 1–68 extension-module Attributes


Attribute	Default	Description
`name`	none	The name of the extension module.
`location`	none	The location of the extension module in the Communications Server file system.
`module-type`	none	Specifies a `String` that identifies the extension module type, which the runtime uses to find the appropriate add-on container. When an extension module is registered with the Communications Server, the Communications Server specifies the module type automatically. For example, the module type for a Session Initiation Protocol (SIP) servlet is `com.sun.enterprise.deployment.backend.extensions.sip.SipArchiveDeployer`.
`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 the extension module is enabled.
`libraries`	none	(optional) Specifies an absolute or relative path to libraries specific to this module or application. A relative path is relative to `domain-dir/lib/applibs`. If the path is absolute, the path must be accessible to the domain administration server (DAS), which means it must be under `domain-dir`. To include more than one path, use a system-specific separator, such as a colon for Solaris or a semicolon for Windows. The libraries are made available to the application in the order in which they are specified.
`availability-enabled`	`false`	(optional) Specifies whether availability is enabled in this extension module. Availability must also be enabled for the application or stand-alone extension module during deployment. For more information about availability, see availability-service.
`directory-deployed`	`false`	(optional) Specifies whether the application has been deployed as a directory.

Properties

The following table describes properties for the extension-module element.

Table 1–69 extension-module Properties


Property	Default	Description
`context-root`	none	The context root at which the SIP or converged web/SIP extension module is deployed. The context root can be the empty string or just `/`. The context root can start with the `/` character, but doesn’t have to. For load balancing to work, SIP or converged web/SIP extension module context roots must be unique within a cluster. See the Sun GlassFish Communications Server 1.5 High Availability Administration Guide for more information about load balancing. 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 1.5 Administration Guide.
`isConverged`	`false`	If `true`, specifies that the SIP extension module contains both SIP and HTTP servlets and is converged. If `false`, specifies that the SIP extension module contains only SIP servlets.