GlassFish

4 minute readExtensibilityDeveloper productivity

GlassFish is the Open Source Java EE Reference Implementation; as such, we welcome external contributions. Information about GlassFish can be found on the GlassFish home page.

Plugin Version 1.0.5.2020102201 Revised on January 24, 2019

CloudBees CD integration to GlassFish

The EC-Glassfish plugin allows users to interact with the GlassFish Application Server version 3 to accomplish tasks such as managing servers and deployments.

Integrated version

This plugin was developed and tested with GlassFish 3.0.1.

Plugin procedures

In the CloudBees CD UI, from the Home page, open the Main Menu, and click Admin > Plugins to open the Plugin Manager.
For all parameter descriptions below, required parameters are shown in bold italics.

Plugin configuration

Plugin configurations are sets of parameters that apply across some or all of the plugin’s procedures. They are intended to reduce repetition of common values, create predefined sets of parameters for end users, and to securely store credentials where needed. Each configuration is given a unique name that is entered in designated parameters on procedures that use them.

Plugin configurations are created by going to the CloudBees CD "Administration" tab, then to the "Plugins" sub-tab. On the right side of the line for the specific plugin, there is a "Configure" link which will open the Configuration page.

To enable CloudBees CD to communicate with your GlassFish server, create a GlassFish configuration, supplying the following information:

ParameterDescription

Configuration Name:

Provide a unique name for the configuration, keeping in mind that you may need to create additional configurations over time. (Required)

GlassFish AS IP Address:

Provide the URL for the GlassFish server, it must include the protocol and port, i.e: 'http://192.168.1.100:9990'. (Required)

Server domain:

Provide the unique name of the domain to be used. (Required)

Login as

Username: Provide the user name CloudBees CD uses to communicate with the Tomcat server.

Password: Provide the password for the specified Username.

Retype Password: Retype the password specified.

CheckServerStatus

The CheckServerStatus procedure checks the specified server’s status.

ParameterDescription

Configuration name

Provide the name of the configuration that holds connection information for the GlassFish server. (Required)

Use Credentials

Indicate if credentials must be used.

To check the server status, select the following highlighted step:

Then, enter the following parameters:

When the job is executed, you should see the following job detail, note the output indicating the job was completed:

In the CheckServerStatus step, click the Log icon to see the diagnostic info. The output is similar to the following diagnostic report:

StartServerDomain

The StartServerDomain procedure starts a GlassFish server domain specified in the 'Configuration' used.

ParameterDescription

Configuration name

Supply the configuration name of the GlassFish server. This configuration holds information about the domain you want to start. (Required)

Physical location of the admin script

Provide the absolute physical path of the domain script asadmin, i.e: C:\glassfishv3\bin\asadmin. (Required)

To start the server, select the following highlighted step:

Then, enter the following parameters:

When the job is executed, you should see the following job detail, note the output indicating the job is running:

In the StartServerDomain step, click the Log icon to see the diagnostic info. The output is similar to the following diagnostic report:

StopServerDomain

The StopServerDomain procedure shuts down a running server domain.

ParameterDescription

Server configuration name

Supply the configuration name of the GlassFish server. This configuration holds information about the domain you want to stop. (Required)

Physical location of the admin script

Provide the absolute physical path of the domain script asadmin, i.e: C:\glassfishv3\bin\asadmin. (Required)

To shutdown the server, select the following highlighted step:

Then, enter the following parameters:

When the job is executed, you should see the following job detail, note the output indicating the domain was stopped successfully:

In the StopServerDomain step, click the Log icon to see the diagnostic info. The output is similar to the following diagnostic report:

DeployApp

The DeployApp procedure deploys and starts the application designated by the war file path.

ParameterDescription

Physical location of the admin script

Provide the absolute physical path of the domain script asadmin, i.e: C:\glassfishv3\bin\asadmin. (Required)

Path to the application to deploy

Path to the application to deploy. (Required)

Deployment name

Unique name of the deployment, if the name argument is not provide, the application uses the file name as the default value.

Configuration name

Supply the configuration name of the GlassFish server. This configuration holds information about the domain and the port to deploy the war. (Required)

To deploy an application, select the following highlighted step:

Then, enter the following parameters:

When the job is executed, you should see the following job detail, note the output indicating the application was deployed:

In the DeployApp step, click the Log icon to see the diagnostic info. The output is similar to the following diagnostic report:

UndeployApp

The UndeployApp procedure undeploys the application specified.

ParameterDescription

Physical location of the admin script

Provide the absolute physical path of the domain script asadmin, i.e: C:\glassfishv3\bin\asadmin. (Required)

Deployment Name

Unique name of the application to undeploy. (Required)

Configuration name

Supply the configuration name of the GlassFish server. This configuration holds information about the domain and the port to undeploy the war. (Required)

To undeploy an application, select the following highlighted step:

Then, enter the following parameters:

When the job is executed, you should see the following job detail, note the output indicating the application was undeployed:

In the UndeployApp step, click the Log icon to see the diagnostic info. The output is similar to the following diagnostic report:

Release notes

EC-Glassfish 1.0.5

  • The documentation has been migrated to the main documentation site.

EC-Glassfish 1.0.4

  • The plugin icon has been updated.

EC-Glassfish 1.0.3

  • Fixed issue with configurations being cached for IE.

EC-Glassfish 1.0.2

  • Renamed to CloudBees CD.

EC-Glassfish 1.0.1

  • Procedure name(s) were changed in the step picker section

EC-Glassfish 1.0.0

  • Start Server Domain

  • Stop Server Domain

  • Deploy App

  • Undeploy App

  • Check Server Status