heringsfish-cli v0.9.7

Heringsfish Command Line Interface (cli)

Command Line Interface to manages the Glassfish / Payara Application Server and the maven deployment on local machine

This is the last version of the version 0.x.x

Table of Content

• Overview
• Requirement
• Installation
• Find Help
• Quick Startup
• Configure
  • Example of Configure
  • List of Action
  • JDBC Configuration
  • Replaced Variables
  • Environment Variables
• Road Map
• History
• License
• Third Party

Overview

The CLI allows you to a GlassFish or Payara Application Server easy to use and a encapsulated development environment for your JEE set 7 project.

Requirement

The following programs or modules are necessary:

• Node JS: This cli is tested with the version 4.x and 6.x
• Set the environment variable JAVA_HOME must be set.
• Application Server Glassfish 4.1 or Payara 4.1: Just install the server somewhere on your computer or in the project.
• Maven: The command mvn should in your PATH or setup in the configuration
• An Java IDE :-)

Installation

Global install:

$ npm install -g heringsfish-cli

Github

$ cd /path/to/your/projects
$ git clone https://github.com/blueskyfish/heringsfish-cli.git
$ cd heringsfish-cli
$ npm install
$ npm test
$ npm link

Note: the command npm link creates an short link to the program. Now your are able to type in your console window hf .... May you need to call sudo npm link.

Find Help

Every action has a help or explanation page.

The command hf help [action] shows the help or explanation page. The help command shows all possible actions, when omitted the action parameter.

$ hf help
$ hf help init
$ hf help build

Quick Startup

( 1) $ cd /your/project
( 2) $ hf init
( 3) $ hf create
( 4) $ hf start
( 5) $ hf jdbc create --name testDB
( 6) $ hf deploy
( 7) $ open "http://localhost:30048/
( 8) $ open "http://localhost:30080/your-project
( 9) $ hf undeploy
(10) $ hf stop
(11) $ hf remove

1. Change into your project
2. Initialize the configuration for your project.
3. Set create the domain
4. Start the application server
5. Create a JDB connection pool and JDBC resource
6. Start the deployment
7. Open the Admin Console of the application server
8. Open your deployed web/rest (etc) application
9. Undeploy the deployed application
10. Stop the application server
11. Remove and delete the domain.

Configure

The configure settings are in the file server-config.json. This file is in the project root directory and has format JSON.

• edit the file server-config.json directly. example: $ nano server-config.json

Table of Configurable Settings

Example of Configure

{
    "name": "test-project",
    "version": "0.1.0-SNAPSHOT",
    "server": {
        "home": "{user.home}/bin/payara-4.1.1.154"
    },
    "maven": {
        "home": "{user.home}/bin/maven-3.3.4",
        "setting": "{project.home}/setting.xml",
        "project": "{project.home}/projects/pom.xml"
    },
    "domain": {
        "name": "test-project",
        "home": "{project.home}/domains",
        "deploy": {
            "rest-provider": "{project.home}/projects/rest-provider/target/rest-provider-0.1.0-SNAPSHOT.war",
            "business-beans": "{project.home}/projects/business-beans/target/business-beans-0.1.0-SNAPSHOT.jar"
        },
        "ports": {
            "base": 50000
        },
        "jdbc": {
            "testDB": {
                "dataSourceClassName": "com.mysql.jdbc.jdbc2.optional.MysqlDataSource",
                "restype": "javax.sql.DataSource",
                "properties": {
                    "user": "user",
                    "password": "password",
                    "url": "jdbc:mysql://localhost:3306/test"
                },
                "description": "This is the Test Database"
            }
        }
    },
    "command": {
        "timeout": 120000,
        "asadmin": {
            "win32": "{server.home}/bin/asadmin.bat",
            "unix": "{server.home}/bin/asadmin"
        }
    },
    "env": {
        "project.home": "{project.home}",
        "user.home": "{user.home}",
        "project.name": "{project.name}",
        "project.version": "{project.version}"
    }
}

List of Action

JDBC Configuration

Documentation on Oracle

• Create JDBC Connection Pool https://docs.oracle.com/cd/E26576_01/doc.312/e24938/create-jdbc-connection-pool.htm#GSRFM00036
• Create JDBC Resource https://docs.oracle.com/cd/E26576_01/doc.312/e24938/create-jdbc-resource.htm#GSRFM00037
• Delete JDBC Connection Pool https://docs.oracle.com/cd/E26576_01/doc.312/e24938/delete-jdbc-connection-pool.htm#GSRFM00088
• Delete JDBC Resource https://docs.oracle.com/cd/E26576_01/doc.312/e24938/delete-jdbc-resource.htm#GSRFM00089
• Ping JDBC Connection Pool https://docs.oracle.com/cd/E26576_01/doc.312/e24938/ping-connection-pool.htm#GSRFM00214

Replaced Variables

Certain variables can be replaced. The Application Server can be included in the project. By means of the variable project.home the directory of the project can be used.

For Example:

{
  "server": {
    "name": "${project.home}/tools/payara-4.1.1.154"
  }
}

Environment Variables

It is possible to define environment variables in the section env, which are also transferred when the application server starts.

See example above.

Road Map

• Extends and defines project plugins. Every project should have own plugins.

History

License

The MIT License (MIT)

Copyright (c) 2017 BlueSkyFish

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Third Party

All company, brand and product names are trademarks of their respective owners.