diff --git a/community/docs/modules/ROOT/nav.adoc b/community/docs/modules/ROOT/nav.adoc index 7a27763bc..e8f453a3b 100644 --- a/community/docs/modules/ROOT/nav.adoc +++ b/community/docs/modules/ROOT/nav.adoc @@ -22,7 +22,6 @@ *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering the HealthCheck Service.adoc[Administering the HealthCheck Service] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering the Request Tracing Service.adoc[Administering the Request Tracing Service] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering the Notification Service.adoc[Administering the Notification Service] -*** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc[Administering Lifecycle Modules] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Batch Jobs.adoc[Administering Batch Jobs] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Database Connectivity.adoc[Administering Database Connectivity] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering EIS Connectivity.adoc[Administering EIS Connectivity] diff --git a/docs/modules/ROOT/pages/Technical Documentation/Application Development/Class Loaders.adoc b/docs/modules/ROOT/pages/Technical Documentation/Application Development/Class Loaders.adoc index cc15061d1..53d55f994 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Application Development/Class Loaders.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Application Development/Class Loaders.adoc @@ -58,11 +58,6 @@ Parents the Connector class loader. Parents both the *Applib* class loader and the *LifeCycleModule* class loader. -|LifeCycleModule -|The LifeCycleModule class loader is created once per lifecycle module. Each lifecycle module's classpath is used to construct its own class loader. - -For more information on lifecycle modules, see xref:Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc#developing-lifecycle-listeners[Developing Lifecycle Listeners]. - |Applib |The `Applib` class loader loads the library classes (specifically, libraries of the `app` type), specified during deployment, for a specific enabled module or Jakarta EE application; diff --git a/docs/modules/ROOT/pages/Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc b/docs/modules/ROOT/pages/Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc deleted file mode 100644 index 17658fd8a..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc +++ /dev/null @@ -1,105 +0,0 @@ -[[developing-lifecycle-listeners]] -= Developing Lifecycle Listeners -:ordinal: 14 - -IMPORTANT: Lifecycle listener modules are deprecated. Support for them is included for backward compatibility. Implementing the `org.glassfish.api.Startup` interface instead is recommended. - -Lifecycle listener modules provide a means of running short or long duration Java-based tasks within a Payara Server environment, such as instantiation of singletons or RMI servers. - -These modules are automatically initiated at server startup and are notified at various phases of the server's lifecycle. - -All lifecycle module classes and interfaces are in the `as-install/modules/glassfish-api.jar` file. - -[[server-life-cycle-events]] -== Server Life Cycle Events - -A lifecycle module listens for and performs its tasks in response to the following events in the server life cycle: - -* After the `INIT_EVENT`, the server reads the configuration, initializes built-in subsystems (such as security and logging services), and creates the containers. -* After the `STARTUP_EVENT`, the server loads and initializes deployed applications. -* After the `READY_EVENT`, the server is ready to service requests. -* After the `SHUTDOWN_EVENT`, the server destroys loaded applications and stops. -* After the `TERMINATION_EVENT`, the server closes the containers, the built-in subsystems, and the server runtime environment. - -These events are defined in the `LifecycleEvent` class. - -Lifecycle modules that listen for these events implement the `LifecycleListener` interface. - -[[the-lifecyclelistener-interface]] -== The `LifecycleListener` Interface - -To create a lifecycle module is to configure a customized class that implements the `com.sun.appserv.server.LifecycleListener` interface. You can create and simultaneously execute multiple lifecycle modules in any server installations. - -The `LifecycleListener` interface defines this method: - -[source,java] ----- -public void handleEvent(com.sun.appserv.server.LifecycleEvent event) throws ServerLifecycleException ----- - -This method responds to a lifecycle event and throws a `com.sun.appserv.server.ServerLifecycleException` if an error occurs. - -A sample implementation of the LifecycleListener interface is the `LifecycleListenerImpl.java` file, which you can use for testing lifecycle events. - -[[the-lifecycleevent-class]] -== The `LifecycleEvent` Class - -The `com.sun.appserv.server.LifecycleEvent` class defines a server life cycle event. The following methods are associated with the event: - -`public java.lang.Object.getData()`:: -This method returns an instance of `java.util.Properties` that contains the configuration properties defined for the lifecycle module. - -`public int getEventType()`:: -This method returns the type of the last event, one of: -* `INIT_EVENT` -* `STARTUP_EVENT` -* `READY_EVENT` -* `SHUTDOWN_EVENT` -* `TERMINATION_EVENT` - -`public com.sun.appserv.server.LifecycleEventContext.getLifecycleEventContext()`:: This method returns the lifecycle event context. - -NOTE: A `LifecycleEvent` instance is passed to the `LifecycleListener.handleEvent` method. - -[[the-server-lifecycle-event-context]] -== The Server Lifecycle Event Context - -The `com.sun.appserv.server.LifecycleEventContext` interface exposes runtime information about the server. - -The lifecycle event context is created when the `LifecycleEvent` class is instantiated at server initialization. The `LifecycleEventContext` interface defines these methods: - -`public java.lang.String[].getCmdLineArgs()`:: -This method returns the server startup command-line arguments. - -`public java.lang.String.getInstallRoot()`:: -This method returns the server installation root directory. - -`public java.lang.String.getInstanceName()`:: -This method returns the server instance name. - -`public javax.naming.InitialContext.getInitialContext()`:: -This method returns the initial JNDI naming context. The naming environment for lifecycle modules is installed after the `STARTUP_EVENT`. A lifecycle module can look up any resource by its `jndi-name` attribute after the `READY_EVENT`. - -If a lifecycle module needs to look up resources, it can do so after the `READY_EVENT`. It can use the `getInitialContext` method to get the initial context to which all the resources are bound. - -[[deploying-a-lifecycle-module]] -== Deploying a Lifecycle Module - -You do not need to specify a classpath for the lifecycle module if you place it in the `domain-dir/lib` or `domain-dir/lib/classes` directory. - -Do not place it in the `lib` directory for a particular instance, or it will be deleted when that instance synchronizes with the Domain Administration Server. - -[[considerations-for-lifecycle-modules]] -== Considerations for Lifecycle Modules - -The resources allocated at initialization or startup should be freed at shutdown or termination. The lifecycle module classes are called synchronously from the main server thread, therefore it is important to ensure that these classes don't block the server. - -CAUTION: Lifecycle modules can create threads if appropriate, but these threads must be stopped in the shutdown and termination phases. - -The `LifeCycleModule` class loader is the parent class loader for lifecycle modules. Each lifecycle module's classpath is used to construct its class loader. All the support classes needed by a lifecycle module must be available to the LifeCycleModule class loader or its parent, the `Connector` class loader. - -You must ensure that the `server.policy` file is appropriately set up, or a lifecycle module trying to perform a `System.exec()` might cause a security access violation. For details, see xref:Technical Documentation/Application Development/Securing Applications.adoc#the-server.policy-file[The *server.policy* File]. - -The configured properties for a lifecycle module are passed as properties after the `INIT_EVENT`. The JNDI naming context is not available before the `STARTUP_EVENT`. - -If a lifecycle module requires the naming context, it can get this after the `STARTUP_EVENT`, `READY_EVENT`, or `SHUTDOWN_EVENT`. diff --git a/docs/modules/ROOT/pages/Technical Documentation/Application Development/Using the JDBC API for Database Access.adoc b/docs/modules/ROOT/pages/Technical Documentation/Application Development/Using the JDBC API for Database Access.adoc index bd29bc874..b1b5db55c 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Application Development/Using the JDBC API for Database Access.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Application Development/Using the JDBC API for Database Access.adoc @@ -473,7 +473,7 @@ Check your corresponding JDBC driver vendor's documentation for information on t [[allowing-non-component-callers]] == Allowing Non-Component Callers -You can allow non-Jakarta-EE components, such as lifecycle modules and third party persistence managers, to use a managed JDBC connection pool. +You can allow non-Jakarta-EE components, such as third party persistence managers, to use a managed JDBC connection pool. The returned connection is automatically enlisted with the transaction context obtained from the transaction manager. Standard Jakarta EE components can also use such pools. diff --git a/docs/modules/ROOT/pages/Technical Documentation/Application Development/Using the Java Naming and Directory Interface.adoc b/docs/modules/ROOT/pages/Technical Documentation/Application Development/Using the Java Naming and Directory Interface.adoc index 88b79a8fd..55e6265d4 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Application Development/Using the Java Naming and Directory Interface.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Application Development/Using the Java Naming and Directory Interface.adoc @@ -160,19 +160,6 @@ Object o = ic.lookup("corbaname:iiop:host:port#a/b/Foo"); IMPORTANT: Objects stored in the interoperable naming context and component-specific (`java:comp/env`) naming contexts are transient. On each server startup or application reloading, all relevant objects are re-bound to the namespace. -[[naming-environment-for-lifecycle-modules]] -=== Naming Environment for Lifecycle Modules - -Lifecycle listener modules provide a means of running short or long duration tasks based on Java technology within the Payara Server environment, such as instantiation of singletons or RMI servers. - -These modules are automatically initiated at server startup and are notified at various phases of the server life cycle. - -For details about lifecycle modules, see xref:Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc#developing-lifecycle-listeners[Developing Lifecycle Listeners]. - -The configured properties for a lifecycle module are passed as properties during server initialization (the `INIT_EVENT`). The initial JNDI naming context is not available until server initialization is complete. - -A lifecycle module can get the `InitialContext` for lookups using the method `LifecycleEventContext.getInitialContext()` during, and only during, the `STARTUP_EVENT`, `READY_EVENT`, or `SHUTDOWN_EVENT` server life cycle events. - [[configuring-resources]] == Configuring Resources diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Deploying Applications.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Deploying Applications.adoc index d45c3bb47..dbb9c2b99 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Deploying Applications.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Deploying Applications.adoc @@ -1123,23 +1123,6 @@ After application clients are downloaded, they remain on the client until they a If you undeploy an application client, you can no longer download that application client because it might be in an inconsistent state. If you try to launch an application client that was previously downloaded (even though the server side of the application client is no longer present), the results are unpredictable unless the application client has been written to tolerate such situations. -[[lifecycle-module-deployment-guidelines]] -== Lifecycle Module Deployment Guidelines - -A lifecycle module, also called a lifecycle listener module, provides a means of running long or short Java-based tasks within the Payara Server environment, such as instantiation of singletons or RMI servers. - -Lifecycle modules are automatically initiated at server startup and are notified at various phases of the server life cycle. All lifecycle module interfaces are in the `as-install/modules/glassfish-api.jar` file. - -For general information about lifecycle modules, see "xref:Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc#developing-lifecycle-listeners[Developing Lifecycle Listeners]" in the Application Development section. - -You can deploy a lifecycle module using the `create-lifecycle-module` subcommand. Do not use `asadmin deploy` or related commands. - -You do not need to specify a classpath for the lifecycle module if you place it in the `domain-dir/lib` or `domain-dir/lib/classes` directory for the Domain Administration Server (DAS). Do not place it in the `lib` directory for a particular server instance, or it will be deleted when that instance synchronizes with Payara Server. - -After you deploy a lifecycle module, you must restart the server. During server initialization, the server instantiates the module and registers it as a lifecycle event listener. - -NOTE: If the `--failurefatal` option of `create-lifecycle-module` is set to `true` (the default is `false`), lifecycle module failure prevents server initialization or startup, but not shutdown or termination. - [[web-service-deployment-guidelines]] == Web Service Deployment Guidelines diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc index eed476738..9b8499ddb 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc @@ -4017,7 +4017,7 @@ This parameter is mandatory if and only if `is-connection-validation-required` i |`non-transactional-connections` |`false` |(optional) If `true`, non-transactional connections can be made to the JDBC connection pool. These connections are not automatically enlisted with the transaction manager. -|`allow-non-component-callers` |`false` |(optional) If `true`, non-Java-EE components, such as servlet filters, lifecycle modules, and third party persistence managers, can use this JDBC connection pool. +|`allow-non-component-callers` |`false` |(optional) If `true`, non-Java-EE components, such as servlet filters, and third party persistence managers, can use this JDBC connection pool. The returned connection is automatically enlisted with the transaction context obtained from the transaction manager. Standard Jakarta EE components can also use such pools. Connections obtained by non-component callers are not automatically closed at the end of a transaction by the container. They must be explicitly closed by the caller. diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Overview.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Overview.adoc index 869448d76..7a7b3ffe4 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Overview.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/Overview.adoc @@ -116,7 +116,6 @@ Payara Server supports the following types of modules: After deploying a Jakarta EE connector module, you must configure it as described in xref:Technical Documentation/Application Development/Developing Connectors.adoc#developing-connectors[Developing Connectors] in the Payara Server Application Development section. * *Application Client Module*. An application client module is a deployable software unit that consists of one or more classes, and application client deployment descriptors (`application-client.xml` and `glassfish-application-client.xml`). An application client JAR file applies to a Payara Server type of Jakarta EE client. An application client supports the standard Jakarta EE Application Client specifications. -* *Lifecycle Module*. A lifecycle module provides a means of running short-duration or long-duration Jakarta-based tasks within the Payara Server environment. Lifecycle modules are not Jakarta EE standard modules. See xref:Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc#developing-lifecycle-listeners[Developing Lifecycle Listeners] in thePayara Server Application Development section for more information. [[module-based-deployment]] ==== *Module-Based Deployment* diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/The Deployment Subcommands.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/The Deployment Subcommands.adoc index 3224d14f0..60a239abe 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/The Deployment Subcommands.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Application Deployment/The Deployment Subcommands.adoc @@ -12,15 +12,9 @@ xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/ xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/create-application-ref.adoc[`create-application-ref`]:: Creates a reference from a cluster or an un-clustered server instance to a previously deployed Jakarta EE application or module. This effectively results in the application element being deployed and made available on the targeted instance or cluster. -xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/create-lifecycle-module.adoc[`create-lifecycle-module`]:: - Creates a lifecycle module. A lifecycle module provides a means of running a short or long duration Jakarta-based task at a specific stage in the server life cycle. - xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/delete-application-ref.adoc[`delete-application-ref`]:: Removes a reference from a cluster or an un-clustered server instance to a previously deployed Jakarta EE application or module. This effectively results in the application element being un-deployed on the targeted instance or cluster. -xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/delete-lifecycle-module.adoc[`delete-lifecycle-module`]:: - Deletes a lifecycle module. - xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/deploy.adoc[`deploy`]:: Deploys an enterprise application, web application, EJB module, connector module, or application client module. If the component is already deployed or already exists, you can forcefully redeploy if you set the `--force` option to `true`. A directory can also be deployed. Supported in remote mode only. For usage instructions, see xref:Technical Documentation/Payara Server Documentation/Application Deployment/Deploying Applications.adoc#to-deploy-an-application-or-module[To Deploy an Application or Module]. @@ -55,9 +49,6 @@ xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/ Lists library JAR files that have been added to Payara Server. You can specify whether to list libraries in the Common class loader directory, the Jakarta optional package directory, or the application-specific class loader directory. -xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/list-lifecycle-modules.adoc[`list-lifecycle-modules`]:: - Lists lifecycle modules. - xref:ROOT:Technical Documentation/Payara Server Documentation/Command Reference/list-components.adoc[`list-components`]:: This subcommand is deprecated. Use the `list-applications` subcommand instead. diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-application-ref.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-application-ref.adoc index 7d1082efa..bb5b152f7 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-application-ref.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-application-ref.adoc @@ -49,7 +49,7 @@ asadmin-options:: == Operands reference_name:: - The name of the application or module, which can be a Java EE application, Web module, EJB module, connector module, application client module, or lifecycle module. + + The name of the application or module, which can be a Java EE application, Web module, EJB module, connector module or application client module. + The name can include an optional version identifier, which follows the name and is separated from the name by a colon (`:`). The version identifier must begin with a letter or number. It can contain alphanumeric characters plus underscore (`_`), dash (`-`), and period (`.`) characters. If the `--enabled` option is set to false, you can create references to multiple disabled versions by using an asterisk (`*`) as a wildcard character. For more information about module and application versions, see diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-lifecycle-module.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-lifecycle-module.adoc deleted file mode 100644 index ce8184581..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-lifecycle-module.adoc +++ /dev/null @@ -1,92 +0,0 @@ -[[create-lifecycle-module]] -= create-lifecycle-module - -Creates a lifecycle module. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] create-lifecycle-module [--help] ---classname classname -[--enabled={true|false}] [--target target] -[--classpath classpath] [--loadorder loadorder] -[--failurefatal={false|true} ] [--description description] -[--property (name=value)[:name=value]*] -module_name ----- - -[[description]] -== Description - -The `create-lifecycle-module` subcommand creates a lifecycle module. A lifecycle module provides a means of running a short or long duration Java-based task at a specific stage in the server life cycle. This subcommand is supported in remote mode only. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--classname`:: - This is the fully qualified name of the startup class. -`--target`:: - Indicates the location where the lifecycle module is to be created. Valid values are + - * `server`- Specifies the default server instance as the target for creating the lifecycle module. `server` is the name of the default server instance and is the default value for this option. - * cluster_name - Specifies a particular cluster as the target for creating the lifecycle module. - * instance_name - Specifies a particular stand-alone server instance as the target for creating the lifecycle module. -`--classpath`:: - This option indicates where the lifecycle module is located. It is a classpath with the standard format: either colon-separated (Unix) or semicolon-separated (Windows) JAR files and directories. The referenced JAR files and directories are not uploaded to the server instance. -`--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 are loaded sooner. Order is unspecified if two or more lifecycle modules have the same load-order value. The default is `Integer.MAX_VALUE`, which means the lifecycle module is loaded last. -`--failurefatal`:: - This option 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. -`--enabled`:: - This option determines whether the lifecycle module is enabled at runtime. The default value is true. -`--description`:: - This is the text description of the lifecycle module. -`--property`:: - This is an optional attribute containing name/value pairs used to configure the lifecycle module. - -[[operands]] -== Operands - -module_name:: - This operand is a unique identifier for the deployed server lifecycle event listener module. - -[[examples]] -== Examples - -*Example 1 Creating a Lifecycle Module* - -The following example creates a lifecycle module named `customSetup`. - -[source,shell] ----- -asadmin> create-lifecycle-module --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 ----- - -The escape character `\` is used in the property option to specify that the equal sign (=) and colon (:) are part of the `rmi` property value. - -[[exit-status]] -== Exit Status - -0:: - command executed successfully -1:: - error in executing the command - -See Also - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-lifecycle-module.adoc#delete-lifecycle-module[`delete-lifecycle-module`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-lifecycle-modules.adoc#list-lifecycle-modules[`list-lifecycle-modules`] -* "xref:Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc#developing-lifecycle-listeners[Developing Lifecycle Listeners]" in the Payara Server Application Development section - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-application-ref.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-application-ref.adoc index dcd8fc3e4..29cf81e10 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-application-ref.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-application-ref.adoc @@ -45,7 +45,7 @@ asadmin-options:: == Operands reference_name:: - The name of the application or module, which can be a Java EE application module, Web module, EJB module, connector module, application client module, or lifecycle module. + + The name of the application or module, which can be a Java EE application module, Web module, EJB module, connector module or application client module. + The name can include an optional version identifier, which follows the name and is separated from the name by a colon (`:`). The version identifier must begin with a letter or number. It can contain alphanumeric characters plus underscore (`_`), dash (`-`), and period (`.`) characters. To delete references to multiple versions, you can use an asterisk (`*`) as a wildcard character. For more information about module and application versions, see "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Overview.adoc#module-and-application-versions[Module and Application Versions]" in Payara Server Application Deployment section. [[examples]] diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-lifecycle-module.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-lifecycle-module.adoc deleted file mode 100644 index 893d17440..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-lifecycle-module.adoc +++ /dev/null @@ -1,67 +0,0 @@ -[[delete-lifecycle-module]] -= delete-lifecycle-module - -Removes the lifecycle module. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] delete-lifecycle-module [--help] -[--target target] module_name ----- - -[[description]] -== Description - -The `delete-lifecycle-module` subcommand removes a lifecycle module. A lifecycle module provides a means of running a short or long duration Java-based task at a specific stage in the server life cycle. This subcommand is supported in remote mode only. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--target`:: - Indicates the location where the lifecycle module is to be deleted. Valid values are + - * `server`- Specifies the default server instance as the target for deleting the lifecycle module. `server` is the name of the default server instance and is the default value for this option. - * cluster_name - Specifies a particular cluster as the target for deleting the lifecycle module. - * instance_name - Specifies a particular server instance as the target for deleting the lifecycle module. - -[[operands]] -== Operands - -module_name:: - This operand is a unique identifier for the deployed server lifecycle event listener module. - -[[examples]] -== Examples - -*Example 1 Deleting a Lifecycle Module* - -The following example deletes a lifecycle module named `customSetup`. - -[source,shell] ----- -asadmin> delete-lifecycle-module customSetup -Command delete-lifecycle-module executed successfully ----- - -[[exit-status]] -== Exit Status - -0:: - command executed successfully -1:: - error in executing the command - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-lifecycle-module.adoc#create-lifecycle-module[`create-lifecycle-module`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-lifecycle-modules.adoc#list-lifecycle-modules[`list-lifecycle-modules`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-lifecycle-modules.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-lifecycle-modules.adoc deleted file mode 100644 index 312a7d972..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-lifecycle-modules.adoc +++ /dev/null @@ -1,68 +0,0 @@ -[[list-lifecycle-modules]] -= list-lifecycle-modules - -Lists the lifecycle modules. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] list-lifecycle-modules [--help] -[target] ----- - -[[description]] -== Description - -The `list-lifecycle-modules` subcommand lists lifecycle modules. A lifecycle module provides a means of running a short or long duration -Java-based task at a specific stage in the server life cycle. This subcommand is supported in remote mode only. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. - -[[operands]] -== Operands - -target:: - Indicates the location where lifecycle modules are to be listed. Valid values are + - * `server`- Specifies the default server instance as the target for listing lifecycle modules. `server` is the name of the default server - instance and is the default value for this operand. - * cluster_name- Specifies a particular cluster as the target for listing lifecycle modules. - * instance_name- Specifies a particular server instance as the target for listing lifecycle modules. - -[[examples]] -== Examples - -*Example 1 Listing Lifecycle Modules* - -[source,shell] ----- -asadmin> list-lifecycle-modules -WSTCPConnectorLCModule -Command list-lifecycle-modules executed successfully ----- - -`WSTCPConnectorLCModule` is the only lifecycle module listed for the default target, `server`. - -[[exit-status]] -== Exit Status - -0:: - command executed successfully -1:: - error in executing the command - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-lifecycle-module.adoc#create-lifecycle-module[`create-lifecycle-module`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-lifecycle-module.adoc#delete-lifecycle-module[`delete-lifecycle-module`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc deleted file mode 100644 index f6943976a..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc +++ /dev/null @@ -1,125 +0,0 @@ -[[administering-life-cycle-modules]] -= Administering Life Cycle Modules -:ordinal: 12 - -This chapter provides procedures for administering life cycle modules in the Payara Server environment. - -Instructions for accomplishing the tasks in this chapter by using the Administration Console are contained in the Administration Console online help. - -[[about-life-cycle-modules]] -== About Life Cycle Modules - -Life cycle modules, also known as initialization services, provide a means of running short or long duration Java-based tasks within the Payara Server environment. -These modules are automatically initiated at server startup and are notified at various phases of the server lifecycle. Configured properties for a life cycle module are -passed as properties during server initialization. - -All life cycle module classes and interfaces are in the as-install`/modules/glassfish-api.jar` file. - -A life cycle module listens for and performs its tasks in response to the following Payara Server sequence of events: - -. Initialization. The server reads the configuration, initializes built-in subsystems (such as security and logging services), and creates the containers. -. Startup. The server loads and initializes deployed applications. -. Ready. The server begins servicing requests. -. Shutdown. The server shuts down the applications and stops. -. Termination. The server closes the containers, the built-in subsystems, and the server runtime environment. - -These events are defined in the `LifecycleEvent` class. For information on creating life cycle modules, see xref:Technical Documentation/Application Development/Developing Lifecycle Listeners.adoc[Developing Lifecycle Listeners] in the Payara Server Application Development section. - -NOTE: If the `is-failure-fatal` setting is set to true (the default is false), life cycle module failure prevents server initialization or startup, but not shutdown or termination. - -[[configuring-life-cycle-modules]] -== Configuring Life Cycle Modules - -[[to-create-a-life-cycle-module]] -=== To Create a Life Cycle Module - -Use the `create-lifecycle-module` subcommand in remote mode to create a life cycle module. - -. Ensure that the server is running. Remote subcommands require a running server. -. Create a new life cycle modules by using the xref:Technical Documentation/Payara Server Documentation/Command Reference/create-lifecycle-module.adoc[`create-lifecycle-module`] subcommand. -Information about options and properties for the subcommand are included in this help page. -. Restart the server for your changes to take effect. xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Domains.adoc#to-restart-a-domain[To Restart a Domain]. - -==== Example 9-1 Creating a Life Cycle Module - -[source,shell] ----- -asadmin> create-lifecycle-module --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 ----- -This example creates the `customSetup` life cycle module : - -[[to-list-life-cycle-modules]] -=== To List Life Cycle Modules - -Use the `list-lifecycle-modules` subcommand in remote mode to list the existing life cycle modules. - -. Ensure that the server is running. Remote subcommands require a running server. -. List life cycle modules by using the xref:Technical Documentation/Payara Server Documentation/Command Reference/list-lifecycle-modules.adoc[`list-lifecycle-modules`] subcommand. - -==== Example 9-2 Listing Life Cycle Modules - -[source,shell] ----- -asadmin> list-lifecycle-modules -WSTCPConnectorLCModule -Command list-lifecycle-modules executed successfully ----- -This example lists the existing life cycle modules. - -[[to-update-a-life-cycle-module]] -=== To Update a Life Cycle Module - -Use the `set` subcommand to update an existing life cycle module. - -. List the properties that can be updated for a life cycle module by xref:Technical Documentation/Payara Server Documentation/Command Reference/get.adoc[`get`] subcommand. -+ -.For example (single mode): -[source,shell] ----- -asadmin get "*" | grep sampleLCM -applications.application.sampleLCMmodule.availability-enabled=false -applications.application.sampleLCMmodule.directory-deployed=false -applications.application.sampleLCMmodule.enabled=true -applications.application.sampleLCMmodule.name=sampleLCMmodule -applications.application.sampleLCMmodule.object-type=user -applications.application.sampleLCMmodule.property.class-name=example.lc.SampleModule -applications.application.sampleLCMmodule.property.classpath=/build/lcm.jar -applications.application.sampleLCMmodule.property.is-failure-fatal=false -applications.application.sampleLCMmodule.property.isLifecycle=true ----- -. Update a life cycle module by using the xref:Technical Documentation/Payara Server Documentation/Command Reference/set.adoc[`set`] subcommand. -. Restart the server for your changes to take effect. See xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Domains.adoc#to-restart-a-domain[To Restart a Domain]. - -==== Example 9-3 Updating a Life Cycle Module - -[source,shell] ----- -sadmin> set applications.application.sampleLCMmodule. -property.classpath=/build/lcm_new.jarapplications.application. -sampleLCMmodule.property.classpath=/build/lcm_new.jar -Command set executed successfully. ----- -This example updates the `classpath` property. - -[[to-delete-a-life-cycle-module]] -=== To Delete a Life Cycle Module - -Use the `delete-lifecycle-module` subcommand in remote mode to delete a life cycle module. - -. Ensure that the server is running. Remote subcommands require a running server. -. List the current life cycle modules by using the xref:Technical Documentation/Payara Server Documentation/Command Reference/list-lifecycle-modules.adoc[`list-lifecycle-modules`] subcommand. -. Delete a life cycle module by using the xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-lifecycle-module.adoc[`delete-lifecycle-module`] subcommand. - -==== Example 9-4 Deleting a Life Cycle Module - -[source,shell] ----- -asadmin> delete-lifecycle-module customSetup -Command delete-lifecycle-module executed successfully ----- -This example deletes the `customSetup` life cycle module. - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Overview.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Overview.adoc index 14632482f..df0b93a30 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Overview.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Overview.adoc @@ -106,8 +106,6 @@ Logging:: By default, logging is enabled, so basic logging works without additional configuration. However, you might want to change log levels, property values, or the location of log files. See xref:Technical Documentation/Payara Server Documentation/General Administration/Administering the Logging Service.adoc#administering-the-logging-service[Administering the Logging Service]. Monitoring:: By default, the monitoring service is enabled. However, monitoring for the individual modules is not enabled, so your first monitoring task is to enable monitoring for the modules that you want to monitor. See xref:Technical Documentation/Payara Server Documentation/General Administration/Administering the Monitoring Service.adoc#administering-the-monitoring-service[Administering the Monitoring Service]. -Life Cycle Modules:: - See xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc#administering-life-cycle-modules[Administering Life Cycle Modules]. Security:: * System Security. Initial configuration tasks might include setting up passwords, audit modules, and certificates. See "xref:Technical Documentation/Payara Server Documentation/Security Guide/Administering System Security.adoc#administering-system-security[Administering System Security]" in the Payara Server Security Guide. * User Security. Initial configuration tasks might include creating authentication realms and file users. See "xref:Technical Documentation/Payara Server Documentation/Security Guide/Administering User Security.adoc#administering-user-security[Administering User Security]" in the Payara Server Security Guide. diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Subcommands for the Asadmin CLI.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Subcommands for the Asadmin CLI.adoc index ad853360f..daad62d94 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Subcommands for the Asadmin CLI.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/General Administration/Subcommands for the Asadmin CLI.adoc @@ -484,24 +484,6 @@ NOTE: Online help for the `asadmin` subcommands can be invoked on the command li |=== -[[life-cycle-module-subcommands]] -== Life Cycle Module Subcommands - -[header, cols="2,8"] -|=== -| Subcommands | Description - -| `create-lifecycle-module` -| Creates a new life cycle module. Supported in remote mode only. For procedural information in this guide, see xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc#to-create-a-life-cycle-module[To Create a Life Cycle Module]. - -| `list-lifecycle-modules` -| Lists life cycle modules. Supported in remote mode only. For procedural information in this guide, see xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc#to-list-life-cycle-modules[To List Life Cycle Modules]. - -| `delete-lifecycle-module` -| Deletes an existing life cycle module. Supported in remote mode only. For procedural information in this guide, see xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc#to-delete-a-life-cycle-module[To Delete a Life Cycle Module]. - -|=== - [[logging-and-monitoring-subcommands]] == Logging and Monitoring Subcommands diff --git a/enterprise/docs/modules/ROOT/nav.adoc b/enterprise/docs/modules/ROOT/nav.adoc index d059a8a2d..6896d6880 100644 --- a/enterprise/docs/modules/ROOT/nav.adoc +++ b/enterprise/docs/modules/ROOT/nav.adoc @@ -20,7 +20,6 @@ *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering the Request Tracing Service.adoc[Administering the Request Tracing Service] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering the Notification Service.adoc[Administering the Notification Service] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Extended Notification Service Details.adoc[Extended Notification Service Details] -*** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Lifecycle Modules.adoc[Administering Lifecycle Modules] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Batch Jobs.adoc[Administering Batch Jobs] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering Database Connectivity.adoc[Administering Database Connectivity] *** xref:Technical Documentation/Payara Server Documentation/General Administration/Administering EIS Connectivity.adoc[Administering EIS Connectivity]