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 java.lang.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

protected static LocalStringManagerImpl

localStrings

Constructor Summary

WebModuleConfigCommand()

Method Summary

protected java.lang.String	appName()
protected java.lang.String	appNameAndOptionalModuleName()
protected java.lang.String	descriptionValueOrNotSpecified(java.lang.String value)
protected Engine	engine(ActionReport report)
protected ActionReport	fail(ActionReport report, java.lang.Exception e, java.lang.String msgKey, java.lang.String defaultFormat, java.lang.Object... args)
protected ActionReport	fail(ActionReport report, java.lang.String msgKey, java.lang.String defaultFormat, java.lang.Object... args)
protected java.lang.String	moduleName() Returns either the explicit module name (if the command argument specified one) or the app name.
protected ActionReport	succeed(ActionReport report, java.lang.String msgKey, java.lang.String defaultFormat, java.lang.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 java.lang.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 java.lang.String appName()

appNameAndOptionalModuleName

protected java.lang.String appNameAndOptionalModuleName()

fail

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

fail

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

succeed

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

descriptionValueOrNotSpecified

protected java.lang.String descriptionValueOrNotSpecified(java.lang.String value)