<!--Arbortext, Inc., 1988-2008, v.4002-->
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD SolBook 3.5//EN" [
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "common.ent">
%commonents;
]>
<?Pub UDT _bookmark _target>
<?Pub EntList bull rArr sect>
<?Pub Inc>
<refentry id="create-lifecycle-module-1"><?Pub Tag atict:info tracking="off"
ref="2"><?Pub Tag atict:user user="hl34125" fullname=""><?Pub Tag atict:user
user="pmdavies" fullname=""><?Pub Tag atict:user user="ah95648" fullname="">
<!-- @(#)create-lifecycle-module.1 1.9 07/04/25 SMI; -->
<refmeta><refentrytitle>create-lifecycle-module</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">30 Jan 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright (c) 2007, Sun Microsystems, Inc.
All Rights Reserved</refmiscinfo>
</refmeta>
<refnamediv><indexterm><primary>create-lifecycle-module</primary></indexterm>
<indexterm><primary>adds a lifecycle module</primary></indexterm>
<refname>create-lifecycle-module</refname><refpurpose>adds a lifecycle module</refpurpose>
</refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>create-lifecycle-module</command>  <option role="double-dash">
classname</option> <replaceable>classname</replaceable>&synopsis-common;
 [<option role="double-dash">enabled</option>=<replaceable>true</replaceable>] [<option
role="double-dash">target</option> <replaceable>target</replaceable>]
 [<option role="double-dash">classpath</option> <replaceable>classpath</replaceable>] [<option
role="double-dash">loadorder</option> <replaceable>loadorder</replaceable>]
 [<option role="double-dash">failurefatal</option>=false ] [<option
role="double-dash">description</option> <replaceable>description</replaceable>]
 [<option role="double-dash">property</option> (<replaceable>name</replaceable>=<replaceable>
value</replaceable>)[:<replaceable>name</replaceable>=<replaceable>value</replaceable>]*]
 <replaceable>module_name</replaceable></synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>Creates the lifecycle module. The lifecycle modules provide a means
of running short or long duration Java-based tasks within the <?Pub Caret>environment.
This command is supported in remote mode only.</para>
</refsect1>
<refsect1 role="options"><title></title>
<variablelist termlength="medium">
<varlistentry><term><option role="double-dash">classname</option></term>
<listitem><para>This is the fully qualified name of the startup class.</para>
</listitem>
</varlistentry>&options-common;
<varlistentry><term><option role="double-dash">target</option></term>
<listitem><para>Indicates the location where the lifecycle is to be created.
The valid targets for this command are name of a configuration, instance,
cluster, and server. The default is server, which is the name of the default
server instance.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-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="double-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="double-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="double-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="double-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="double-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 role="operands"><title></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 role="examples"><title></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 role="exit-status"><title></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 role="see-also"><title></title>
<para><olink targetdoc="ASREFMAN" targetptr="delete-lifecycle-module-1">delete-lifecycle-module(1)
</olink>, <olink targetdoc="ASREFMAN" targetptr="list-lifecycle-modules-1">list-lifecycle-modules(1)
</olink></para>
</refsect1>
</refentry>
