Package io.dropwizard.cli

Class ServerCommand<T extends Configuration>

java.lang.Object

io.dropwizard.cli.Command

io.dropwizard.cli.ConfiguredCommand<T>

io.dropwizard.cli.EnvironmentCommand<T>

io.dropwizard.cli.ServerCommand<T>

Type Parameters:

T - the Configuration subclass which is loaded from the configuration file

public class ServerCommand<T extends Configuration>
extends EnvironmentCommand<T>

Runs a application as an HTTP server.

Constructor Summary

Constructors

Modifier	Constructor	Description
	ServerCommand(Application<T> application)
protected	ServerCommand(Application<T> application, java.lang.String name, java.lang.String description)	A constructor to allow reuse of the server command as a different name

Method Summary

Modifier and Type	Method	Description
protected java.lang.Class<T>	getConfigurationClass()	Returns the Class of the configuration type.
protected void	run(Environment environment, net.sourceforge.argparse4j.inf.Namespace namespace, T configuration)	Runs the command with the given Environment and Configuration.

Methods inherited from class io.dropwizard.cli.Command

getDescription, getName, onError

Methods inherited from class io.dropwizard.cli.ConfiguredCommand

addFileArgument, cleanup, cleanupAsynchronously, configure, run

Methods inherited from class io.dropwizard.cli.EnvironmentCommand

run

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerCommand

public ServerCommand(Application<T> application)

ServerCommand

protected ServerCommand(Application<T> application,
                        java.lang.String name,
                        java.lang.String description)

A constructor to allow reuse of the server command as a different name

Parameters:

application - the application using this command

name - the argument name to invoke this command

description - a summary of what the command does

Method Detail

getConfigurationClass

protected java.lang.Class<T> getConfigurationClass()

Description copied from class: ConfiguredCommand

Returns the Class of the configuration type.

Overrides:

getConfigurationClass in class ConfiguredCommand<T extends Configuration>

Returns:

the Class of the configuration type

run

protected void run(Environment environment,
                   net.sourceforge.argparse4j.inf.Namespace namespace,
                   T configuration)
            throws java.lang.Exception

Description copied from class: EnvironmentCommand

Runs the command with the given Environment and Configuration.

Specified by:

run in class EnvironmentCommand<T extends Configuration>

Parameters:

environment - the configured environment

namespace - the parsed command line namespace

configuration - the configuration object

Throws:

java.lang.Exception - if something goes wrong