Eclipse GlassFish Embedded Server Guide, Release 7

To create and configure an embedded Eclipse GlassFish, perform these tasks:

The methods of the BootstrapProperties class for setting the server configuration are listed in the following table. The default value of each configuration setting is also listed.

Table 1-1 Methods of the BootstrapProperties Class

The methods of the GlassFishProperties class for setting the server configuration are listed in the following table. The default value of each configuration setting is also listed.

Table 1-2 Methods of the GlassFishProperties Class

Example 1-1 Creating an Embedded Eclipse GlassFish

This example shows code for creating an Embedded Eclipse GlassFish.

Example 1-2 Creating an Embedded Eclipse GlassFish with configuration customizations

This example shows code for creating an Embedded Eclipse GlassFish using the existing domain-dir C:\samples\test\applicationserver\domains\domain1.

After you create an embedded Eclipse GlassFish as described in Creating and Configuring an Embedded Eclipse GlassFish, you can perform operations such as:

Setting the Port of an Embedded Eclipse GlassFish From an Application

You must set the server’s HTTP or HTTPS port. If you do not set the port, your application fails to start and throws an exception. You can set the port directly or indirectly.

Example 1-3 Setting the port of an Embedded Eclipse GlassFish

This example shows code for setting the port of an embedded Eclipse GlassFish.

Starting an Embedded Eclipse GlassFish From an Application

To start an embedded Eclipse GlassFish, invoke the start method of the GlassFish object.

Example 1-4 Starting an Embedded Eclipse GlassFish

This example shows code for setting the port and starting an embedded Eclipse GlassFish. This example also includes the code from Example 1-1 for creating a GlassFish object.

Stopping an Embedded Eclipse GlassFish From an Application

The API for embedded Eclipse GlassFish provides a method for stopping an embedded server. Using this method enables your application to stop the server in an orderly fashion by performing any necessary cleanup steps before stopping the server, for example:

To stop an embedded Eclipse GlassFish, invoke the stop method of an existing GlassFish object.

Example 1-5 Stopping an Embedded Eclipse GlassFish

This example shows code for prompting the user to press the Enter key to stop an embedded Eclipse GlassFish. Code for creating a GlassFish object is not shown in this example. For an example of code for creating a GlassFish object, see Example 1-1.

As an alternative, you can use the dispose method to stop an embedded Eclipse GlassFish and dispose of the temporary file system.

An archive file contains the resources, deployment descriptor, and classes of an application. The content of the file must be organized in the directory structure that the Jakarta EE specifications define for the type of archive that the file contains. For more information, see "Deploying Applications" in Eclipse GlassFish Application Deployment Guide.

Deploying an application from a directory enables you to deploy an application without the need to package the application in an archive file. The contents of the directory must match the contents of the expanded Jakarta EE archive file as laid out by the Eclipse GlassFish. The directory must be accessible to the machine on which the deploying application runs. For more information about the requirements for deploying an application from a directory, see "To Deploy an Application or Module in a Directory Format" in Eclipse GlassFish Application Deployment Guide.

If some of the resources needed by an application are not under the application’s directory, see Creating a Scattered Archive.

Example 1-6 Deploying an Application From an Archive File

This example shows code for deploying an application from the archive file c:\samples\simple.war and setting the name, contextroot, and force parameters. This example also includes the code from Example 1-1 for creating GlassFishProperties and GlassFish objects.

Undeploy an application when the application is no longer required to run in Eclipse GlassFish. For example, before stopping Eclipse GlassFish, undeploy all applications that are running in Eclipse GlassFish.

To undeploy an application, invoke the undeploy method of an existing Deployer object. In the method invocation, pass the name of the application as a parameter. This name is specified when the application is deployed.

For information about optional parameters you can set, see the descriptions of the deploy(1) command parameters. Simply quote each parameter in the method, for example "--cascade=true".

To undeploy all deployed applications, invoke the undeployAll method of an existing EmbeddedDeployer object. This method takes no parameters.

Example 1-7 Undeploying an Application

