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

- Previous: Subelements
- Next: Examples

### Attributes

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

Table 3–6 `sun-appserv-deploy` Attributes

Attribute | Default | Description
--- | --- | ---
`file` | none | (optional if a `component` or `fileset` subelement is present, otherwise required) The component to deploy. 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. If `upload` is set to `false`, this must be an absolute path on the server machine.
`name` | file name without extension | (optional) The display name for the component being deployed.
`type` | determined by extension | (optional) Deprecated.
`force` | `true` | (optional) If `true`, the component is overwritten if it already exists on the server. If `false`, `sun-appserv-deploy` fails if the component exists.
`retrievestubs` | client stubs not saved | (optional) The directory where client stubs are saved. This attribute is inherited by nested `component` elements.
`precompilejsp` | `false` | (optional) If `true`, all JSP files found in an enterprise application (`.ear`) or web application (`.war`) are precompiled. This attribute is ignored for other component types. This attribute is inherited by nested `component` elements.
`verify` | `false` | (optional) If `true`, syntax and semantics for all deployment descriptors are automatically verified for correctness. This attribute is inherited by nested `component` elements.
`contextroot` | file name without extension | (optional) The context root for a web module (WAR file). This attribute is ignored if the component is not a WAR file.
`dbvendorname` | `sun-ejb-jar.xml` entry | (optional) The name of the database vendor for which tables can be created. Allowed values are `db2`, `mssql`, `oracle`, `pointbase`, and `sybase`, case-insensitive. If not specified, the value of the `database-vendor-name` attribute in `sun-ejb-jar.xml` is used. If no value is specified, a connection is made to the resource specified by the `jndi-name` subelement of the `cmp-resource` element in the `sun-ejb-jar.xml` file, and the database vendor name is read. If the connection cannot be established, or if the value is not recognized, SQL-92 compliance is presumed. For details, see Generation Options.
`createtables` | `sun-ejb-jar.xml` entry | (optional) If `true`, causes database tables to be created for beans that need them. If `false`, does not create tables. If not specified, the value of the `create-tables-at-deploy` attribute in `sun-ejb-jar.xml` is used. For details, see Generation Options.
`dropandcreatetables` | `sun-ejb-jar.xml` entry | (optional) If `true`, and if tables were automatically created when this application was last deployed, tables from the earlier deployment are dropped and fresh ones are created. If `true`, and if tables were not automatically created when this application was last deployed, no attempt is made to drop any tables. If tables with the same names as those that would have been automatically created are found, the deployment proceeds, but a warning indicates that tables could not be created. If `false`, settings of `create-tables-at-deploy` or `drop-tables-at-undeploy` in the `sun-ejb-jar.xml` file are overridden. For details, see Generation Options.
`uniquetablenames` | `sun-ejb-jar.xml` entry | (optional) If `true`, specifies that table names are unique within each application server domain. If not specified, the value of the `use-unique-table-names` property in `sun-ejb-jar.xml` is used. For details, see Generation Options.
`enabled` | `true` | (optional) If `true`, enables the component.
`deploymentplan` | none | (optional) A deployment plan is a JAR file containing Sun-specific descriptors. Use this attribute when deploying an EAR file that lacks Sun-specific descriptors.
`upload` | `true` | (optional) If `true`, the component is transferred to the server for deployment. If the component is being deployed on the local machine, set upload to `false` to reduce deployment time. If a directory is specified for deployment, upload must be `false`.
`virtualservers` | default virtual server only | (optional) A comma-separated list of virtual servers to be deployment targets. This attribute applies only to application (`.ear`) or web (`.war`) components and is ignored for other component types.
`user` | `admin` | (optional) The user name used when logging into the application server.
`password` | none | (optional) Deprecated, use `passwordfile` instead. The password used when logging into the application server.
`passwordfile` | none | (optional) File containing passwords. The password from this file is retrieved for communication with the application server. If both `password` and `passwordfile` are specified, `passwordfile` takes precedence.
`host` | `localhost` | (optional) Target server. When deploying to a remote server, use the fully qualified host name.
`port` | `4848` | (optional) The administration port on the target server.
`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.

- Previous: Subelements
- Next: Examples

- © 2010, Oracle Corporation and/or its affiliates