Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
deploy [--help] [--force={false|true}] [--virtualservers virtual_servers] [--contextroot context_root] [--precompilejsp={false|true}] [--verify={false|true}] [--name component_name] [--upload={true|false}] [--retrieve local_dirpath] [--dbvendorname dbvendorname] [--createtables={true|false}|--dropandcreatetables={true|false}] [--uniquetablenames={true|false}] [--deploymentplan deployment_plan] [--enabled={true|false}] [--generatermistubs={false|true}] [--availabilityenabled={false|true}] [--libraries jar_file[,jar_file]*] [--target target] [--type pkg-type] [--properties(name=value)[:name=value]*] filepath
The deploy subcommand deploys applications to the server. Applications can be enterprise applications, web applications, Enterprise JavaBeans (EJB) modules, connector modules, and application client modules. If the component is already deployed or already exists, it is forcibly redeployed if the --force option is set to true (default is false).
This subcommand is supported in remote mode only.
Displays the help text for the subcommand.
If set to true, redeploys the component even if the specified component has already been deployed or already exists. Default is false.
One or more virtual server IDs. Multiple IDs are separated by commas.
Valid only if the archive is a web module. It is ignored for other archive types; defaults to filename without extension.
By default this option does not allow the JSP to be precompiled during deployment. Instead, JSPs are compiled during runtime. Default is false.
If set to true and the required verifier packages are installed from the Update Center, the syntax and semantics of the deployment descriptor is verified. Default is false.
Name of the deployable component.
Uploads the deployable file to the administration server. The deployable file must be accessible from the client. If the file is accessible to both server and client, set the --upload option to false. The default value depends on whether the server you are deploying to is local or remote. If the server is local, the option defaults to false. If the server is remote, the option defaults to true. Explicitly specifying true or false overrides the default.
Retrieves the client stub JAR file from the server machine to the local directory.
Specifies the name of the database vendor for which tables are created. Supported values include db2, mssql, mysql, oracle, derby, javadb, postgresql, pointbase, and sybase. These values are 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.
If specified as true, creates tables at deployment of an application with unmapped CMP beans. If specified as false, tables are not created. If not specified, the value of the create-tables-at-deploy entry in the cmp-resource element of the sun-ejb-jar.xml file determines whether or not tables are created.
If specified as true when the component is redeployed, the tables created by the previous deployment are dropped before creating the new tables. Applies to deployed applications with unmapped CMP beans. Preexisting tables will not be dropped on the initial deployment of an application or on a deployment that follows an explicit undeploy. If specified as false, tables are neither dropped nor created. If not specified, the tables are dropped if the drop-tables-at-undeploy entry in the cmp-resource element of the sun-ejb-jar.xml file is set to true, and the new tables are created if the create-tables-at-deploy entry in the cmp-resource element of the sun-ejb-jar.xml file is set to true.
Guarantees unique table names for all the beans and results in a hash code added to the table names. This is useful if you have an application with case-sensitive bean names. Applies to applications with unmapped CMP beans.
Deploys the deployment plan, which is a JAR file that contains GlassFish Server descriptors. Specify this option when deploying a pure EAR file. A pure EAR file is an EAR without GlassFish Server descriptors.
Allows users to access the application. If set to false, users will not be able to access the application. Default is true.
If set to true, static RMI-IIOP stubs are generated and put into the client.jar. If set to false, the stubs are not generated. Default is false.
Do not specify this option. This option is retained for compatibility with other releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and the option is silently ignored.
A comma-separated list of library JAR files. Specify the library JAR files by their relative or absolute paths. Specify relative paths relative to instance-root/lib/applibs. The libraries are made available to the application in the order specified.
Do not specify this option. This option is retained for compatibility with other releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and the option is silently ignored.
The packaging archive type of the component that is being deployed. Possible values are as follows:
The component is packaged as an OSGi Alliance bundle.
The --type option is optional. If the component is packaged as a regular archive, omit this option.
Optional keyword-value pairs that specify additional properties for the deployment. The available properties are determined by the implementation of the component that is being deployed or redeployed. The --properties option and the --property option are equivalent. You can use either option regardless of the number of properties that you specify.
For properties that contain . (dot) separators in their names, using the set subcommand to change these properties requires a server restart. A better approach is to use the redeploy subcommand with the changed properties. If you do use the set subcommand, the . (dot) separators in these properties names must be escaped.
You can specify the following properties for a deployment:
Specifies the alias for the security certificate with which the application client container JAR file is signed. Java Web Start will not run code that requires elevated permissions unless it resides in a JAR file signed with a certificate that the user's system trusts. For your convenience, GlassFish Server signs the JAR file automatically using the certificate with this alias from the domain's keystore. Java Web Start then asks the user whether to trust the code and displays the GlassFish Server certificate information. To sign this JAR file with a different certificate, add the certificate to the domain keystore, then use this property. For example, you can use a certificate from a trusted authority, which avoids the Java Web Start prompt, or from your own company, which users know they can trust. Default is s1as, the alias for the self-signed certificate created for every domain.
Specifies whether Java Web Start access is permitted for an application client module. Default is true.
Specifies the directory where JRuby itself (not the GlassFish Server JRuby container) is installed. Default is as-install/jruby.
Specifies the initial number of JRuby runtimes to start. Must be greater than zero, greater than or equal to jruby.runtime.min, and less than or equal to jruby.runtime.max. Default is 1. Overrides JRuby container runtime pool settings. For more information, see the configure-jruby-container(1) help page.
Specifies the minimum number of JRuby runtimes in the pool. Must be greater than zero, less than or equal to jruby.runtime and jruby.runtime.max. Default is 1. Overrides JRuby container runtime pool settings. For more information, see the configure-jruby-container(1) help page.
Specifies the maximum number of JRuby runtimes in the pool. Must be greater than zero, greater than or equal to jruby.runtime and jruby.runtime.min. Overrides JRuby container runtime pool settings. Default is 1. For more information, see the configure-jruby-container(1) help page.
Specifies the environment in which a JRuby application such as Rails or Merb runs. Allowed values are development, production, or test. Default is development.
Specifies the name of a supported framework or the path to a script that initializes the user's framework. Allowed values corresponding to supported frameworks are Rails, Merb, or Sinatra. Setting this property bypasses the normal, and potentially lengthy, auto-detection process and forces deployment on the specified framework. If the deployed application is not written for the specified framework, errors result. Default is computed through auto-detection.
If true, specifies that a framework being started using jruby.applicationType is thread-safe and therefore does not need a pool created for it. This property affects applications started using an auto-detected user-provided startup script. If jruby.applicationType is set and jruby.MTsafe is not set or is set to false, the application starts with a pool of application instances, and each instance of the application is accessed by one thread at a time. This property only affects frameworks being launched where the thread safety cannot be automatically determined. Setting jruby.MTsafe to true does not cause an auto-detected Rails 2.1.x application to be launched in thread-safe mode, nor can it be used to force a thread-safe framework to start in pooled mode. Default is computed through auto-detection.
Specifies the GlassFish Server release with which to be backward compatible in terms of JAR visibility requirements for applications. The only allowed value is v2, which refers to Sun GlassFishTM Enterprise Server version 2 or Sun JavaTM System Application Server version 9.1 or 9.1.1. The Java EE 6 platform specification imposes stricter requirements than Java EE 5 did on which JAR files can be visible to various modules within an EAR file. In particular, application clients must not have access to EJB JAR files or other JAR files in the EAR file unless references use the standard Java SE mechanisms (extensions, for example) or the Java EE library-directory mechanism. Setting this property to v2 removes these Java EE 6 restrictions.
If the --force option is set to true, this property can by used to specify whether active sessions of the application that is being redeployed are preserved and then restored when the redeployment is complete. Applies to HTTP sessions in a web container. Default is false.
Active sessions of the application are not preserved and restored (default).
Active sessions of the application are preserved and restored.
If any active session of the application fails to be preserved or restored, none of the sessions will be available when the redeployment is complete. However, the redeployment continues and a warning is logged.
To preserve active sessions, GlassFish Server serializes the sessions and saves them in memory. To restore the sessions, the class loader of the newly redeployed application deserializes any sessions that were previously saved.
Other available properties are determined by the implementation of the component that is being redeployed.
if the --upload option is set to true, this is the path to the deployable file on the local client machine. Otherwise, this is the absolute path to the file on the server machine.
This example deploys the enterprise application packaged in the Cart.ear file.
asadmin> deploy Cart.ear Application deployed successfully with name Cart. Command deploy executed successfully |
This example deploys the web application in the hello.war file.
asadmin> deploy hello.war Application deployed successfully with name hello. Command deploy executed successfully |
This example forcibly deploys the web application in the hello.war file. The context root of the deployed web application is greetings. If the application has already been deployed, it is redeployed.
asadmin> deploy --force=true --contextroot greetings hello.war Application deployed successfully with name hello. Command deploy executed successfully |
This example deploys a component based on the EJBTM specification (enterprise bean) with CMP and creates the database tables used by the bean.
asadmin> deploy --createtables=true EmployeeEJB.jar Application deployed successfully with name EmployeeEJB. Command deploy executed successfully |
This example deploys a connector module that is packaged in an RAR file.
asadmin> deploy jdbcra.rar Application deployed successfully with name jdbcra. Command deploy executed successfully |
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also