This example shows code for undeploying the application that was deployed in Example 1-6.

Deploying a module from a scattered archive (WAR or JAR) enables you to deploy an unpackaged module whose resources, deployment descriptor, and classes are in any location. Deploying a module from a scattered archive simplifies the testing of a module during development, especially if all the items that the module requires are not available to be packaged.

In a scattered archive, these items are not required to be organized in a specific directory structure. Therefore, you must specify the location of the module’s resources, deployment descriptor, and classes when deploying the module.

To create a scattered archive, perform these tasks:

The methods of this class for setting the scattered archive configuration are listed in the following table. The default value of each configuration setting is also listed.

Table 1-3 Constructors and Methods of the ScatteredArchive Class

Example 1-8 Deploying an Application From a Scattered Archive

This example shows code for creating a WAR file and using the addClassPath and addMetadata methods. This example also includes the code from Example 1-6 for deploying an application from an archive file.

Deploying an application from a scattered enterprise archive (EAR) enables you to deploy an unpackaged application whose resources, deployment descriptor, and classes are in any location. Deploying an application from a scattered archive simplifies the testing of an application during development, especially if all the items that the application requires are not available to be packaged.

In a scattered archive, these items are not required to be organized in a specific directory structure. Therefore, you must specify the location of the application’s resources, deployment descriptor, and classes when deploying the application.

To create a scattered enterprise archive, perform these tasks:

The methods of this class for setting the scattered enterprise archive configuration are listed in the following table. The default value of each configuration setting is also listed.

Table 1-4 Constructors and Methods of the ScatteredEnterpriseArchive Class

Example 1-9 Deploying an Application From a Scattered Enterprise Archive

This example shows code for creating an EAR file and using the addArchive and addMetadata methods. This example also includes code similar toExample 1-8 for creating a scattered archive.

Running asadmin Commands Using the Eclipse GlassFish Embedded Server ==== API

Running asadmin commands from an application enables the application to configure the embedded Eclipse GlassFish to suit the application’s requirements. For example, an application can run the required asadmin commands to create a JDBC technology connection to a database.

For more information about configuring embedded Eclipse GlassFish, see the Eclipse GlassFish Administration Guide. For detailed information about asadmin commands, see Section 1 of the Eclipse GlassFish Reference Manual.

The org.glassfish.embeddable package contains classes that you can use to run asadmin commands. Use the following code examples as templates and change the command name, parameter names, and parameter values as needed.

Example 1-10 Running an asadmin create-jdbc-resource Command

This example shows code for running an asadmin create-jdbc-resource command. Code for creating and starting the server is not shown in this example. For an example of code for creating and starting the server, see Example 1-4.

Example 1-11 Running an asadmin set-log-level Command

This example shows code for running an asadmin set-log-level command. Code for creating and starting the server is not shown in this example. For an example of code for creating and starting the server, see Example 1-4.

For another way to change log levels, see Changing Log Levels in Embedded Eclipse GlassFish.

This goal starts the server and deploys an application. You can redeploy if you change the application. The application can be a packaged archive or a directory that contains an exploded application. You can set the parameters described in the following table.

Table 1-5 embedded-glassfish:run Parameters

This goal starts the server. You can set the parameters described in the following table.

Table 1-6 embedded-glassfish:start Parameters

This goal deploys an application. You can redeploy if you change the application. The application can be a packaged archive or a directory that contains an exploded application. You can set the parameters described in the following table.

Table 1-7 embedded-glassfish:deploy Parameters

This goal undeploys an application. You can set the parameters described in the following table.

Table 1-8 embedded-glassfish:undeploy Parameters

This goal stops the server. You can set the parameters described in the following table.

Table 1-9 embedded-glassfish:stop Parameters

This goal runs a Eclipse GlassFish administration command. You must use either the command and commandParameters parameters in combination or the commandLine parameter. For more information about administration commands, see the Eclipse GlassFish Reference Manual. You can set the parameters described in the following table.

Table 1-10 embedded-glassfish:start Parameters