com.basis.api.admin

Interface BBjAdminAppDeploymentApplication

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, java.lang.Comparable<BBjAdminAppDeploymentApplication>, java.rmi.Remote

public interface BBjAdminAppDeploymentApplication
extends BBjAdminCommitPropertyWriter, java.lang.Comparable<BBjAdminAppDeploymentApplication>

Configuration for a BUI and/or desktop app deployment application on the server.

Do not directly create a BBjAdminAppDeploymentApplication instance from one of its implementation classes. Instead, use the com.basis.api.admin.BBjAdminAppDeploymentConfiguration.createApplication() method class to create a new application or the getRemoteConfiguration() method to gain access to the remote app configurations and then get the app instance from there. See the sample code below for details.

Java Sample

import com.basis.api.admin.BBjAdminFactory;
import com.basis.api.admin.BBjAdminBase;
import com.basis.api.admin.BBjAdminDatabase;
import com.basis.api.admin.BBjAdminAppDeploymentApplication;
import com.basis.api.admin.BBjAdminJRE;
import java.net.InetAddress;
...
BBjAdminBase api = BBjAdminFactory.getBBjAdmin(InetAddress.getByName("myserver"), 2002, true, "admin", "admin123");
BBjAdminAppDeploymentConfiguration config = api.getRemoteConfiguration();

// Create a resource entry for a shortcut icon
BBjAdminAppDeploymentResource resource = config.createResource();
resource.setString(BBjAdminAppDeploymentResource.SOURCE_FILE_NAME, "/path/to/image.png");
config.getResources().add(resource);
config.commit();

// Add a JRE to include for the desktop app (required for desktop apps)
api.getWebAppServer().addJRE("/path/to/jre/mac-jre-installer.tgz", BBjAdminJRE.OS_MAC);
api.getWebAppServer().addJRE("/path/to/jre/windows-jre-installer.tgz", BBjAdminJRE.OS_WINDOWS);
api.getWebAppServer().addJRE("/path/to/jre/linux-jre-installer.tgz", BBjAdminJRE.OS_LINUX);

// Create the application
BBjAdminAppDeploymentApplication newApp = config.createApplication();
newApp.setString(BBjAdminAppDeploymentApplication.NAME, "MyApp");
newApp!.setString(BBjAdminAppDeploymentApplication.PROGRAM, "myapp.bbj");
newApp.setString(BBjAdminAppDeploymentApplication.CONFIG_FILE, "/path/to/config.bbx");
newApp.setString(BBjAdminAppDeploymentApplication.WORKING_DIRECTORY, "/path/to/directory");
newApp.setBoolean(BBjAdminAppDeploymentApplication.EXE_ENABLED, true);
newApp.setBoolean(BBjAdminAppDeploymentApplication.BUI_ENABLED, true);

// Set the JVMs that will be available to the apps (optional as it can use the defaults added above)
newApp.setString(BBjAdminAppDeploymentApplication.MAC_JVM, "mac-jre-installer.tgz");
newApp.setString(BBjAdminAppDeploymentApplication.WINDOWS_JVM, "win-jre-installer.tgz");
newApp.setString(BBjAdminAppDeploymentApplication.WINDOWS_32_JVM, "win32-jre-installer.tgz");
newApp.setString(BBjAdminAppDeploymentApplication.LINUX_JVM, "linux-jre-installer.tgz");

// Set the shortcut icon to the resource we created above
newApp.setString(BBjAdminAppDeploymentApplication.SHORTCUT_ICON_RESOURCE_ID, resource.getString(BBjAdminAppDeploymentResource.RESOURCE_ID));
newApp.commit();

BBjAdminList apps = config.getApplications();
for (BBjAdminAppDeploymentApplication app: apps)
{
System.out.println(app.getString(BBjAdminAppDeploymentApplication.NAME));
System.out.println(app.getBuiUrl(false));
System.out.println(app.getExeUrl(BBjAdminAppDeploymentApplication.PLATFORM_MAC, false));
}
...


