Package com.pnfsoftware.jeb.client

Class HeadlessClientContext

java.lang.Object

com.pnfsoftware.jeb.util.events.EventSource

com.pnfsoftware.jeb.client.AbstractContext

com.pnfsoftware.jeb.client.AbstractClientContext

com.pnfsoftware.jeb.client.HeadlessClientContext

All Implemented Interfaces:

IClientContext, IEventSource

public class HeadlessClientContext
extends AbstractClientContext
implements IClientContext

Headless client context for the command-line client. This context is used:
- for license key generation in headless environments
- for command-line based software update
- as the base of the built-in script runner (v2)

Field Summary

Fields inherited from class com.pnfsoftware.jeb.client.AbstractClientContext

args, basicChecksPassed, CLIENT_RUNNING_FILENAME_PREFIX, coreOptions, defaultClientConfigPath, defaultEnginesConfigPath, defaultPluginsFolderName, defaultScriptsFolderName, defaultTelemetryDatabasePath, inputpath, INSTALLER_LOCK_FILENAME, scriptpath, ugerrstr

Fields inherited from class com.pnfsoftware.jeb.client.AbstractContext

app_company, app_dates, app_domain, app_email_licensing, app_email_support, app_email_updates, app_licensing_backup, app_name, app_uri, app_url_apidoc, app_url_changelog, app_url_chat, app_url_check_update, app_url_check_update_backup, app_url_devportal, app_url_donate, app_url_faq, app_url_faqmem, app_url_fileuploader, app_url_forum, app_url_genkey, app_url_genkey_backup, app_url_genlk, app_url_github, app_url_github_samples, app_url_github_samples_scripts, app_url_manual, app_url_motd, app_url_purchase, app_url_uploaderrorlog, app_ver, app_website, demo, integrity_failed, just_updated

Fields inherited from class com.pnfsoftware.jeb.util.events.EventSource

onEventCallCount

Constructor Summary

Constructors

Constructor	Description
HeadlessClientContext()	Create a headless client context.

Method Summary

Modifier and Type	Method	Description
boolean	checkUpdate()	Not called locally: it is entirely up to the client to implement and decide who calls this method.
void	displayDemoInformation(String demoInfo)	Display information about demo restrictions.
boolean	displayEula(String eula)	Display the end-user license agreement.
void	initialize(String[] argv)	Initialize the client context from command-line arguments and configuration files.
void	notifyFloatingClient(ControllerNotification notification)	Notify the client of a floating-controller event.
void	notifySupportExpired()	Notify the client that support or subscription benefits expired.
void	onUpdatedSoftware(String changelist, Version oldVersion)	Notify a concrete client that a new version of JEB is being run for the first time.
String	retrieveLicenseKey(String licdata)	Retrieve a license key from the user.
boolean	setupController()	Ask the client to configure floating-controller settings if needed.
void	start()	The headless implementation also initializes the JEB engines.
void	stop()	Stop the client context and release telemetry and core resources.

Methods inherited from class com.pnfsoftware.jeb.client.AbstractClientContext

assignCommandlineArguments, checkRunningInstaller, closeMainProject, closeOpenedProject, dumpProgramError, dumpUpdateToDisk, formatMemoryUsage, formatProcessInfo, generateLicenseInformation, getArguments, getConfiguration, getControllerInterface, getControllerMessage, getControllerPort, getControllerProtocol, getCoreContext, getEnginesContext, getInputpath, getLastPublicAnnouncementId, getLatestAvailableUpdate, getLogLevel, getMainProject, getMaxMemory, getNetworkUtility, getOpenedProject, getPreferredLanguage, getProcessId, getPropertyDefinitionManager, getPropertyManager, getProxyString, getScriptpath, getScriptsDirectory, getScriptsDirfile, getTelemetry, getTransientStore, getUpdateChannel, getUsedMemory, getUuid, hasOpenedProject, initializeEngines, isDevelopmentMode, isHeadless, logMemoryUsage, open, ping, retrieveLatestPublicAnnouncement, setControllerInterface, setControllerPort, setControllerProtocol, setDevelopmentMode, setLastPublicAnnouncementId, setLatestAvailableUpdate, setLogLevel, setPreferredLanguage, setProxyString, setScriptsDirectory, setUpdateChannel, shouldCheckPublicAnnouncements, shouldCheckUpdates

