Before you can run applications, you must set up and run the embedded Enterprise Server. This section includes the following topics:
To create configure an embedded Enterprise Server, perform these tasks:
Instantiate the org.glassfish.api.embedded.Server.Builder class.
Invoke any methods for configuration settings that you require. This is optional.
Invoke one of the build methods to create a Server object.
The methods of this class for setting the server configuration are listed in the following table. The default value of each configuration setting is also listed.
Table 1 Constructor and Methods of the Server.Builder Class
Purpose |
Method |
Default Value |
|
---|---|---|---|
Creates a server builder and names the server |
|
None |
|
References an embedded file system |
|
None |
|
Enables verbose mode |
|
true |
|
Enables logging |
|
true |
|
Specifies a log file |
|
instance-dirlogs/server.log (see Instance Root Directory) |
|
Creates a server |
|
None |
|
Creates a server with properties |
|
None |
This example shows code for creating a server and enabling logging.
... import org.glassfish.api.embedded.*; ... Server.Builder builder = new Server.Builder("test"); builder.logger(true); ... Server server = builder.build(); ...
Specifying an embedded file system for an embedded Enterprise Server is optional. What you don't specify is created automatically and used transparently by the server. An embedded file system enables you to do the following:
To use the configuration information of an existing installation of Enterprise Server
To control where embedded Enterprise Server creates its configuration directories
To specify a configuration file, which controls how embedded Enterprise Server functions
To specify an embedded file system for embedded Enterprise Server, perform these tasks:
Instantiate the org.glassfish.api.embedded.EmbeddedFileSystem.Builder class.
Invoke any methods for configuration settings that you require. This is optional.
Invoke the build method to create an EmbeddedFileSystem object.
If you are including the glassfish-embedded-static-shell.jar file in your class path, the methods of the EmbeddedFileSystem.Builder class can only point to the referenced installation. These methods cannot create or delete any directories or files.
The methods of the EmbeddedFileSystem.Builder class for setting the embedded file system configuration are listed in the following table. The default value of each configuration setting is also listed.
Table 2 Constructor and Methods of the EmbeddedFileSystem.Builder Class
Purpose |
Method |
Default Value |
|
---|---|---|---|
Creates an embedded file system builder |
|
None |
|
Deletes embedded file system files when the server is stopped Caution – Do not set autoDelete to true if you are using installRoot to refer to a preexisting Enterprise Server installation. |
|
false |
|
Creates a new or references an existing Installation Root Directory |
|
In order of precedence:
|
|
Creates or references an Installation Root Directory in which the embedded server and file system use different class loaders if cooked-mode is false |
|
Same as the other installRoot method, cooked-mode is true |
|
Creates a new or references an existing Instance Root Directory |
|
as-installdomains/domain1 |
|
Creates a new or references an existing configuration file |
|
instance-dirconfig/domain.xml |
|
Creates or references a configuration file that is read-only if read-only is true |
|
instance-dirconfig/domain.xml, read-only is false |
|
Creates an embedded file system |
|
None |
This example shows code for creating an embedded file system whose configuration information is stored in the file C:\samples\test\applicationserver\domains\domain1\config\domain.xml. This example also includes the code from Example 1 for creating Server.Builder and Server objects.
... import java.io.File; ... import org.glassfish.api.embedded.*; ... File installDir = new File("c:\\samples\\testapp\\applicationserver"); File domainDir = new File(installDir, "domains\\domain1"); ... File domainConfig = new File(domainDir, "config"); File domainXml = new File(domainConfig, "domain.xml"); ... Server.Builder builder = new Server.Builder("test"); ... EmbeddedFileSystem.Builder efsb = new EmbeddedFileSystem.Builder(); efsb.installRoot(installDir); efsb.instanceRoot(domainDir); efsb.configurationFile(domainXml); EmbeddedFileSystem efs = efsb.build(); builder.embeddedFileSystem(efs); ... Server server = builder.build(); ...
The installation root directory, represented as as-install, is the parent of the directory that embedded Sun GlassFish Enterprise Server uses for configuration files. This directory corresponds to the base directory for an installation of Enterprise Server. Configuration files are contained in the following directories in the base directory for an installation of Enterprise Server:
domains
lib
Specify the installation root directory if any of the following conditions applies:
You require Sun GlassFish Enterprise Server to create the directory for configuration files at a specific location.
You are using an existing domain that is at the default location, that is contained in the domains subdirectory of the installation root directory. The domains subdirectory must contain only one domain directory. This domain can be part of a nonembedded installation of Sun GlassFish Enterprise Server.
If the domains subdirectory contains multiple directories, or if you are using a domain at a non-default location, you must also specify the instance root directory.
If the instance root directory is also specified, configuration files for the domain are obtained from the instance root directory, not the domains directory under the installation root directory.
How embedded Sun GlassFish Enterprise Server uses the installation root directory depends on the content of this directory:
If the installation root directory contains domain configuration files, embedded Sun GlassFish Enterprise Server reads the configuration files.
If the installation root directory does not contain domain configuration files, embedded Sun GlassFish Enterprise Server copies configuration files into this directory.
If the installation root directory does not exist, embedded Sun GlassFish Enterprise Server creates the directory and copies configuration files into the directory.
If the installation root directory is not specified, embedded Sun GlassFish Enterprise Server creates a directory named gfembedrandom-numbertmp in the current working directory, where random-number is a randomly generated 19-digit number. Embedded Sun GlassFish Enterprise Server then copies configuration files into this directory.
The instance root directory, represented as instance-dir, is the parent directory of a server instance directory. Embedded Sun GlassFish Enterprise Server uses the server instance directory for domain configuration files.
Specify the instance root directory if any of the following conditions applies:
You are using a domain directory that is at a non-default location, that is not contained in the domains subdirectory of the installation root directory.
For example, if your domain directory is at /tmp/domain1, specify the instance root directory as /tmp/domain1.
The domains subdirectory of your installation root directory contains multiple domain directories.
For example, the domains subdirectory of the /home/gfuser/glassfish installation root directory might contain the domain directories domain1 and domain2. To use the domain directory domain2, specify the instance root directory as /home/gfuser/glassfish/domains/domain2.
How embedded Sun GlassFish Enterprise Server uses the instance root directory depends on the content of this directory:
If the instance root directory contains domain configuration files, embedded Sun GlassFish Enterprise Server reads the configuration files.
If the instance root directory does not contain domain configuration files, embedded Sun GlassFish Enterprise Server copies configuration files into this directory.
If the instance root directory does not exist, embedded Sun GlassFish Enterprise Server creates the directory and copies configuration files into the directory.
If the instance root directory is not specified, embedded Sun GlassFish Enterprise Server uses the domains subdirectory of the installation root directory for domain configuration files.
Using an existing domain.xml file avoids the need to configure embedded Enterprise Server programmatically in your application. Your application obtains domain configuration data from an existing domain.xml file. You can create this file by using the administrative interfaces of an installation of nonembedded Enterprise Server. To specify an existing domain.xml file, invoke the installRoot, instanceRoot, or configurationFile method of the EmbeddedFileSystem.Builder class or a combination of these methods.
After you create an embedded Enterprise Server as described in Creating and Configuring an Embedded Enterprise Server, you can perform operations such as:
You must set the server's HTTP 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.
To set the port directly, invoke the createPort method of the Server object.
To port indirectly, set up an embedded file system, which includes a domain.xml file that sets the port. For more information, see Specifying an Embedded Enterprise Server File System and Using an Existing domain.xml File.
This example shows code for setting the port of an embedded Enterprise Server. This example also includes the code from Example 1 for creating Server.Builder and Server objects.
... import org.glassfish.api.embedded.*; ... Server.Builder builder = new Server.Builder("test"); ... Server server = builder.build(); server.createPort(8080); ...
To start an embedded Enterprise Server, invoke the start method of the Server object.
This example shows code for setting the port and starting an embedded Enterprise Server. This example also includes the code from Example 1 for creating Server.Builder and Server objects.
... import org.glassfish.api.embedded.*; ... Server.Builder builder = new Server.Builder("test"); ... Server server = builder.build(); server.createPort(8080); server.start(); ...
The API for embedded Enterprise Server 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:
Undeploying deployed applications
Releasing any resources that your application uses
To stop an embedded Enterprise Server, invoke the stop method of an existing Server object.
This example shows code for prompting the user to press the Enter key to stop an embedded Enterprise Server. When a user presses Enter, the application undeploys any deployed applications before stopping the server. For more information about undeploying applications, see Undeploying an Application. Code for creating a Server object is not shown in this example. For an example of code for creating a Server object, see Example 1.
... import java.io.BufferedReader; ... import org.glassfish.api.embedded.*; ... EmbeddedDeployer deployer = server.getDeployer(); ... System.out.println("Press Enter to stop server"); // wait for Enter new BufferedReader(new java.io.InputStreamReader(System.in)).readLine(); deployer.undeployAll(); server.stop(); ...