BBj Sample

use com.basis.api.admin.BBjAdminFactory
use com.basis.api.admin.BBjAdminBase
use com.basis.api.admin.BBjAdminDatabase
use com.basis.api.admin.BBjAdminAppDeploymentApplication
use com.basis.api.admin.BBjAdminAppDeploymentResource
use com.basis.api.admin.BBjAdminJRE
use java.net.InetAddress
...
api! = BBjAdminFactory.getBBjAdmin("admin", "admin123")
config! = api!.getRemoteConfiguration()

REM Create a resource entry for a shortcut icon
resource! = config!.createResource()
resource!.setString(BBjAdminAppDeploymentResource.SOURCE_FILE_NAME, "/path/to/image.png")
config!.getResources().add(resource!)
config!.commit()

REM Add a JRE to include for the desktop app (required for desktop apps)
api!.getWebAppServer().addJRE("/path/to/jre/mac-jre-installer.tgz", BBjAdminJRE.OS_MAC)
api!.getWebAppServer().addJRE("/path/to/jre/windows-jre-installer.tgz", BBjAdminJRE.OS_WINDOWS)
api!.getWebAppServer().addJRE("/path/to/jre/linux-jre-installer.tgz", BBjAdminJRE.OS_LINUX)

REM Create the application
newApp! = config!.createApplication()
newApp!.setString(BBjAdminAppDeploymentApplication.NAME, "MyApp")
newApp!.setString(BBjAdminAppDeploymentApplication.PROGRAM, "myapp.bbj")
newApp!.setString(BBjAdminAppDeploymentApplication.CONFIG_FILE, "/path/to/config.bbx")
newApp!.setString(BBjAdminAppDeploymentApplication.WORKING_DIRECTORY, "/path/to/directory")
newApp!.setBoolean(BBjAdminAppDeploymentApplication.EXE_ENABLED, 1)
newApp!.setBoolean(BBjAdminAppDeploymentApplication.BUI_ENABLED, 1)

REM Set the JVMs that will be available to the apps (optional as it can use the defaults added above)
newApp!.setString(BBjAdminAppDeploymentApplication.MAC_JVM, "mac-jre-installer.tgz")
newApp!.setString(BBjAdminAppDeploymentApplication.WINDOWS_JVM, "win-jre-installer.tgz")
newApp!.setString(BBjAdminAppDeploymentApplication.WINDOWS_32_JVM, "win32-jre-installer.tgz")
newApp!.setString(BBjAdminAppDeploymentApplication.LINUX_JVM, "linux-jre-installer.tgz")

REM Set the shortcut icon to the resource we created above
newApp!.setString(BBjAdminAppDeploymentApplication.SHORTCUT_ICON_RESOURCE_ID, resource!.getString(BBjAdminAppDeploymentResource.RESOURCE_ID))
newApp!.commit()

apps! = config!.getApplications()
for i = 0 to apps!.size() - 1
app! = apps!.get(i)
print app!.getString(BBjAdminAppDeploymentApplication.NAME)
print app!.getBuiUrl(false)
print app!.getExeUrl(BBjAdminAppDeploymentApplication.PLATFORM_MAC, false)
next i
...


Since:

