Package com.pnfsoftware.jeb.core

Class CoreOptions

java.lang.Object
com.pnfsoftware.jeb.core.CoreOptions
public class CoreOptions extends Object
Public options for ICoreContext. Use through JebCoreService. Options are set up by JEB clients.

  • Method Details

    • setControllerInfo

      public void setControllerInfo(ControllerInfo info)
      Set floating-controller connection information.
      Parameters:
      info - controller information, or null to clear it

    • getControllerInfo

      public ControllerInfo getControllerInfo()
      Get the configured floating-controller connection information.
      Returns:
      controller information, or null if none was configured

    • setAllowAsynchronousProcessing

      public void setAllowAsynchronousProcessing(boolean allowAsynchronousProcessing)
      Enable or disable asynchronous processing for plugins.
      Parameters:
      allowAsynchronousProcessing - true to allow asynchronous processing

    • isAllowAsynchronousProcessing

      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.
      Returns:
      true if asynchronous processing is globally allowed

    • setUIClient

      public void setUIClient(boolean enabled)
      Same as setAllowAsynchronousProcessing(boolean).
      Parameters:
      enabled - true to indicate a UI client

    • isUIClient

      public boolean isUIClient()
      Same as isAllowAsynchronousProcessing().
      Returns:
      true if the current client should be treated as a UI client

    • setDevelopmentMode

      public void setDevelopmentMode(boolean developmentMode)
      Enable or disable development mode.
      Parameters:
      developmentMode - true to enable development mode

    • isDevelopmentMode

      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).
      Returns:
      true if development mode is enabled

    • setJebClassesLocation

      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

    • getJebClassesLocation

      public File getJebClassesLocation()
      Get the location of JEB classes.
      Returns:
      a jar file (jeb.jar), or a bin/ folder containing classfiles

    • setStandardProxyInfo

      public void setStandardProxyInfo(NetProxyInfo proxyInfo)
      Standard proxy options provided by a client.
      Parameters:
      proxyInfo - optional; engines settings override those

    • getStandardProxyInfo

      public NetProxyInfo getStandardProxyInfo()
      Get the standard proxy options provided by the client.
      Returns:
      proxy information, or null if none was provided

    • setBaseFolder

      public void setBaseFolder(File baseFolder)
      Set the base JEB installation folder.
      Parameters:
      baseFolder - installation folder

    • getBaseFolder

      public File getBaseFolder()
      Get the base JEB installation folder.
      Returns:
      installation folder, or null if unset

    • getDefault

      @Deprecated public static CoreOptions getDefault()
      Deprecated.
      use createDefault()
      Create a default options container.
      Returns:
      default options instance

    • createDefault

      public static CoreOptions createDefault()
      Create a default options container.
      Returns:
      default options instance