blob: 1a29f3ebf8aa23b189772557d2cbe730ab528908 [file] [log] [blame]
<!--
Copyright (c) 2005, 2018 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->
<p><a id="task-lifecyclemodulenew" name="task-lifecyclemodulenew"></a><a id="GHCOM00169" name="GHCOM00169"></a></p>
<h4><a id="sthref63" name="sthref63"></a>To Create a Lifecycle Module</h4>
<a name="BEGIN" id="BEGIN"></a>
<ol>
<li>
<p>In the navigation tree, select the Lifecycle Modules node.</p>
<p>The Lifecycle Modules page opens.</p>
</li>
<li>
<p>On the Lifecycle Modules page, click New.</p>
<p>The New Lifecycle Module page opens.</p>
</li>
<li>
<p>In the Name field, type a name for the lifecycle module.</p>
</li>
<li>
<p>In the Class Name field, type the fully qualified name of the lifecycle module's class file.</p>
<p>The class must implement the <code>com.sun.appserv.server.LifecycleListener</code> interface.</p>
</li>
<li>
<p>In the Classpath field, type the classpath for the lifecycle module.</p>
<p>The classpath specifies where the lifecycle module is located. The default value is <i>domain-dir</i><code>/applications</code>. If the module is already in this directory (that is, in the server classpath), this field can be left blank.</p>
</li>
<li>
<p>In the Load Order field, type a value specifying the order in which this lifecycle module is to be loaded at startup.</p>
<p>Modules with smaller integer load order values are loaded sooner. The value can range from 101 to the operating system's <code>MAXINT</code>. Values from 1 to 100 are reserved.</p>
</li>
<li>
<p>In the Description field, type a description of the lifecycle module.</p>
</li>
<li>
<p>Select the Status Enabled checkbox to enable the lifecycle module.</p>
<p>This option is enabled by default.</p>
</li>
<li>
<p>Select the On Load Failure Prevent Instance Startup checkbox to specify that the server is to be shut down if the lifecycle module fails to load.</p>
<p>This option is disabled by default.</p>
</li>
<li>
<p>To add target server instances and clusters on which to enable the lifecycle module, select them from the Available Targets list and use the Add button to move them to the Selected Targets list.</p>
<p>The Target option appears if clusters or standalone server instances aside from the default server instance (<code>server</code>) exist. By default, the lifecycle module is enabled on the default server instance, named <code>server</code>. Use the Add All button to deploy to all targets. Use the Remove and Remove All buttons to remove targets from the Selected Targets list.</p>
</li>
<li>
<p>Click OK.</p>
</li>
</ol>
<a id="GHCOM266" name="GHCOM266"></a>
<h5>See Also</h5>
<ul>
<li>
<p><a href="task-lifecyclemoduleedit.html">To Edit a Lifecycle Module</a></p>
</li>
<li>
<p><a href="task-lifecyclemoduledelete.html">To Delete a Lifecycle Module</a></p>
</li>
</ul>
<small>Copyright &#169; 2005, 2017, Oracle and/or its affiliates. All rights reserved. <a href="docinfo.html">Legal Notices</a></small>