19.20

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_NAME_DASH_A
static java.lang.String	APPLICATION_USER
static java.lang.String	BUI_ENABLED
static java.lang.String	CLASSPATH
static java.lang.String	CLIENT_RESPONSE_TIMEOUT
static java.lang.String	CLIENT_RESPONSE_TIMEOUT_USE_DEFAULT
static java.lang.String	CONFIG_FILE
static java.lang.String	CONTEXT
static java.lang.String	CSS_RESOURCE_ID
static java.lang.String	DEMO
static java.lang.String	DESKTOP_TERMINAL
static java.lang.String	DEVELOPMENT_MODE
static java.lang.String	DEVELOPMENT_MODE_USE_DEFAULT
static java.lang.String	DISALLOW_CONSOLE
static java.lang.String	DISALLOW_CONSOLE_USE_DEFAULT
static java.lang.String	EXE_ENABLED
static java.lang.String	HOST_OVERRIDE
static java.lang.String	INF
static java.lang.String	INTERPRETER_USER
static java.lang.String	LINUX_JVM
static java.lang.String	LOAD_IMAGE_RESOURCE_ID
static java.lang.String	LOCAL_PORT
static java.lang.String	LOOK_AND_FEEL
static java.lang.String	MAC_JVM
static java.lang.String	MANAGE_BROWSER_HISTORY
static java.lang.String	MANAGE_BROWSER_HISTORY_USE_DEFAULT
static java.lang.String	NAME
static java.lang.String	OMIT_BASIS_CSS
static java.lang.String	OMIT_BASIS_CSS_USE_DEFAULT
static java.lang.String	PLATFORM_LINUX
static java.lang.String	PLATFORM_MAC
static java.lang.String	PLATFORM_WIN32
static java.lang.String	PLATFORM_WIN64
static java.lang.String	PROGRAM
static java.lang.String	QUIET
static java.lang.String	REMOTE_HOST
static java.lang.String	REMOTE_HOST_DESKTOP
static java.lang.String	REMOTE_PORT
static java.lang.String	REMOTE_PORT_DESKTOP
static java.lang.String	SECURE
static java.lang.String	SECURE_DESKTOP
static java.lang.String	SECURE_DESKTOP_USE_DEFAULT
static java.lang.String	SECURE_USE_DEFAULT
static java.lang.String	SHORTCUT_DESCRIPTION
static java.lang.String	SHORTCUT_ICON_RESOURCE_ID
static java.lang.String	SHORTCUT_NAME
static java.lang.String	SHOW_BROWSER_WARNING
static java.lang.String	SHOW_BROWSER_WARNING_USE_DEFAULT
static java.lang.String	SHOW_CONFIRM_CLOSE_DIALOG
static java.lang.String	SHOW_CONFIRM_CLOSE_DIALOG_USE_DEFAULT
static java.lang.String	TCPS_HEARTBEAT
static java.lang.String	TCPS_PRELOAD
static java.lang.String	TCPS_TIMEOUT
static java.lang.String	TERMINAL
static java.lang.String	WINDOWS_32_JVM
static java.lang.String	WINDOWS_JVM
static java.lang.String	WORKING_DIRECTORY

Method Summary

Modifier and Type	Method and Description
BBjAdminList<java.lang.String>	getArguments() Returns the list of the program arguments for this application.
java.lang.String	getBuiUrl(boolean ssl) Generates and returns a URL for the application that can be used to run the application from a Web browser.
BBjAdminList<BBjAdminProperty>	getDescriptiveProperties() Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.
java.lang.String	getExeUrl(java.lang.String platform, boolean ssl) Generates and returns a URL for the application that can be used to download an executable launcher for the application to be run from a remote desktop.
BBjAdminList<java.lang.String>	getJavaArguments() Returns the list of the Java command line arguments for this 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.BBjAdminPropertyWriter

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

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.BBjAdminCommitWriter

commit, rollback

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

APPLICATION_USER

static final java.lang.String APPLICATION_USER

See Also:

Constant Field Values

INTERPRETER_USER

static final java.lang.String INTERPRETER_USER

See Also:

Constant Field Values

APPLICATION_NAME_DASH_A

static final java.lang.String APPLICATION_NAME_DASH_A

See Also:

Constant Field Values

CLASSPATH

static final java.lang.String CLASSPATH

See Also:

Constant Field Values

CLIENT_RESPONSE_TIMEOUT

static final java.lang.String CLIENT_RESPONSE_TIMEOUT

