eu.toennies.javahttpobservatoryapi.commands

Class ApiCommand

java.lang.Object

eu.toennies.javahttpobservatoryapi.commands.ApiCommand

Direct Known Subclasses:

GetCommandWithoutParameter, InvokeAssessmentCommand, RecentScansCommand, RetrieveAssessmentCommand, RetrieveTestResultsCommand

public abstract class ApiCommand
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CMD_PREFIX
static String	DEFAULT_LONG_CMD_PREFIX

Constructor Summary

Constructors

Constructor and Description
ApiCommand(String apiCommand, String console, String consoleShort, String header, String description) Constructor for new API command.

Method Summary

Modifier and Type	Method and Description
void	addCommandArgument(CommandArgument param) Adds an argument to the command.
org.json.JSONObject	callApiCommand()
org.json.JSONObject	callApiCommand(Map<String,String> parameters)
String	getApiCommand() Retrieve the API command.
List<CommandArgument>	getCommandArguments() Retrieves the possible command parameters.
String	getConsoleCommand() The long command version used as program parameter.
String	getConsoleShortCommand() The short version used as program parameter
String	getDescription() Retrieve the description of the command.
String	getHeader()
String	getHelp()
boolean	hasArgs() Does this command has arguments?
abstract org.json.JSONObject	run(List<String> arguments)
boolean	shouldStart(List<String> arguments)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CMD_PREFIX

public static final String DEFAULT_CMD_PREFIX

See Also:

Constant Field Values

DEFAULT_LONG_CMD_PREFIX

public static final String DEFAULT_LONG_CMD_PREFIX

See Also:

Constant Field Values

Constructor Detail

ApiCommand

public ApiCommand(String apiCommand,
                  String console,
                  String consoleShort,
                  String header,
                  String description)

Constructor for new API command.

Parameters:

apiCommand - - the original API command as listed in the API documentation of Mozilla's HTTP Observatory

console - - the command for the console

consoleShort - - the short version of the console command

Method Detail

run

public abstract org.json.JSONObject run(List<String> arguments)
                                 throws IllegalArgumentException

Parameters:

arguments -

Returns:

the api response as a map

Throws:

IllegalArgumentException

getApiCommand

public String getApiCommand()

Retrieve the API command.

Returns:

the API command to send to the API endpoint

getConsoleCommand

public String getConsoleCommand()

The long command version used as program parameter.

Returns:

the command

getConsoleShortCommand

public String getConsoleShortCommand()

The short version used as program parameter

Returns:

the short command version

callApiCommand

public org.json.JSONObject callApiCommand()

getDescription

public String getDescription()

Retrieve the description of the command.

Returns:

the command description

getHeader

public String getHeader()

callApiCommand

public org.json.JSONObject callApiCommand(Map<String,String> parameters)

getHelp

public String getHelp()

getCommandArguments

public List<CommandArgument> getCommandArguments()

Retrieves the possible command parameters.

Returns:

the commandParameters

addCommandArgument

public void addCommandArgument(CommandArgument param)

Adds an argument to the command.

Parameters:

param - - the command argument to add

hasArgs

public boolean hasArgs()

Does this command has arguments?

Returns:

true if the command has arguments

shouldStart

public boolean shouldStart(List<String> arguments)