com.sun.enterprise.v3.admin

Class CommandRunnerImpl

java.lang.Object

com.sun.enterprise.v3.admin.CommandRunnerImpl

All Implemented Interfaces:

org.glassfish.api.admin.CommandRunner

@Service
public class CommandRunnerImpl
extends Object
implements org.glassfish.api.admin.CommandRunner

Encapsulates the logic needed to execute a server-side command (for example, a descendant of AdminCommand) including injection of argument values into the command.

Author:

dochez, tjquinn, Bill Shannon

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.api.admin.CommandRunner

org.glassfish.api.admin.CommandRunner.CommandInvocation

Constructor Summary

Constructors

Constructor and Description
CommandRunnerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
org.glassfish.api.ActionReport	getActionReport(String name) Returns an initialized ActionReport instance for the passed type or null if it cannot be found.
org.glassfish.api.admin.AdminCommand	getCommand(String commandName, org.glassfish.api.ActionReport report, Logger logger) Obtain and return the command implementation defined by the passed commandName for the null scope.
org.glassfish.api.admin.AdminCommand	getCommand(String scope, String commandName, org.glassfish.api.ActionReport report, Logger logger) Obtain and return the command implementation defined by the passed commandName.
org.glassfish.api.admin.CommandRunner.CommandInvocation	getCommandInvocation(String name, org.glassfish.api.ActionReport report, Subject subject) Obtain a new command invocation object for the null scope.
org.glassfish.api.admin.CommandRunner.CommandInvocation	getCommandInvocation(String scope, String name, org.glassfish.api.ActionReport report, Subject subject) Obtain a new command invocation object.
void	getHelp(org.glassfish.api.admin.AdminCommand command, org.glassfish.api.ActionReport report)
BufferedReader	getHelp(org.glassfish.api.admin.CommandModel model)
static BufferedReader	getManPage(String commandName, org.glassfish.api.admin.CommandModel model) Return an InputStream for the man page for the named command.
org.glassfish.api.admin.CommandModel	getModel(String commandName, Logger logger) Returns the command model for a command name.
org.glassfish.api.admin.CommandModel	getModel(String scope, String commandName, Logger logger) Returns the command model for a command name.
boolean	validateCommandModelETag(org.glassfish.api.admin.AdminCommand command, String eTag)
boolean	validateCommandModelETag(org.glassfish.api.admin.CommandModel model, String eTag)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandRunnerImpl

public CommandRunnerImpl()

Method Detail

getActionReport

public org.glassfish.api.ActionReport getActionReport(String name)

Returns an initialized ActionReport instance for the passed type or null if it cannot be found.

Specified by:

getActionReport in interface org.glassfish.api.admin.CommandRunner

Parameters:

name - action report type name

Returns:

uninitialized action report or null

getModel

public org.glassfish.api.admin.CommandModel getModel(String commandName,
                                            Logger logger)

Returns the command model for a command name.

Specified by:

getModel in interface org.glassfish.api.admin.CommandRunner

Parameters:

commandName - command name

logger - logger to log any error messages

Returns:

model for this command (list of parameters,etc...), or null if command is not found

getModel

public org.glassfish.api.admin.CommandModel getModel(String scope,
                                            String commandName,
                                            Logger logger)

Returns the command model for a command name.

Specified by:

getModel in interface org.glassfish.api.admin.CommandRunner

Parameters:

commandName - command name

logger - logger to log any error messages

Returns:

model for this command (list of parameters,etc...), or null if command is not found

validateCommandModelETag

public boolean validateCommandModelETag(org.glassfish.api.admin.AdminCommand command,
                               String eTag)

Specified by:

validateCommandModelETag in interface org.glassfish.api.admin.CommandRunner

validateCommandModelETag

public boolean validateCommandModelETag(org.glassfish.api.admin.CommandModel model,
                               String eTag)

Specified by:

validateCommandModelETag in interface org.glassfish.api.admin.CommandRunner

getCommand

public org.glassfish.api.admin.AdminCommand getCommand(String commandName,
                                              org.glassfish.api.ActionReport report,
                                              Logger logger)

Obtain and return the command implementation defined by the passed commandName for the null scope.

Specified by:

getCommand in interface org.glassfish.api.admin.CommandRunner

Parameters:

commandName - command name as typed by users

report - report used to communicate command status back to the user

logger - logger to log

Returns:

command registered under commandName or null if not found

getCommand

public org.glassfish.api.admin.AdminCommand getCommand(String scope,
                                              String commandName,
                                              org.glassfish.api.ActionReport report,
                                              Logger logger)

Obtain and return the command implementation defined by the passed commandName.

Specified by:

getCommand in interface org.glassfish.api.admin.CommandRunner

Parameters:

commandName - command name as typed by users

report - report used to communicate command status back to the user

logger - logger to log

Returns:

command registered under commandName or null if not found

getCommandInvocation

public org.glassfish.api.admin.CommandRunner.CommandInvocation getCommandInvocation(String name,
                                                                           org.glassfish.api.ActionReport report,
                                                                           Subject subject)

Obtain a new command invocation object for the null scope. Command invocations can be configured and used to trigger a command execution.

Specified by:

getCommandInvocation in interface org.glassfish.api.admin.CommandRunner

Parameters:

name - name of the requested command to invoke

report - where to place the status of the command execution

subject - the Subject under which to execute the command

Returns:

a new command invocation for that command name

getCommandInvocation

public org.glassfish.api.admin.CommandRunner.CommandInvocation getCommandInvocation(String scope,
                                                                           String name,
                                                                           org.glassfish.api.ActionReport report,
                                                                           Subject subject)

Obtain a new command invocation object. Command invocations can be configured and used to trigger a command execution.

Specified by:

getCommandInvocation in interface org.glassfish.api.admin.CommandRunner

Parameters:

scope - the scope (or name space) for the command

name - name of the requested command to invoke

report - where to place the status of the command execution

subject - the Subject under which to execute the command

Returns:

a new command invocation for that command name

getHelp

public BufferedReader getHelp(org.glassfish.api.admin.CommandModel model)
                       throws com.sun.enterprise.v3.admin.CommandNotFoundException

Specified by:

getHelp in interface org.glassfish.api.admin.CommandRunner

Throws:

com.sun.enterprise.v3.admin.CommandNotFoundException

getHelp

public void getHelp(org.glassfish.api.admin.AdminCommand command,
           org.glassfish.api.ActionReport report)

getManPage

public static BufferedReader getManPage(String commandName,
                        org.glassfish.api.admin.CommandModel model)

Return an InputStream for the man page for the named command.