Package com.pnfsoftware.jeb.core

Class JebCoreService

java.lang.Object
com.pnfsoftware.jeb.core.JebCoreService
public class JebCoreService extends Object
Service class used to create or retrieve a reference to the JEB core context. The core context provides verified access to the engines.

Typically, it is the responsibility of client implementations (eg, the official RCP client), not plugins, to instantiate the core and a single engines context.

  • Constructor Details

    • JebCoreService

      public JebCoreService()

  • Method Details

    • getExistingInstance

      public static ICoreContext getExistingInstance()
      Retrieve an existing core context (= JEB back-end) if one exists. If none exist, null is returned.
      Returns:
      the unique JEB context or null if none was created

    • getInstance

      public static ICoreContext getInstance() throws JebException
      Retrieve an instance of the previously instantiated core.
      Returns:
      the unique JEB context
      Throws:
      JebException - on error

    • getInstance

      public static ICoreContext getInstance(String licenseKey) throws JebException
      Retrieve or create an instance of a core.
      Parameters:
      licenseKey - a valid JEB license key
      Returns:
      the unique JEB context
      Throws:
      JebException - on error

    • getInstance

      public static ICoreContext getInstance(String licenseKey, CoreOptions options) throws JebException
      Retrieve or create an instance of a core.
      Parameters:
      licenseKey - a valid JEB license key
      options - optional core options
      Returns:
      the unique JEB context
      Throws:
      JebException - on error

    • getInstance

      public static ICoreContext getInstance(File baseFolder, CoreOptions options) throws JebException
      Retrieve or create a core instance using a JEB installation folder.
      Parameters:
      baseFolder - JEB installation folder
      options - optional core options; if one is provided, its base folder attribute must match the provided baseFolder parameter
      Returns:
      the unique JEB context
      Throws:
      JebException - on core initialization error

    • getInstance

      public static ICoreContext getInstance(File baseFolder) throws JebException
      Retrieve or create a core instance using a JEB installation folder.
      Parameters:
      baseFolder - JEB installation folder
      Returns:
      the unique JEB context
      Throws:
      JebException - on core initialization error

    • getDefaultEnginesContext

      public static IEnginesContext getDefaultEnginesContext()
      Convenience method used to retrieve the primary (default) engines context managed by an initialized JEB core back-end.
      Returns:
      the default engines context, or null if no engines context is available

    • notifyExceptionToClient

      public static void notifyExceptionToClient(Throwable throwable, int flags, Map<String,Object> extradata, IUnit unit)
      Convenience method to "forward" (via an event) a throwable to the client for processing. The client may decide to ignore, display, or further process (eg, report or log) the exception.
      Parameters:
      throwable - an error or exception
      flags - internal flags
      extradata - optional
      unit - optional unit object from which the exception originated

    • notifyExceptionToClient

      public static void notifyExceptionToClient(Throwable throwable)
      Parameters:
      throwable - an error or exception

    • notifySilentExceptionToClient

      public static void notifySilentExceptionToClient(Throwable throwable)
      Parameters:
      throwable - an error or exception

    • notifySilentExceptionToClient

      public static void notifySilentExceptionToClient(Throwable throwable, IUnit unit)
      Parameters:
      throwable - an error or exception
      unit - optional unit object from which the exception originated

    • notifySilentExceptionToClient

      public static void notifySilentExceptionToClient(Throwable throwable, Map<String,Object> extradata)
      Parameters:
      throwable - an error or exception
      extradata - optional

    • silentExcept

      public static void silentExcept(Throwable throwable)
      Internal method reserved for debug builds.
      Parameters:
      throwable - exception to rethrow in debug builds or report silently in release builds

    • notifyTelemetryToClient

      public static void notifyTelemetryToClient(String eventName, Map<String,String> properties)
      Forward a telemetry notification to the client.
      Parameters:
      eventName - telemetry event name
      properties - optional event properties

    • notifyTelemetryToClient

      public static void notifyTelemetryToClient(String eventName)
      Forward a telemetry notification with no properties to the client.
      Parameters:
      eventName - telemetry event name

    • notifyTelemetryToClient

      public static void notifyTelemetryToClient(String eventName, String key0, String value0)
      Forward a telemetry notification with a single property to the client.
      Parameters:
      eventName - telemetry event name
      key0 - property name
      value0 - property value

    • notifyTelemetryToClient

      public static void notifyTelemetryToClient(String eventName, String key0, String value0, String key1, String value1)
      Forward a telemetry notification with two properties to the client.
      Parameters:
      eventName - telemetry event name
      key0 - first property name
      value0 - first property value
      key1 - second property name
      value1 - second property value

    • getConfiguration

      public static IConfiguration getConfiguration(File file, boolean createIfNotExist, boolean saveChanges) throws IOException
      Create a configuration object for a JEB configuration file, such as jeb-engines.cfg.
      Parameters:
      file - a JEB configuration file
      createIfNotExist - create a new configuration file if it does not exist already
      saveChanges - if true, changes made to the configuration file will be saved to disk; else, the changes will not be recorded
      Returns:
      the configuration object, set up for reading and writing
      Throws:
      IOException - if the configuration file cannot be created or loaded