public class

CoreOptions

extends Object
java.lang.Object
   ↳ com.pnfsoftware.jeb.core.CoreOptions

Class Overview

Public options for ICoreContext. Use through JebCoreService. Options are set up by JEB clients.

Summary

Public Methods
ControllerInfo getControllerInfo()
static CoreOptions getDefault()
File getJebClassesLocation()
Get the location of JEB classes.
NetProxyInfo getStandardProxyInfo()
boolean isAllowAsynchronousProcessing()
Determine if asynchronous processing is globally allowed for use in plugins.
boolean isDevelopmentMode()
Determine if development mode is on.
boolean isUIClient()
Same as isAllowAsynchronousProcessing().
void setAllowAsynchronousProcessing(boolean allowAsynchronousProcessing)
void setControllerInfo(ControllerInfo info)
void setDevelopmentMode(boolean developmentMode)
void setJebClassesLocation(File location)
Set the location of JEB classes.
void setStandardProxyInfo(NetProxyInfo proxyInfo)
Standard proxy options provided by a client.
void setUIClient(boolean enabled)
Same as setAllowAsynchronousProcessing(boolean).
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public ControllerInfo getControllerInfo ()

public static CoreOptions getDefault ()

public File getJebClassesLocation ()

Get the location of JEB classes.

Returns
  • a jar file (jeb.jar), or a bin/ folder containing classfiles

public NetProxyInfo getStandardProxyInfo ()

public boolean isAllowAsynchronousProcessing ()

Determine if asynchronous processing is globally allowed for use in plugins. Generally, non-interactive clients should forbid plugins from processing tasks asynchronously; conversely, it is recommended for UI clients to allow plugins to perform asynchronous tasks. Note that setting this option to true does not mean that a plugin supporting asynchronous operation will perform them asynchronously! Other parameters may intervene, such as configuration options, user preferences, etc. This attribute is merely a global switch.

public boolean isDevelopmentMode ()

Determine if development mode is on. By default, the Core runs in production mode. When development mode is on, additional logging may take place and the JEB engines may allow hot-swapping of some plugin types (in particular, contributions plugins written in Python are hot-swappable).

public boolean isUIClient ()

Same as isAllowAsynchronousProcessing().

public void setAllowAsynchronousProcessing (boolean allowAsynchronousProcessing)

public void setControllerInfo (ControllerInfo info)

public void setDevelopmentMode (boolean developmentMode)

public void setJebClassesLocation (File location)

Set the location of JEB classes. This method is reserved for internal use.

Parameters
location JEB classes file or directory

public void setStandardProxyInfo (NetProxyInfo proxyInfo)

Standard proxy options provided by a client.

Parameters
proxyInfo optional; engines settings override those

public void setUIClient (boolean enabled)

Same as setAllowAsynchronousProcessing(boolean).