See Also:

Constant Field Values

CLIENT_RESPONSE_TIMEOUT_USE_DEFAULT

static final java.lang.String CLIENT_RESPONSE_TIMEOUT_USE_DEFAULT

See Also:

Constant Field Values

CONFIG_FILE

static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

CONTEXT

static final java.lang.String CONTEXT

See Also:

Constant Field Values

CSS_RESOURCE_ID

static final java.lang.String CSS_RESOURCE_ID

See Also:

Constant Field Values

DEVELOPMENT_MODE

static final java.lang.String DEVELOPMENT_MODE

See Also:

Constant Field Values

DEVELOPMENT_MODE_USE_DEFAULT

static final java.lang.String DEVELOPMENT_MODE_USE_DEFAULT

See Also:

Constant Field Values

DISALLOW_CONSOLE

static final java.lang.String DISALLOW_CONSOLE

See Also:

Constant Field Values

DISALLOW_CONSOLE_USE_DEFAULT

static final java.lang.String DISALLOW_CONSOLE_USE_DEFAULT

See Also:

Constant Field Values

LOAD_IMAGE_RESOURCE_ID

static final java.lang.String LOAD_IMAGE_RESOURCE_ID

See Also:

Constant Field Values

MANAGE_BROWSER_HISTORY

static final java.lang.String MANAGE_BROWSER_HISTORY

See Also:

Constant Field Values

MANAGE_BROWSER_HISTORY_USE_DEFAULT

static final java.lang.String MANAGE_BROWSER_HISTORY_USE_DEFAULT

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

OMIT_BASIS_CSS

static final java.lang.String OMIT_BASIS_CSS

See Also:

Constant Field Values

OMIT_BASIS_CSS_USE_DEFAULT

static final java.lang.String OMIT_BASIS_CSS_USE_DEFAULT

See Also:

Constant Field Values

PROGRAM

static final java.lang.String PROGRAM

See Also:

Constant Field Values

QUIET

static final java.lang.String QUIET

See Also:

Constant Field Values

SECURE

static final java.lang.String SECURE

See Also:

Constant Field Values

SECURE_DESKTOP

static final java.lang.String SECURE_DESKTOP

See Also:

Constant Field Values

SECURE_USE_DEFAULT

static final java.lang.String SECURE_USE_DEFAULT

See Also:

Constant Field Values

SECURE_DESKTOP_USE_DEFAULT

static final java.lang.String SECURE_DESKTOP_USE_DEFAULT

See Also:

Constant Field Values

SHORTCUT_DESCRIPTION

static final java.lang.String SHORTCUT_DESCRIPTION

See Also:

Constant Field Values

SHORTCUT_ICON_RESOURCE_ID

static final java.lang.String SHORTCUT_ICON_RESOURCE_ID

See Also:

Constant Field Values

SHORTCUT_NAME

static final java.lang.String SHORTCUT_NAME

See Also:

Constant Field Values

SHOW_BROWSER_WARNING

static final java.lang.String SHOW_BROWSER_WARNING

See Also:

Constant Field Values

SHOW_BROWSER_WARNING_USE_DEFAULT

static final java.lang.String SHOW_BROWSER_WARNING_USE_DEFAULT

See Also:

Constant Field Values

SHOW_CONFIRM_CLOSE_DIALOG

static final java.lang.String SHOW_CONFIRM_CLOSE_DIALOG

See Also:

Constant Field Values

SHOW_CONFIRM_CLOSE_DIALOG_USE_DEFAULT

static final java.lang.String SHOW_CONFIRM_CLOSE_DIALOG_USE_DEFAULT

See Also:

Constant Field Values

TERMINAL

static final java.lang.String TERMINAL

See Also:

Constant Field Values

DESKTOP_TERMINAL

static final java.lang.String DESKTOP_TERMINAL

See Also:

Constant Field Values

WORKING_DIRECTORY

