Package com.basis.api.admin

Interface BBjAdminAppDeploymentConfiguration

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote, Serializable

public interface BBjAdminAppDeploymentConfiguration
extends BBjAdminCommitPropertyWriter, Serializable

Configuration for BUI and/or remote-launch application related items on the server.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_RESPONSE_TIMEOUT
static final String	CUSTOM_ERROR_MSG
static final String	DEVELOPMENT_MODE
static final String	DISALLOW_CONSOLE
static final String	DISTRIBUTION_OUTPUT_DIRECTORY
static final String	HOST_OVERRIDE
static final String	LINUX_BASE_INSTALL_DIRECTORY
static final String	MACOS_BASE_INSTALL_DIRECTORY
static final String	MANAGE_BROWSER_HISTORY
static final String	OMIT_BASIS_CSS
static final String	PORT_OVERRIDE
static final String	REMOTE_CACHE_CLEANUP
static final String	SECURE
static final String	SHOW_BROWSER_WARNING
static final String	SHOW_CONFIRM_CLOSE_DIALOG
static final String	USE_REQUEST_SERVER_NAME
static final String	WINDOWS_BASE_INSTALL_DIRECTORY
static final String	WINDOWS_REQUIRE_ADMINISTRATOR

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clear any caches related to app deployments.
BBjAdminAppDeploymentApplication	createApplication()	Create a new application definition.
BBjAdminAppDeploymentResource	createResource()	Create a new resource.
BBjAdminAppDeploymentApplication	duplicateApplication(String p_name, String p_newName, String p_newShortcutName)	Duplicate the specified application and return an instance of the new app configuration.
BBjAdminAppDeploymentApplication	getApplication(String p_name)	Returns the web/desktop app for the specified app.
BBjAdminList<BBjAdminAppDeploymentApplication>	getApplications()	Returns a list of the BUI applications configured.
BBjAdminList<BBjAdminAppDeploymentApplication>	getDemoApplications()	Returns a list of the available demo applications.
BBjAdminList<BBjAdminAppDeploymentDemo>	getDemos()	Deprecated.
BBjAdminList<BBjAdminProperty>	getDescriptiveProperties()	Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.
BBjAdminList<BBjAdminAppDeploymentResource>	getResources()	Returns a list of all the resources available for use by any configured applications.
void	removeApplication(String p_name)	Remove the specified application.
void	setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps)	Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.

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_RESPONSE_TIMEOUT

static final String CLIENT_RESPONSE_TIMEOUT

See Also:

• Constant Field Values

HOST_OVERRIDE

static final String HOST_OVERRIDE

See Also:

• Constant Field Values

PORT_OVERRIDE

static final String PORT_OVERRIDE

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

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

SHOW_BROWSER_WARNING

static final String SHOW_BROWSER_WARNING

See Also:

• Constant Field Values

SHOW_CONFIRM_CLOSE_DIALOG

static final String SHOW_CONFIRM_CLOSE_DIALOG

See Also:

• Constant Field Values

DISTRIBUTION_OUTPUT_DIRECTORY

static final String DISTRIBUTION_OUTPUT_DIRECTORY

See Also:

• Constant Field Values

REMOTE_CACHE_CLEANUP

static final String REMOTE_CACHE_CLEANUP

See Also:

• Constant Field Values

USE_REQUEST_SERVER_NAME

static final String USE_REQUEST_SERVER_NAME

See Also:

• Constant Field Values

CUSTOM_ERROR_MSG

static final String CUSTOM_ERROR_MSG

See Also:

• Constant Field Values

WINDOWS_REQUIRE_ADMINISTRATOR

static final String WINDOWS_REQUIRE_ADMINISTRATOR

See Also:

• Constant Field Values

WINDOWS_BASE_INSTALL_DIRECTORY

static final String WINDOWS_BASE_INSTALL_DIRECTORY

See Also:

• Constant Field Values

MACOS_BASE_INSTALL_DIRECTORY

static final String MACOS_BASE_INSTALL_DIRECTORY

See Also:

• Constant Field Values

LINUX_BASE_INSTALL_DIRECTORY

static final String LINUX_BASE_INSTALL_DIRECTORY

See Also:

• Constant Field Values

Method Details

clearCache

void clearCache()
         throws BBjAdminException

Clear any caches related to app deployments.

Throws:

BBjAdminException

createApplication

BBjAdminAppDeploymentApplication createApplication()
                                            throws BBjAdminException

Create a new application definition.

Returns:

The new application definition.

Throws:

BBjAdminException

createResource

BBjAdminAppDeploymentResource createResource()
                                      throws BBjAdminException

Create a new resource.

Returns:

The new resource.

Throws:

BBjAdminException

getApplication

BBjAdminAppDeploymentApplication getApplication(String p_name)
                                         throws BBjAdminException

Returns the web/desktop app for the specified app. App names are case-sensitive.

Parameters:

p_name - Name of the app to get.

Returns:

The app definition.

Throws:

BBjAdminException

getApplications

BBjAdminList<BBjAdminAppDeploymentApplication> getApplications()
                                                        throws BBjAdminException

Returns a list of the BUI applications configured.

Throws:

BBjAdminException

getDemos

@Deprecated
BBjAdminList<BBjAdminAppDeploymentDemo> getDemos()
                                          throws BBjAdminException

Deprecated.

Returns a list of the available demo applications.

Returns:

List of available demo applications.

Throws:

BBjAdminException

getDemoApplications

BBjAdminList<BBjAdminAppDeploymentApplication> getDemoApplications()
                                                            throws BBjAdminException

Returns a list of the available demo applications. These applications can be modified and saved for use as a sort of "template" but the original cannot be modified since these are part of the internal BBj system.

Throws:

BBjAdminException

getDescriptiveProperties

BBjAdminList<BBjAdminProperty> getDescriptiveProperties()
                                                 throws BBjAdminException

Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI. To get property values for general purposes, you should call the getXXX() methods.

Returns:

BBjAdminList containing BBjAdminProperty objects for each available property.

Throws:

BBjAdminException

getResources

BBjAdminList<BBjAdminAppDeploymentResource> getResources()
                                                  throws BBjAdminException

Returns a list of all the resources available for use by any configured applications.

Returns:

List of available resources.

Throws:

BBjAdminException

removeApplication

void removeApplication(String p_name)
                throws BBjAdminException

Remove the specified application.

Parameters:

p_name - Name of the application to remove. Case-sensitive.

Throws:

BBjAdminException

duplicateApplication

BBjAdminAppDeploymentApplication duplicateApplication(String p_name,
 String p_newName,
 String p_newShortcutName)
                                               throws BBjAdminException

Duplicate the specified application and return an instance of the new app configuration.

Parameters:

p_name - Name of the application to duplicate. Case-sensitive.

p_newName - New name for the duplicated application.

p_newShortcutName - New name for the shortcut or null to leave it alone.

Returns:

Instance of the duplicate of the application configuration.

Throws:

BBjAdminException

setDescriptiveProperties

void setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps)
                       throws BBjAdminException

Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI. To set property values for general purposes, you should call the setXXX() methods.

Throws:

BBjAdminException