Home

Awesome

Apache TomEE-CLI

Join the chat at https://gitter.im/bitmaker-software/tomee-cli

Dependencies Status Build Status Coverage Status Release

This command line tool helps system administrators and developers to manage a instance of TomEE server.

Installation

Follow the steps below to install TomEE-CLI:

  1. Install and configure JDK 8.

  2. Install and configure Git.

  3. Install and configure Leiningen.

  4. Create the environment variable TOMEE_HOME pointing to the directory where TomEE is installed. It's optional, but it simplifies a lot the use of TomEE-CLI. Without it, you will have to inform the installation path everytime you call a function.

  5. Clone the repository locally:

    $ git clone https://github.com/bitmaker-software/tomee-cli.git

It will create the directory tomee-cli in the current location.

Checkstyle

To check code style in TomEE-CLI, enter in the directory and run:

$ lein cljfmt check

To fix code style run:

$ lein cljfmt fix

Test

To run test in TomEE-CLI, enter in the directory and run:

$ lein test

Execution

To run TomEE-CLI, enter in the directory and start the REPL:

$ cd tomee-cli
$ lein repl

The REPL starts with all utility functions available by default in the namespace. You can simply type the functions or use the autocomplete (Tab) to find the one that fits your needs.

Usage

Install TomEE

// Install the latest version of TomEE web profile in the working directory.
(install-tomee)

// Install the latest version of TomEE Plus in the working directory.
(install-tomee :dist "plus")

// Install the version 1.7 of TomEE Plus in the path /opt.
(install-tomee :version "1.7" :dist "plus" :location "/opt")

Start server:

tomee-cli.core=> (start "[path-to-tomee]")    // Without TOMEE_HOME variable defined.
tomee-cli.core=> (start)                      // With TOMEE_HOME variable defined.

Stop server:

tomee-cli.core=> (stop "[path-to-tomee]")     // Without TOMEE_HOME variable defined.
tomee-cli.core=> (stop)                       // With TOMEE_HOME variable defined.

Restart server:

tomee-cli.core=> (restart "[path-to-tomee]")  // Without TOMEE_HOME variable defined.
tomee-cli.core=> (restart)                    // With TOMEE_HOME variable defined.

Print versions of the environment:

tomee-cli.core=> (version "[path-to-tomee]")  // Without TOMEE_HOME variable defined.
tomee-cli.core=> (version)                    // With TOMEE_HOME variable defined.

Deploy application:

tomee-cli.core=> (deploy "[path-to-tomee]" "[path-to-war/ear-file]")
tomee-cli.core=> (deploy "[path-to-war/ear-file]")

Undeploy application:

tomee-cli.core=> (undeploy "[path-to-tomee]" "[war/ear-file]")
tomee-cli.core=> (undeploy "[war/ear-file]")

Add new mail resource in tomee.xml:

tomee-cli.core=> (add-mail-resource :path "[TOMEE_HOME]" :id "[id-to-resource]" :host "[host-to-email-server]" :port "[port-to-email-server]" :protocol "[protocol-to-email-server]" :auth "[true/false]" :user "[username]" :password "[password]")

The parameters don't have ordenation. You need only specify the key, like the sample.

Default values:

:port = 25

:password = ""

:path = TOMEE_HOME

Add new datasource in tomee.xml:

tomee-cli.core=> (add-datasource-resource :path "[TOMEE_HOME]" :id "[id-to-resource]" :jdbc-drive "[jdbc-drive]" :jdbc-url "[jdbc-url]" :username "[username]" :password "[password]" :jta-managed "[jta-managed]"])

The parameters don't have ordenation. You need only specify the key, like the sample.

Default values:

:jdbc-drive = "org.hsqldb.jdbcDriver"

:jdbc-url = "jdbc:hsqldb:file:data/hsqldb/hsqldb"

:username = "sa"

:password = ""

:jta-managed = true.

:path = TOMEE_HOME.

License

Copyright 2015 Bitmaker Software LDA and/or its affiliates and other contributors as indicated by the @authors tag. All rights reserved.

Distributed under the Apache License V2.

Bitdeli Badge