Package com.aspectran.shell.service

Class AbstractShellService

java.lang.Object

com.aspectran.core.service.AbstractServiceController

com.aspectran.core.service.AbstractCoreService

com.aspectran.core.service.AspectranCoreService

com.aspectran.shell.service.AbstractShellService

All Implemented Interfaces:

CoreService, ServiceController, ShellService

public abstract class AbstractShellService
extends AspectranCoreService
implements ShellService

Abstract base class for ShellService implementations.

Created: 2017. 10. 30.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractShellService()

Method Summary

Modifier and Type	Method	Description
void	afterContextLoaded()	This method is executed immediately after the ActivityContext is loaded.
void	beforeContextDestroy()	This method executed just before the ActivityContext is destroyed.
CommandRegistry	getCommandRegistry()
java.lang.String[]	getCommands()
Console	getConsole()
java.lang.String	getGreetings()
boolean	isBusy()	Returns whether this service has any work in progress.
boolean	isExposable(java.lang.String transletName)	Checks whether the Translet can be exposed.
boolean	isVerbose()	Tests if the verbose mode is enabled.
SessionAdapter	newSessionAdapter()
void	printGreetings()	Prints welcome message.
void	printHelp()	Prints help information.
void	restart()	Restarts the service.
void	restart(java.lang.String message)	Restarts the service.
protected void	setCommands(java.lang.String[] commands)
protected void	setConsole(Console console)
void	setGreetings(java.lang.String greetings)
void	setVerbose(boolean verbose)	Enables or disables the verbose mode.

Methods inherited from class com.aspectran.core.service.AbstractCoreService

destroyActivityContext, getActivityContext, getApplicationAdapter, getAspectranClassLoader, getAspectranConfig, getBasePath, isHardReload, loadActivityContext, pauseSchedulerService, pauseSchedulerService, prepare, resumeSchedulerService, setActivityContext, setBasePath, setExposals, startSchedulerService, stopSchedulerService

Methods inherited from class com.aspectran.core.service.AbstractServiceController

getLock, getServiceName, isActive, pause, pause, resume, setServiceStateListener, start, stop

Methods inherited from class com.aspectran.core.service.AspectranCoreService

doPause, doPause, doRestart, doResume, doStart, doStop, isDerived

Methods inherited from interface com.aspectran.core.service.CoreService

getActivityContext, getApplicationAdapter, getAspectranClassLoader, getAspectranConfig, isHardReload

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspectran.core.service.ServiceController

getServiceName, isActive, isDerived, pause, pause, resume, setServiceStateListener, start, stop

Methods inherited from interface com.aspectran.shell.service.ShellService

execute, execute

Constructor Detail

AbstractShellService

protected AbstractShellService()
                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

afterContextLoaded

public void afterContextLoaded()
                        throws java.lang.Exception

Description copied from class: AspectranCoreService

This method is executed immediately after the ActivityContext is loaded.

Overrides:

afterContextLoaded in class AspectranCoreService

Throws:

java.lang.Exception - if an error occurs

beforeContextDestroy

public void beforeContextDestroy()

Description copied from class: AspectranCoreService

This method executed just before the ActivityContext is destroyed.

Overrides:

beforeContextDestroy in class AspectranCoreService

newSessionAdapter

public SessionAdapter newSessionAdapter()

Specified by:

newSessionAdapter in interface ShellService

getConsole

public Console getConsole()

Specified by:

getConsole in interface ShellService

setConsole

protected void setConsole(Console console)

getCommands

public java.lang.String[] getCommands()

Specified by:

getCommands in interface ShellService

setCommands

protected void setCommands(java.lang.String[] commands)

getCommandRegistry

public CommandRegistry getCommandRegistry()

Specified by:

getCommandRegistry in interface ShellService

isExposable

public boolean isExposable(java.lang.String transletName)

Description copied from interface: ShellService

Checks whether the Translet can be exposed.

Specified by:

isExposable in interface ShellService

Overrides:

isExposable in class AbstractCoreService

Parameters:

transletName - the name of the Translet to check

Returns:

true if the Translet can be exposed; false otherwise

isVerbose

public boolean isVerbose()

Tests if the verbose mode is enabled. If verbose mode is on, a detailed description is printed each time the command is executed. Returns a flag indicating whether to show the description or not.

Specified by:

isVerbose in interface ShellService

Returns:

true if the verbose mode is enabled

setVerbose

public void setVerbose(boolean verbose)

Enables or disables the verbose mode. If verbose mode is on, a detailed description is printed each time the command is executed. Sets a flag indicating whether to show the description or not.

Specified by:

setVerbose in interface ShellService

Parameters:

verbose - true to enable the verbose mode; false to disable

getGreetings

public java.lang.String getGreetings()

Specified by:

getGreetings in interface ShellService

setGreetings

public void setGreetings(java.lang.String greetings)

Specified by:

setGreetings in interface ShellService

printGreetings

public void printGreetings()

Description copied from interface: ShellService

Prints welcome message.

Specified by:

printGreetings in interface ShellService

printHelp

public void printHelp()

Description copied from interface: ShellService

Prints help information.

Specified by:

printHelp in interface ShellService

restart

public void restart()
             throws java.lang.Exception

Description copied from interface: ServiceController

Restarts the service.

Specified by:

restart in interface ServiceController

Overrides:

restart in class AbstractServiceController

Throws:

java.lang.Exception - if the service control fails

restart

public void restart(java.lang.String message)
             throws java.lang.Exception

Description copied from interface: ServiceController

Restarts the service.

Specified by:

restart in interface ServiceController

Overrides:

restart in class AbstractServiceController

Parameters:

message - the message to be delivered to the system before restart

Throws:

java.lang.Exception - if the service control fails

isBusy

public boolean isBusy()

Description copied from interface: ServiceController

Returns whether this service has any work in progress.

Specified by:

isBusy in interface ServiceController

Overrides:

isBusy in class AbstractServiceController

Returns:

true, if this service is busy; false otherwise