Package com.aspectran.shell.service

Interface ShellService

All Superinterfaces:

CoreService

All Known Implementing Classes:

AbstractShellService, AspectranShellService

public interface ShellService
extends CoreService

The Interface ShellService.

Created: 2017. 10. 28.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getGreetings()
boolean	isExposable(java.lang.String transletName)	Checks whether the Translet can be exposed.
boolean	isVerbose()	Tests if the verbose mode is enabled.
SessionAdapter	newSessionAdapter()	Create and return a new session adapter from the shell service.
void	printGreetings()	Prints welcome message.
void	printHelp()	Prints help information.
void	setGreetings(java.lang.String greetings)
void	setVerbose(boolean verbose)	Enables or disables the verbose mode.
Translet	translate(TransletCommandLine transletCommandLine, Console console)	Executes the translet.

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

getActivityContext, getApplicationAdapter, getAspectranClassLoader, getAspectranConfig, getBasePath, getServiceController, isHardReload, isLateStart, joinDerivedService

Method Detail

newSessionAdapter

SessionAdapter newSessionAdapter()

Create and return a new session adapter from the shell service.

Returns:

the session adapter

isVerbose

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.

Returns:

true if the verbose mode is enabled

setVerbose

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.

Parameters:

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

getGreetings

java.lang.String getGreetings()

setGreetings

void setGreetings(java.lang.String greetings)

printGreetings

void printGreetings()

Prints welcome message.

printHelp

void printHelp()

Prints help information.

isExposable

boolean isExposable(java.lang.String transletName)

Checks whether the Translet can be exposed.

Parameters:

transletName - the name of the Translet to check

Returns:

true if the Translet can be exposed; false otherwise

translate

Translet translate(TransletCommandLine transletCommandLine,
                   Console console)

Executes the translet.

Parameters:

transletCommandLine - the translet command line

console - the Console instance

Returns:

the Translet instance