<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY Dash "&ndash;">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="create-lifecycle-module-1">
<refmeta><refentrytitle>create-lifecycle-module</refentrytitle><manvolnum>
1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="create-lifecycle-module">create-lifecycle-module &mdash;
adds a lifecycle module</primary></indexterm><indexterm><primary sortas="adds a lifecycle module">
adds a lifecycle module &mdash; create-lifecycle-module</primary></indexterm>
<refname>create-lifecycle-module</refname><refpurpose>adds a lifecycle module
</refpurpose></refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>create-lifecycle-module</command><arg choice="plain">&Dash;&Dash;classname <replaceable>
classname</replaceable></arg>&synopsis-common;
<arg>&Dash;&Dash;enabled=<replaceable>true</replaceable></arg><arg choice="opt">&Dash;&Dash;target <replaceable>
target</replaceable></arg><arg choice="opt">&Dash;&Dash;classpath <replaceable>
classpath</replaceable></arg><arg choice="opt">&Dash;&Dash;loadorder <replaceable>
loadorder</replaceable></arg><arg choice="opt">&Dash;&Dash;failurefatal=false 
</arg><arg choice="opt">&Dash;&Dash;description <replaceable>description</replaceable></arg>
<arg><option role="nodash">&Dash;&Dash;property (<replaceable>name</replaceable>=<replaceable>
value</replaceable>)[:<replaceable>name</replaceable>=<replaceable>value</replaceable>]*
</option></arg><arg choice="plain"><replaceable>module_name</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>Creates the lifecycle module. The lifecycle modules provide a means
of running short or long duration Java-based tasks within the application
server environment. This command is supported in remote mode only.</para>
</refsect1>
<refsect1><title>&opts-tt;</title>
<variablelist termlength="medium">
<varlistentry><term><option role="nodash">&Dash;&Dash;classname</option></term>
<listitem><para>This is the fully qualified name of the startup class.</para>
</listitem></varlistentry>&options-common;
<?Pub Caret>
<varlistentry><term><option role="nodash">&Dash;&Dash;target</option></term>
<listitem><para>Indicates the location where the lifecycle is to be created.
The valid targets for this command are configuration, instance, cluster, and
server. The default is server.</para>
<para></para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;classpath</option></term>
<listitem><para>This option indicates where this module is actually located
if it is not under applications-root.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;loadorder</option></term>
<listitem><para>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.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;failurefatal</option></term>
<listitem><para>This options tells the system what to do if the lifecycle
module does not load correctly. When this option is set to true, the system
aborts the server startup if this module does not load properly. The default
value is false.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;enabled</option></term>
<listitem><para>This option determines whether the resource is enabled at
runtime. The default values is true.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;description</option></term>
<listitem><para>This is the text description of the resource associated with
this module.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;property</option></term>
<listitem><para>This is an optional attribute containing name/value pairs
used to configure the resource.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&oper-tt;</title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>module_name</replaceable></term><listitem>
<para>This operand is a unique identifier for the deployed server lifecycle
event listener module.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</title>
<example>
<title>using create-lifecycle-module</title>
<screen>asadmin> <userinput>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</userinput>
Command create-lifecycle-module executed successfully</screen>
<para>Where: <command>customSetup</command> is the lifecycle module created.
The escape character \ is used in the property option to distinguish the colons
(:).</para>
</example>
</refsect1>
<refsect1><title>&exit-tt;</title>
<variablelist termlength="medium">
<varlistentry><term>0</term><listitem><para>command executed successfully
</para>
</listitem></varlistentry>
<varlistentry><term>1</term><listitem><para>error in executing the command
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&also-tt;</title>
<para><link linkend="delete-lifecycle-module-1"><citerefentry><refentrytitle>
delete-lifecycle-module</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="list-lifecycle-modules-1"><citerefentry><refentrytitle>list-lifecycle-modules
</refentrytitle><manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000006199>