static final java.lang.String WORKING_DIRECTORY

See Also:

Constant Field Values

EXE_ENABLED

static final java.lang.String EXE_ENABLED

See Also:

Constant Field Values

BUI_ENABLED

static final java.lang.String BUI_ENABLED

See Also:

Constant Field Values

REMOTE_HOST

static final java.lang.String REMOTE_HOST

See Also:

Constant Field Values

REMOTE_PORT

static final java.lang.String REMOTE_PORT

See Also:

Constant Field Values

REMOTE_HOST_DESKTOP

static final java.lang.String REMOTE_HOST_DESKTOP

See Also:

Constant Field Values

REMOTE_PORT_DESKTOP

static final java.lang.String REMOTE_PORT_DESKTOP

See Also:

Constant Field Values

LOCAL_PORT

static final java.lang.String LOCAL_PORT

See Also:

Constant Field Values

LOOK_AND_FEEL

static final java.lang.String LOOK_AND_FEEL

See Also:

Constant Field Values

INF

static final java.lang.String INF

See Also:

Constant Field Values

TCPS_PRELOAD

static final java.lang.String TCPS_PRELOAD

See Also:

Constant Field Values

TCPS_TIMEOUT

static final java.lang.String TCPS_TIMEOUT

See Also:

Constant Field Values

TCPS_HEARTBEAT

static final java.lang.String TCPS_HEARTBEAT

See Also:

Constant Field Values

HOST_OVERRIDE

static final java.lang.String HOST_OVERRIDE

See Also:

Constant Field Values

PLATFORM_MAC

static final java.lang.String PLATFORM_MAC

See Also:

Constant Field Values

PLATFORM_WIN32

static final java.lang.String PLATFORM_WIN32

See Also:

Constant Field Values

PLATFORM_WIN64

static final java.lang.String PLATFORM_WIN64

See Also:

Constant Field Values

PLATFORM_LINUX

static final java.lang.String PLATFORM_LINUX

See Also:

Constant Field Values

MAC_JVM

static final java.lang.String MAC_JVM

See Also:

Constant Field Values

WINDOWS_JVM

static final java.lang.String WINDOWS_JVM

See Also:

Constant Field Values

WINDOWS_32_JVM

static final java.lang.String WINDOWS_32_JVM

See Also:

Constant Field Values

LINUX_JVM

static final java.lang.String LINUX_JVM

See Also:

Constant Field Values

DEMO

static final java.lang.String DEMO

See Also:

Constant Field Values

Method Detail

getArguments

BBjAdminList<java.lang.String> getArguments()
                                     throws BBjAdminException

Returns the list of the program arguments for this application.

Returns:

list of the program arguments.

Throws:

BBjAdminException

getJavaArguments

BBjAdminList<java.lang.String> getJavaArguments()
                                         throws BBjAdminException

Returns the list of the Java command line arguments for this application. NOTE: This only applies to EXE applications.

Returns:

list of the Java command line arguments.

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

getBuiUrl

java.lang.String getBuiUrl(boolean ssl)
                    throws BBjAdminException

Generates and returns a URL for the application that can be used to run the application from a Web browser. It uses the name in combination with the host and port information from the Jetty server. This method returns null if the BUI_ENABLED property is set to false.

Returns:

Application URL.

Throws:

BBjAdminException

getExeUrl

java.lang.String getExeUrl(java.lang.String platform,
                           boolean ssl)
                    throws BBjAdminException

Generates and returns a URL for the application that can be used to download an executable launcher for the application to be run from a remote desktop. It uses the name in combination with the host and port information from the Jetty server. This method returns null if the EXE_ENABLED property is set to false.

Parameters:

platform - One of the following platform constants: PLATFORM_MAC, PLATFORM_WIN32, PLATFORM_WIN64, PLATFORM_LINUX

ssl - True for an SSL URL

Returns:

Application URL.

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