sun-appserv-component (Sun Java System Application Server Enterprise Edition 8.2 Developer's Guide)

Sun Java System Application Server Enterprise Edition 8.2 Developer's Guide

sun-appserv-component

Enables or disables the following J2EE component types that have been deployed to the Application Server.

Enterprise application (EAR file)
Web application (WAR file)
Enterprise Java Bean (EJB-JAR file)
Enterprise connector (RAR file)
Application client

You don’t need to specify the archive to enable or disable a component: only the component name is required. You can use the component archive, however, because it implies the component name.

Subelements

The following table describes subelements for the sun-appserv-component task. These are objects upon which this task acts.

Table 3–11 sun-appserv-component Subelements


Element	Description
server	An Application Server instance.
component	A component to be deployed.
fileset	A set of component files that match specified parameters.

Attributes

The following table describes attributes for the sun-appserv-component task.

Table 3–12 sun-appserv-component Attributes


Attribute	Default	Description
`action`	none	The control command for the target application server. Valid values are `enable` and `disable`.
`name`	file name without extension	(optional if a `component` or `fileset` subelement is present or the `file` attribute is specified, otherwise required) The display name for the component being enabled or disabled.
`file`	none	(optional) The component to enable or disable. If this attribute refers to a file, it must be a valid archive. If this attribute refers to a directory, it must contain a valid archive in which all components have been exploded.
`type`	determined by extension	(optional) Deprecated.
`user`	`admin`	(optional) The user name used when logging into the application server administration instance. This attribute is inherited by nested `server` elements.
`password`	none	(optional) Deprecated, use `passwordfile` instead. The password used when logging into the application server administration instance. This attribute is inherited by nested `server` elements.
`passwordfile`	none	(optional) File containing passwords. The password from this file is retrieved for communication with the application server administration instance. This attribute is inherited by nested `server` elements. If both `password` and `passwordfile` are specified, `passwordfile` takes precedence.
`host`	`localhost`	(optional) Target server. When enabling or disabling a remote server, use the fully qualified host name. This attribute is inherited by nested `server` elements.
`port`	`4849`	(optional) The administration port on the target server. This attribute is inherited by nested `server` elements.
`target`	name of default instance	(optional) Target application server instance. This attribute is inherited by nested `server` elements.
`asinstalldir`	see description	(optional) The installation directory for the local Application Server installation, which is used to find the administrative classes. If not specified, the command checks to see if the `asinstalldir` parameter has been set. Otherwise, administrative classes must be in the system classpath.
`sunonehome`	see description	(optional) Deprecated. Use `asinstalldir` instead.

Examples

Here is a simple example of disabling a component:

<sun-appserv-component
 action="disable"
 name="simpleapp"
 passwordfile="${passwordfile}" />

Here is a simple example of enabling a component:

<sun-appserv-component
 action="enable"
 name="simpleapp"
 passwordfile="${passwordfile}" />

Here is an equivalent script showing all the implied attributes:

<sun-appserv-component
 action="enable"
 name="simpleapp"
 user="admin"
 passwordfile="${passwordfile}"
 host="localhost"
 port="4849"
 target="${default-instance-name}"
 asinstalldir="${asinstalldir}" />

This example demonstrates disabling multiple components using the archive files (EAR and WAR, in this case) and using the component name (for an EJB component in this example).

<sun-appserv-component action="disable" passwordfile="${passwordfile}">
 <component file="${assemble}/simpleapp.ear"/>
 <component file="${assemble}/simpleservlet.war"/>
 <component name="simplebean" />
</sun-appserv-component>

Components can be enabled or disabled on multiple servers in a single task. This example shows the same three components being enabled on two different instances of the Application Server. In this example, the passwords for both instances are the same.

<sun-appserv-component action="enable" passwordfile="${passwordfile}">
 <server host="greg.sun.com"/>
 <server host="joe.sun.com"/>
 <component file="${assemble}/simpleapp.ear"/>
 <component file="${assemble}/simpleservlet.war"/>
 <component name="simplebean" />
</sun-appserv-component>