Index (jexler-core API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

add(Service) - Method in ServiceGroup: Add given service to the group of services.

B

build() - Method in JexlerContainerSources.Builder: builds a new instance of ch.artecat.grengine.sources.DirBasedSources.

C

close() - Method in JexlerContainer: Stop the shared quartz scheduler, plus close maybe other things.
compareTo(Issue) - Method in Issue: Comparator, newer date is smaller (first).
CRON_NOW_AND_STOP - Field in CronService: Pseudo cron string for a single cron event immediately, followed by a single stop event.
CRON_NOW - Field in CronService: Pseudo cron string for a single cron event immediately.
CronEvent - Class in ch.grengine.jexler.service: Cron service event.
CronEvent(Service, String) - Constructor in CronEvent: Constructor.
CronService - Class in ch.grengine.jexler.service: A cron service, creates events at configurable times.
CronService.CronJob - Class in ch.grengine.jexler.service: Internal class, only public because otherwise not called by quartz scheduler.
CronService(Jexler, String) - Constructor in CronService: Constructor.

D

DEFAULT_LATENCY_MS - Field in JexlerContainerSources.Builder: the default latency (1000ms = 1 second).
deobfuscate(String) - Method in StringObfuscatorTool: Hex decode, decipher, unpad and UTF-8 decode given string.
DirWatchEvent - Class in ch.grengine.jexler.service: Directory watch service event.
DirWatchEvent(Service, File, Kind<Path>) - Constructor in DirWatchEvent: Constructor.
DirWatchService - Class in ch.grengine.jexler.service: Directory watch service, creates an event when a file in a given directory is created, modified oder deleted.
DirWatchService.DirWatchJob - Class in ch.grengine.jexler.service: Internal class, only public because otherwise not called by quartz scheduler.
DirWatchService(Jexler, String) - Constructor in DirWatchService: Constructor.
dispatch(Script) - Method in JexlerDispatcher

E

Event - Interface in ch.grengine.jexler.service: Interface for an event sent by a service to a jexler.
EventBase - Class in ch.grengine.jexler.service: Abstract event base implementation.
EventBase(Service) - Constructor in EventBase: Constructor.
events - Field in Jexler: Event queue.
execute(JobExecutionContext) - Method in CronService.CronJob
execute(JobExecutionContext) - Method in DirWatchService.DirWatchJob

F

forgetIssues() - Method in IssueTracker: Forget remembered issues.
forgetIssues() - Method in IssueTrackerBase
forgetIssues() - Method in Jexler
forgetIssues() - Method in JexlerContainer

G

getAsConfig() - Method in Jexler: Convenience method for getting ConfigSlurper config from parsing this jexler; uses the class already compiled by Grengine.
getAsConfig(String) - Method in JexlerContainer: Convenience method for getting ConfigSlurper config from parsing the given jexler; uses the class already compiled by Grengine.
getBuilder() - Method in JexlerContainerSources: gets the builder.
getCause() - Method in Issue: Get throwable that caused the issue, null if none.
getCompilerFactory() - Method in JexlerContainerSources.Builder: gets the compiler factory.
getContainer() - Method in Jexler: Get container that contains this jexler.
getContainer() - Method in JexlerContainerSources.Builder: gets the container.
getCron() - Method in CronEvent: Get cron pattern.
getCron() - Method in CronService: Get cron pattern.
getCron() - Method in DirWatchService: Get cron pattern.
getDate() - Method in Issue: Get date and time when the issue occurred.
getDir() - Method in DirWatchService: Get directory to watch.
getDir() - Method in Jexler: Get directory that contains script file.
getDir() - Method in JexlerContainer: Get container directory.
getEnv() - Method in ShellTool: Get environment variables for the command.
getFile() - Method in DirWatchEvent: Get file that has been created, modified or deleted.
getFile() - Method in Jexler: Get jexler script file.
getGrengine() - Method in JexlerContainer: Get container Grengine instance.
getId() - Method in Jexler
getId() - Method in Service: Get service id.
getId() - Method in ServiceBase
getId() - Method in ServiceGroup
getIssues() - Method in IssueTracker: Get remembered issues, most recent issue first.
getIssues() - Method in IssueTrackerBase: Returns an unmodifiable list.
getIssues() - Method in Jexler
getIssues() - Method in JexlerContainer
getJexler() - Method in CronService: Get jexler.
getJexler() - Method in DirWatchService: Get jexler.
getJexler(String) - Method in JexlerContainer: Get the jexler for the given id.
getJexlerFile(String) - Method in JexlerContainer: Get the file for the given jexler id, even if no such file exists (yet).
getJexlerId(File) - Method in JexlerContainer: Get the jexler id for the given file, even if the file does not exist (any more), or null if not a jexler script.
getJexlers() - Method in JexlerContainer: Get the list of all jexlers, first runnable jexlers, then non-runnable ones, each group sorted by id.
getKind() - Method in DirWatchEvent: Get what happened with the file.
getKinds() - Method in DirWatchService: Get kinds of events to watch for.
getLatencyMs() - Method in JexlerContainerSources.Builder: gets the latency in milliseconds.
getLogger() - Method in JexlerContainer: Get logger for container.
getMessage() - Method in Issue: Get message that explains the issue, may be null.
getMetaConfig() - Method in Jexler: Get meta config.
getModifiers() - Method in DirWatchService: Get modifiers when watching for events.
getScheduler() - Method in CronService: Get quartz scheduler.
getScheduler() - Method in DirWatchService: Get quartz scheduler.
getScheduler() - Method in JexlerContainer: Get shared quartz scheduler, already started.
getScript() - Method in Jexler: Get jexler script instance, null if script is not running.
getService() - Method in Event: Get service that sent the event.
getService() - Method in EventBase
getService() - Method in Issue: Get service where the issue occurred, may be null.
getServices() - Method in ServiceGroup: Get the list of services.
getSourceFactory() - Method in JexlerContainerSources.Builder: gets the source factory.
getSourceSetNew() - Method in JexlerContainerSources: gets the updated source set.
getStackTrace() - Method in Issue: Get exception stack trace as a multi-line string, empty if could not get it or no causing throwable.
getStackTrace(Throwable) - Method in JexlerUtil: Get stack trace for given throwable as a string.
getState() - Method in Jexler
getState() - Method in Service: Get service state.
getState() - Method in ServiceBase
getState() - Method in ServiceGroup: Get service state of the group.
getStderrLineHandler() - Method in ShellTool: Get closure for handling stderr lines.
getStdoutLineHandler() - Method in ShellTool: Get closure for handling stdout lines.
getWorkingDirectory() - Method in ShellTool: Get working directory for command.

H

handle(Event) - Method in Jexler: Handle given event.
hasStop() - Method in Jexler.Events: Return true if the event queue contains a stop event.

I

isBusy() - Method in ServiceState: Convenience method, returns true if busy.
isBusyEvent() - Method in ServiceState: Convenience method, returns true if BUSY_EVENT.
isBusyStarting() - Method in ServiceState: Convenience method, returns true if BUSY_STARTING.
isBusyStopping() - Method in ServiceState: Convenience method, returns true if BUSY_STOPPING.
isIdle() - Method in ServiceState: Convenience method, returns true if IDLE.
isOff() - Method in ServiceState: Convenience method, returns true if OFF.
isOn() - Method in ServiceState: Convenience method, returns true if not OFF.
isOperational() - Method in ServiceState: Convenience method, returns true if IDLE or BUSY_EVENT, in other words, if the service is up and processing events.
isRunnable() - Method in Jexler: Return true if jexler is indicated as a jexler in the first line of its script text (meta config); more precisely returns the state at startup if already running, else reads from file.
Issue - Class in ch.grengine.jexler: Issue.
Issue(Service, String, Throwable) - Constructor in Issue: Constructor from service, message and exception.
IssueTracker - Interface in ch.grengine.jexler: Interface for tracking issues.
IssueTrackerBase - Class in ch.grengine.jexler: Implementation of issue tracker interface.
IssueTrackerBase() - Constructor in IssueTrackerBase: Default constructor.

J

Jexler - Class in ch.grengine.jexler: Jexler, runs a Groovy script that handles events.
Jexler.Events - Class in ch.grengine.jexler: Blocking queue for events sent to a Jexler ('events' variable in jexler scripts).
Jexler(File, JexlerContainer) - Constructor in Jexler: Constructor.
JexlerContainer - Class in ch.grengine.jexler: Container of all jexlers in a directory.
JexlerContainer(File) - Constructor in JexlerContainer: Constructor from jexler script directory.
JexlerContainerSources - Class in ch.grengine.jexler: Implementation of the Grengine Sources interface for all non-runnable jexlers in a directory, i.e. for utility classes and ConfigSlurper config, etc., which is shared by several jexlers.
JexlerContainerSources.Builder - Class in ch.grengine.jexler
JexlerContainerSources.Builder(JexlerContainer) - Constructor in JexlerContainerSources.Builder: constructor from container.
JexlerContainerSources(JexlerContainerSources.Builder) - Constructor in JexlerContainerSources: constructor from builder.
JexlerDispatcher - Class in ch.grengine.jexler: Jexler dispatcher for use in jexler scripts.
JexlerUtil - Class in ch.grengine.jexler: Jexler utilities.

K

L

M

N

nextIsStop() - Method in Jexler.Events: Return true if there is a next event in the queue and it is a stop event.

O

obfuscate(String) - Method in StringObfuscatorTool: UTF-8 encode, pad with random bytes, encipher and hex encode given string.

P

Q

R

refresh() - Method in JexlerContainer: Refresh list of jexlers.
run(List<String>) - Method in ShellTool: Run the given shell command and return the result.

S

Service - Interface in ch.grengine.jexler.service: Interface for a service.
ServiceBase - Class in ch.grengine.jexler.service: Abstract service base implementation.
ServiceBase(String) - Constructor in ServiceBase: Constructor.
ServiceGroup - Class in ch.grengine.jexler.service: Service which is a group of services.
ServiceGroup(String) - Constructor in ServiceGroup: Constructor.
ServiceState - Enum in ch.grengine.jexler.service: Enum for the state of a service.
ServiceState(String) - Constructor in ServiceState: Constructor from info.
ServiceUtil - Class in ch.grengine.jexler.service: Service utilities.
setByteBufferPadLen(int) - Method in StringObfuscatorTool: Set the length to which to pad the plain string as UTF-8 encoded byte buffer.
setCompilerFactory(CompilerFactory) - Method in JexlerContainerSources.Builder: sets the compiler factory for compiling sources, default is a new instance of ch.artecat.grengine.code.groovy.DefaultGroovyCompilerFactory.
setCron(String) - Method in CronService: Set cron pattern, e.g. "* * * * *" or with seconds "0 * * * * *".
setCron(String) - Method in DirWatchService: Set cron pattern for when to check.
setDir(File) - Method in DirWatchService: Set directory to watch.
setEnvironment(Map<String, String>) - Method in ShellTool: Set environment variables for the command.
setKinds(Kind<Path>>) - Method in DirWatchService: Set kinds of events to watch for.
setLatencyMs(long) - Method in JexlerContainerSources.Builder: sets the latency in milliseconds for checking if script files in the directory have changed, default is DEFAULT_LATENCY_MS.
setModifiers(Modifier>) - Method in DirWatchService: Set modifiers when watching for events.
setParameters(String, String, String, String) - Method in StringObfuscatorTool: Set key, iv, algorithm and transformation.
setScheduler(Scheduler) - Method in CronService: Set quartz scheduler.
setScheduler(Scheduler) - Method in DirWatchService: Set quartz scheduler.
setSourceFactory(SourceFactory) - Method in JexlerContainerSources.Builder: sets the source factory for creating sources from files, default is a new instance of ch.artecat.grengine.source.DefaultSourceFactory.
setState(ServiceState) - Method in ServiceBase: Set state to given value.
setStderrLineHandler(Closure) - Method in ShellTool: Set a closure that will be called to handle each line of stderr.
setStdoutLineHandler(Closure) - Method in ShellTool: Set a closure that will be called to handle each line of stdout.
setWorkingDirectory(File) - Method in ShellTool: Set working directory for the command.
ShellTool - Class in ch.grengine.jexler.tool: Tool for running shell commands, just a thin wrapper around the java runtime exec calls.
ShellTool.Result - Class in ch.grengine.jexler.tool: Simple bean for the result of executing a shell command.
ShellTool.Result(int, String, String) - Constructor in ShellTool.Result
ShellTool() - Constructor in ShellTool: Constructor.
SHUTDOWN_TIMEOUT_MSG - Field in JexlerUtil
start() - Method in CronService
start() - Method in DirWatchService
start() - Method in Jexler: Initiate jexler start.
start() - Method in JexlerContainer: Start jexlers that are marked as autostart.
start() - Method in Service: Initiate service start.
start() - Method in ServiceGroup: Start all services in the group.
STARTUP_TIMEOUT_MSG - Field in JexlerUtil
stop() - Method in CronService
stop() - Method in DirWatchService
stop() - Method in Jexler: Initiate jexler stop by sending it a stop event to handle.
stop() - Method in JexlerContainer
stop() - Method in Service: Initiate service stop.
stop() - Method in ServiceGroup: Stop all services in a group.
StopEvent - Class in ch.grengine.jexler.service: Event to stop a running jexler.
StopEvent(Service) - Constructor in StopEvent: Constructor.
StringObfuscatorTool - Class in ch.grengine.jexler.tool: Tool for (de-)obfuscating strings.
StringObfuscatorTool() - Constructor in StringObfuscatorTool: Default constructor.

T

take() - Method in Jexler.Events: Take event from queue (blocks).
toQuartzCron(String) - Method in ServiceUtil: Convert to "quartz-style" cron with seconds.
toSingleLine(String) - Method in JexlerUtil: Replace line breaks in string with '%n'.
toString() - Method in Issue: Create a single line string of all members, suitable for logging.
toString() - Method in ShellTool.Result
trackIssue(Service, String, Throwable) - Method in IssueTracker: Convenience method for tracking an issue by giving its parameters.
trackIssue(Service, String, Throwable) - Method in IssueTrackerBase
trackIssue(Service, String, Throwable) - Method in Jexler
trackIssue(Service, String, Throwable) - Method in JexlerContainer

U

V

W

waitAtLeast(long) - Method in JexlerUtil: Wait at least for the indicated time in milliseconds.
waitForShutdown(JexlerContainer, long) - Method in JexlerUtil: Wait for container shutdown and report an issue for each jexler that did not shut down in time.
waitForShutdown(Service, long) - Method in ServiceUtil: Wait until service state is not OFF or timeout.
waitForStartup(JexlerContainer, long) - Method in JexlerUtil: Wait for container startup and report an issue for each jexler that did not start in time.
waitForStartup(Service, long) - Method in ServiceUtil: Wait until service state is not BUSY_STARTING or timeout.

X

Y

Z

zap() - Method in CronService
zap() - Method in DirWatchService
zap() - Method in Jexler
zap() - Method in Service: Forcefully terminate service, as far as possible; should not wait for anything, nor throw anything.
zap() - Method in ServiceGroup