Methods inherited from class com.pnfsoftware.jeb.client.AbstractContext

getAppDirectory, getBaseDirectory, getChannelName, getCurrentDirectory, getJebClassesLocation, getProgramDirectory, getSoftwareVersion, getStartTimestamp, handleUncaughtException, initNetworkUtility, isPreRelease, terminate

Methods inherited from class com.pnfsoftware.jeb.util.events.EventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, notifyListeners, notifyListeners, relay, removeListener, setParentSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pnfsoftware.jeb.client.api.IClientContext

closeMainProject, getArguments, getBaseDirectory, getEnginesContext, getMainProject, getMaxMemory, getProcessId, getProgramDirectory, getSoftwareVersion, getTransientStore, getUsedMemory, open

Constructor Details

HeadlessClientContext

public HeadlessClientContext()

Create a headless client context.

Method Details

initialize

public void initialize(String[] argv)

Description copied from class: AbstractClientContext

Initialize the client context from command-line arguments and configuration files.

Overrides:

initialize in class AbstractClientContext

Parameters:

argv - command-line arguments

start

public void start()
           throws JebException

The headless implementation also initializes the JEB engines.

Overrides:

start in class AbstractClientContext

Throws:

JebException - on initialization or licensing error

stop

public void stop()

Description copied from class: AbstractClientContext

Stop the client context and release telemetry and core resources.

Overrides:

stop in class AbstractClientContext

displayEula

public boolean displayEula(String eula)

Description copied from class: AbstractClientContext

Display the end-user license agreement.

Called from AbstractClientContext.start().

Specified by:

displayEula in class AbstractClientContext

Parameters:

eula - EULA text

Returns:

true if the user accepted the EULA

retrieveLicenseKey

public String retrieveLicenseKey(String licdata)

Description copied from class: AbstractClientContext

Retrieve a license key from the user.

Called from AbstractClientContext.start().

Specified by:

retrieveLicenseKey in class AbstractClientContext

Parameters:

licdata - license data blob

Returns:

the license key entered by the user

checkUpdate

public boolean checkUpdate()

Description copied from class: AbstractClientContext

Not called locally: it is entirely up to the client to implement and decide who calls this method.

Specified by:

checkUpdate in class AbstractClientContext

Returns:

true if an update was downloaded and should be applied

onUpdatedSoftware

public void onUpdatedSoftware(String changelist,
 Version oldVersion)

Description copied from class: AbstractClientContext

Notify a concrete client that a new version of JEB is being run for the first time.

Called from AbstractClientContext.start().

Specified by:

onUpdatedSoftware in class AbstractClientContext

Parameters:

changelist - an optional change log

oldVersion - the last version of JEB that was run (note: the current version is always available as a static public field)

notifySupportExpired

public void notifySupportExpired()

Description copied from class: AbstractClientContext

Notify the client that support or subscription benefits expired.

Called from AbstractClientContext.start().

Specified by:

notifySupportExpired in class AbstractClientContext

displayDemoInformation

public void displayDemoInformation(String demoInfo)

Description copied from class: AbstractClientContext

Display information about demo restrictions.

Called from AbstractClientContext.start().

Specified by:

displayDemoInformation in class AbstractClientContext

Parameters:

demoInfo - demo information text

setupController

public boolean setupController()

Description copied from class: AbstractClientContext

Ask the client to configure floating-controller settings if needed.

Called from AbstractClientContext.start().

Specified by:

setupController in class AbstractClientContext

Returns:

true if the controller was configured successfully

notifyFloatingClient

public void notifyFloatingClient(ControllerNotification notification)

Description copied from class: AbstractClientContext

Notify the client of a floating-controller event.

May be called from any thread.

Specified by:

notifyFloatingClient in class AbstractClientContext

Parameters:

notification - controller notification