org.glassfish.web.plugin.common

Class WebModuleConfigCommand

java.lang.Object

org.glassfish.web.plugin.common.WebModuleConfigCommand

All Implemented Interfaces:

AdminCommand

Direct Known Subclasses:

ListWebContextParamCommand, ListWebEnvEntryCommand, SetWebContextParamCommand, UnsetWebContextParamCommand, WebEnvEntryCommand

public abstract class WebModuleConfigCommand
extends Object
implements AdminCommand

Superclass of all web module config-related commands. All of these commands have the app-name (with perhaps /module-name appended) as a required argument.

Author:

tjquinn

Field Summary

Fields

Modifier and Type	Field and Description
protected static LocalStringManagerImpl	localStrings

Constructor Summary

Constructors

Constructor and Description
WebModuleConfigCommand()

Method Summary

Modifier and Type	Method and Description
protected String	appName()
protected String	appNameAndOptionalModuleName()
protected String	descriptionValueOrNotSpecified(String value)
protected Engine	engine(ActionReport report)
protected ActionReport	fail(ActionReport report, Exception e, String msgKey, String defaultFormat, Object... args)
protected ActionReport	fail(ActionReport report, String msgKey, String defaultFormat, Object... args)
protected String	moduleName() Returns either the explicit module name (if the command argument specified one) or the app name.
protected ActionReport	succeed(ActionReport report, String msgKey, String defaultFormat, Object... args)
protected WebModuleConfig	webModuleConfig(ActionReport report)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.glassfish.api.admin.AdminCommand

execute

Field Detail

localStrings

protected static final LocalStringManagerImpl localStrings

Constructor Detail

WebModuleConfigCommand

public WebModuleConfigCommand()

Method Detail

webModuleConfig

protected WebModuleConfig webModuleConfig(ActionReport report)

engine

protected Engine engine(ActionReport report)

moduleName

protected String moduleName()

Returns either the explicit module name (if the command argument specified one) or the app name. An app can contain a module with the same name.

Returns:

module name inferred from the command arguments

appName

protected String appName()

appNameAndOptionalModuleName

protected String appNameAndOptionalModuleName()

fail

protected ActionReport fail(ActionReport report,
                            Exception e,
                            String msgKey,
                            String defaultFormat,
                            Object... args)

fail

protected ActionReport fail(ActionReport report,
                            String msgKey,
                            String defaultFormat,
                            Object... args)

succeed

protected ActionReport succeed(ActionReport report,
                               String msgKey,
                               String defaultFormat,
                               Object... args)

descriptionValueOrNotSpecified

protected String descriptionValueOrNotSpecified(String value)