create-lifecycle-module(1) (Sun Java System Application Server Enterprise Edition 8.2 Reference Manual)

Sun Java System Application Server Enterprise Edition 8.2 Reference Manual

create-lifecycle-module(1)

NAME

create-lifecycle-module– adds a lifecycle module

SYNOPSIS

create-lifecycle-module

admin_user

filename

localhost

4849

–s

false

true

target

classname

classpath

loadorder

description

––property (name=value)[:name=value]*

module_name

DESCRIPTION

Creates the lifecycle module. The lifecycle modules provide ameans of running short or long duration Java-based tasks within the application server environment. This command is supported in remote mode only.

OPTIONS

–u ––user: The authorized domain administration server administrative username.
–w ––password: The ––password option is deprecated. Use ––passwordfile instead.
––passwordfile: This option replaces the –– password option. Using the ––password option on the command line or through the environment is deprecated. The ––passwordfile option specifies the name of a file containing the password entries in a specified format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in capital letters. For example, to specify the domain administration server password, use an entry with the following format: AS_ADMIN_PASSWORD=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, AS_ADMIN_MQPASSWORD, AS_ADMIN_ALIASPASSWORD, and so on.
–H ––host: The machine name where the domain administration server is running. The default value is localhost.
–p ––port: The port number of the domain administration server listening for administration requests. The default port number for Enterprise Edition is 4849.
–s ––secure: If set to true, uses SSL/TLS to communicate with the domain administration server.
–t ––terse: Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.
–e ––echo: Setting to true will echo the command line statement on the standard output. Default is false.
–I ––interactive: If set to true (default), only the required password options are prompted.
––help: Displays the help text for the command.
––target: This option is the name of the resulting location. The valid targets for this command are configuration, instace, cluster, or server. This is used by EE only.
––classname: This is the fully qualified name of the startup class.
––classpath: This option indicates where this module is actually located if it is not under applications-root.
––loadorder: This option represents an integer value that can be used to force the order in which deployed lifecycle modules are loaded at server startup. Smaller numbered modules get loaded sooner. Order is unspecified if two or more lifecycle modules have the same load-order value.
––failurefatal: This options tells the system what to do if the lifecycle module does not load correctly. If this option is set to true, then the system aborts the server startup if this module does not load properly.
––enabled: This option determines whether the resource is enabled at runtime.
––description: This is the text description of the resource associated with this module.
––property: This is an optional attribute containing name/value pairs used to configure the resource.

OPERANDS

module_name: This operand is a unique identifier or the deployed server lifecycle event listener module.

EXAMPLES

Example 1 using create-lifecycle-module

asadmin> create-lifecycle-module --user admin --passwordfile adminpassword.txt
--host fuyako --port 7070 --classname "com.acme.CustomSetup" 
--classpath "/export/customSetup" --loadorder 1 --failurefatal=true 
--description "this is a sample customSetup" 
--property rmi="Server\=acme1\:7070":timeout=30 customSetup
Command create-lifecycle-module executed successfully

Where: customSetup is the lifecycle module created. The escape character \ is used in the property option to distinguish the colons (:).

EXIT STATUS

0: command executed successfully
1: error in executing the command