public interface

IClientContext

com.pnfsoftware.jeb.client.api.IClientContext
Known Indirect Subclasses

Class Overview

This interface represents a simplified client context. Client contexts are provided to JEB scripts at execution time.

Summary

Public Methods
abstract String[] getArguments()
Get the input arguments provided to this client context.
abstract String getBaseDirectory()
Get the JEB base directory.
abstract IEnginesContext getEnginesContext()
Get the primary JEB engines context.
abstract String getProgramDirectory()
Get the JEB program directory.
abstract Version getSoftwareVersion()
Get the JEB back-end software version.

Public Methods

public abstract String[] getArguments ()

Get the input arguments provided to this client context. The returned array depends on how the context was instantiated and called.

Returns
  • an array (possibly empty) or null if arguments are irrelevant in the current context

public abstract String getBaseDirectory ()

Get the JEB base directory.

Returns
  • the base directory

public abstract IEnginesContext getEnginesContext ()

Get the primary JEB engines context.

Returns
  • the primary engines context, possibly null if none was initialized

public abstract String getProgramDirectory ()

Get the JEB program directory. Typically, this is the bin/ sub-directory located within JEB installation folder.

Returns
  • the program directory

public abstract Version getSoftwareVersion ()

Get the JEB back-end software version.

Returns
  • the software version