org.jooby.crash

Class Crash

java.lang.Object

org.jooby.crash.Crash

All Implemented Interfaces:

Jooby.Module

public class Crash
extends Object
implements Jooby.Module

crash

Connect, monitor or use virtual machine resources via SSH, telnet or HTTP with CRaSH remote shell.

usage

 import org.jooby.crash;

 {
   use(new Crash());
 }
 

That's all you need to get CRaSH up and running!!!

Now is time to see how to connect and interact with the CRaSH shell

commands

You can write additional shell commands using Groovy or Java, see the CRaSH documentation for details. CRaSH search for commands in the cmd folder.

Here is a simple ‘hello’ command that could be loaded from cmd/hello.groovy folder:

 package commands

 import org.crsh.cli.Command
 import org.crsh.cli.Usage
 import org.crsh.command.InvocationContext

 class hello {

  @Usage("Say Hello")
  @Command
  def main(InvocationContext context) {
      return "Hello"
  }

 }
 

Jooby adds some additional attributes and commands to InvocationContext that you can access from your command:

• registry: Access to Registry.
• conf: Access to Config.

routes command

The routes print all the application routes.

conf command

The conf tree print the application configuration tree (configuration precedence).

The conf props [path] print all the application properties, sub-tree or a single property if path argument is present.

connectors

HTTP connector

The HTTP connector is a simple yet powerful collection of HTTP endpoints where you can run CRaSH command:

 {
   use(new Crash()
      .plugin(HttpShellPlugin.class)
   );
 }
 

Try it:

 GET /api/shell/thread/ls
 

OR:

 GET /api/shell/thread ls
 

The connector listen at /api/shell. If you want to mount the connector some where else just set the property: crash.httpshell.path.

SSH connector

Just add the crash.connectors.ssh dependency to your project.

Try it:

 ssh -p 2000 admin@localhost
 

Default user and password is: admin. See how to provide a custom authentication plugin.

telnet connector

Just add the crash.connectors.telnet dependency to your project.

Try it:

 telnet localhost 5000
 

Checkout complete telnet connector configuration.

web connector

Just add the crash.connectors.web dependency to your project.

Try it:

 GET /shell
 

A web shell console will be ready to go at /shell. If you want to mount the connector some where else just set the property: crash.webshell.path.

Since:

1.0.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Crash() Creates a new Crash module.
Crash(ClassLoader loader) Creates a new Crash module.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder)
Crash	plugin(Class<? extends org.crsh.plugin.CRaSHPlugin> plugin) Add a custom plugin to CRaSH.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Crash

public Crash(ClassLoader loader)

Creates a new Crash module.

Parameters:

loader - Class loader to use or null.

Crash

public Crash()

Creates a new Crash module.

Method Detail

plugin

public Crash plugin(Class<? extends org.crsh.plugin.CRaSHPlugin> plugin)

Add a custom plugin to CRaSH.

Parameters:

plugin - Plugin class.

Returns:

This module.

configure

public void configure(Env env,
                      com.typesafe.config.Config conf,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

config

public com.typesafe.config.Config config()

Specified by:

config in interface Jooby.Module