Package com.basis.api.admin

Interface BBjAdminWebAppServer

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote, Serializable

All Known Subinterfaces:

BBjAdminWebAppServer_1500, BBjAdminWebAppServer_1700

public interface BBjAdminWebAppServer
extends BBjAdminCommitPropertyWriter, Serializable

This is the interface for configuring the Web App Server.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_POLL_INTERVAL
static final String	DEVELOPMENT_MODE
static final String	DISALLOW_CONSOLE
static final String	END_ACTION
static final String	END_ACTION_APP
static final String	END_ACTION_MSG
static final String	END_ACTION_URL
static final String	ERR_ACTION
static final String	ERR_ACTION_APP
static final String	ERR_ACTION_MSG
static final String	ERR_ACTION_URL
static final String	MANAGE_BROWSER_HISTORY
static final String	OMIT_BASIS_CSS
static final String	SECURE
static final String	SESSION_TIMEOUT
static final String	SHOW_BROWSER_WARNING
static final String	SHOW_CLIENT_CONFIRMATION_DIALOG

Method Summary

Modifier and Type	Method	Description
String	addJRE(String p_pathToJrePackage)	Adds the JVM package located at the full path to the list of available JVMs for download from this server.
void	addJRE(String p_pathToJrePackage, String p_os)	Adds the JVM package located at the full path to the list of available JVMs for download from this server.
BBjAdminResourceUrl	addResource(String p_sourceFileName, String p_mimeType)
BBjAdminWebApplication	createApplication(String p_name)	Create an empty application configuration.
BBjAdminWebApplication	getApplication(String p_name)	Get the configuration for an individual web application.
Set<String>	getAppNames()	Get the names of all publish applications.
Set<BBjAdminJRE>	getJREs(boolean p_ssl)	Returns a list of JREs available to download from the web server.
List<BBjAdminResourceUrl>	getResourceUrls()	Returns the list of currently registered resource URLs.
boolean	isPublished(BBjAdminWebApplication p_app)	Return true if the given application is currently published.
boolean	isRunning()	Is the server running?
void	publish(BBjAdminWebApplication p_app)	Publish the given web application to the server (uncommitted).
void	removeJRE(String p_jrePackageName, String p_os)	Removes the JVM package file making it no longer available for download from this server.
void	removeResource(BBjAdminResourceUrl p_adminUrl)	Remove the resource given by p_adminUrl.
boolean	start()	Start the Web Application Server.
boolean	stop()	Stop the Web Application Server.
BBjAdminWebApplication	unpublish(String p_name)	Unpublish the given web application from the server (uncommitted).
void	updateJRE(BBjAdminJRE p_jvm)

Methods inherited from interface com.basis.api.admin.BBjAdminCommitPropertyWriter

getChangedProperties, getClearedProperties, getOriginalProperties

Methods inherited from interface com.basis.api.admin.BBjAdminCommitWriter

commit, rollback

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Field Details

CLIENT_POLL_INTERVAL

static final String CLIENT_POLL_INTERVAL

See Also:

• Constant Field Values

DEVELOPMENT_MODE

static final String DEVELOPMENT_MODE

See Also:

• Constant Field Values

DISALLOW_CONSOLE

static final String DISALLOW_CONSOLE

See Also:

• Constant Field Values

END_ACTION

static final String END_ACTION

See Also:

• Constant Field Values

END_ACTION_APP

static final String END_ACTION_APP

See Also:

• Constant Field Values

END_ACTION_MSG

static final String END_ACTION_MSG

See Also:

• Constant Field Values

END_ACTION_URL

static final String END_ACTION_URL

See Also:

• Constant Field Values

ERR_ACTION

static final String ERR_ACTION

See Also:

• Constant Field Values

ERR_ACTION_APP

static final String ERR_ACTION_APP

See Also:

• Constant Field Values

ERR_ACTION_MSG

static final String ERR_ACTION_MSG

See Also:

• Constant Field Values

ERR_ACTION_URL

static final String ERR_ACTION_URL

See Also:

• Constant Field Values

MANAGE_BROWSER_HISTORY

static final String MANAGE_BROWSER_HISTORY

See Also:

• Constant Field Values

OMIT_BASIS_CSS

static final String OMIT_BASIS_CSS

See Also:

• Constant Field Values

SECURE

static final String SECURE

See Also:

• Constant Field Values

SESSION_TIMEOUT

static final String SESSION_TIMEOUT

See Also:

• Constant Field Values

SHOW_BROWSER_WARNING

static final String SHOW_BROWSER_WARNING

See Also:

• Constant Field Values

SHOW_CLIENT_CONFIRMATION_DIALOG

static final String SHOW_CLIENT_CONFIRMATION_DIALOG

See Also:

• Constant Field Values

Method Details

addResource

BBjAdminResourceUrl addResource(String p_sourceFileName,
 String p_mimeType)
                         throws BBjAdminException

Parameters:

p_sourceFileName -

p_mimeType -

Returns:

Resource URL.

Throws:

BBjAdminException

createApplication

BBjAdminWebApplication createApplication(String p_name)

Create an empty application configuration.

Parameters:

p_name - TODO

Returns:

A new empty application configuration.

getApplication

BBjAdminWebApplication getApplication(String p_name)
                               throws BBjAdminException

Get the configuration for an individual web application.

Parameters:

p_name - Name of the web application.

Returns:

the configuration for a web application

Throws:

BBjAdminException

getAppNames

Set<String> getAppNames()

Get the names of all publish applications.

Returns:

Set of application names.

getResourceUrls

List<BBjAdminResourceUrl> getResourceUrls()
                                   throws BBjAdminException

Returns the list of currently registered resource URLs.

Returns:

a list containing all the resource URLs that have been registered in this WebAppServer.

Throws:

BBjAdminException

isPublished

boolean isPublished(BBjAdminWebApplication p_app)
             throws BBjAdminException

Return true if the given application is currently published.

Parameters:

p_app -

Returns:

boolean indicating whether this application is published.

Throws:

BBjAdminException

isRunning

boolean isRunning()

Is the server running?

Returns:

a boolean indicating whether the server is running.

publish

void publish(BBjAdminWebApplication p_app)
      throws BBjAdminException

Publish the given web application to the server (uncommitted).

Parameters:

p_app -

Throws:

BBjAdminException

removeResource

void removeResource(BBjAdminResourceUrl p_adminUrl)
             throws BBjAdminException

Remove the resource given by p_adminUrl.

Parameters:

p_adminUrl - The resource to remove from the list of published resources.

Throws:

BBjAdminException - If removing the resource failed.

start

boolean start()
       throws BBjAdminException

Start the Web Application Server.

Returns:

true if it was started. false if it was already running.

Throws:

BBjAdminException

stop

boolean stop()
      throws BBjAdminException

Stop the Web Application Server. No applications will be served.

Returns:

true if it was running. false if it was already stopped.

Throws:

BBjAdminException

unpublish

BBjAdminWebApplication unpublish(String p_name)
                          throws BBjAdminException

Unpublish the given web application from the server (uncommitted).

Parameters:

p_name -

Returns:

TODO

Throws:

BBjAdminException

getJREs

Set<BBjAdminJRE> getJREs(boolean p_ssl)
                  throws BBjAdminException

Returns a list of JREs available to download from the web server.

Returns:

List of JREs.

Throws:

BBjAdminException

addJRE

void addJRE(String p_pathToJrePackage,
 String p_os)
     throws BBjAdminException

Adds the JVM package located at the full path to the list of available JVMs for download from this server. The file will be copied into the appropriate location to make it available.

Parameters:

p_pathToJrePackage -

One - of the following: BBjAdminJRE.OS_MAC, BBjAdminJRE.OS_MAC_AARCH64, BBjAdminJRE.OS_WINDOWS, BBjAdminJRE.OS_WINDOWS_32, or BBjAdminJRE.OS_LINUX values.

Throws:

BBjAdminException

addJRE

String addJRE(String p_pathToJrePackage)
       throws BBjAdminException

Adds the JVM package located at the full path to the list of available JVMs for download from this server. The file will be copied into the appropriate location to make it available.

Parameters:

p_pathToJrePackage -

Returns:

One of the following: BBjAdminJRE.OS_MAC, BBjAdminJRE.OS_MAC_AARCH64, BBjAdminJRE.OS_WINDOWS, BBjAdminJRE.OS_WINDOWS_32, or BBjAdminJRE.OS_LINUX values.

Throws:

BBjAdminException

removeJRE

void removeJRE(String p_jrePackageName,
 String p_os)
        throws BBjAdminException

Removes the JVM package file making it no longer available for download from this server.

Parameters:

p_jrePackageName -

p_os - One of the BBjAdminJRE.OS_MAC, BBjAdminJRE.OS_WINDOWS, or BBjAdminJRE.OS_LINUX values.

Throws:

BBjAdminException

BBjAdminException

updateJRE

void updateJRE(BBjAdminJRE p_jvm)
        throws BBjAdminException

Throws:

BBjAdminException