Package com.basis.api.admin

Interface BBjAdminServer

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote, Serializable

All Known Subinterfaces:

BBjAdminFilesystemServer

public interface BBjAdminServer
extends BBjAdminPropertyWriter, Serializable

Parent interface for various server configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BBjAdminServer.ServerType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_ALIAS
static final String	ALLOW_RHOSTS
static final String	BIND_ADDRESS
static final String	CONTEXTS
static final String	DEFAULT_CONFIG
static final String	DEFAULT_USER
static final String	DEFAULT_WORKING_DIR
static final String	DISALLOW_CONSOLE
static final String	ENABLE_HTTP
static final String	ENABLE_SSL
static final String	FORCE_DEFAULT_CONFIG
static final String	FORCE_DEFAULT_USER
static final String	FORCE_DEFAULT_WORKING_DIR
static final String	HOST_NAME
static final String	IS_RUNNING
static final String	LOG_LEVEL
static final String	MAX_CLIENTS
static final String	NAME
static final String	PORT
static final String	RUN_SERVER
static final String	SKIP_IDENT_VERIFICATION
static final String	SKIP_RHOST_VERIFICATION
static final String	SSL_CLIENT_TRUST_STORE
static final String	SSL_CLIENT_TRUST_STORE_PASSWORD
static final String	SSL_TRUST_STORE
static final String	SSL_TRUST_STORE_PASSWORD
static final String	USE_DEFAULT_ALIAS
static final String	USE_SSL

Method Summary

Modifier and Type	Method	Description
BBjAdminList<BBjAdminProperty>	getDescriptiveProperties()	Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.
BBjAdminServer.ServerType	getType()	Set the server type.
void	restartServer()	Restart the server.
void	setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps)	Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.
void	startServer()	Start the individual server instance as currently committed.
void	stopServer()	Stop the server.

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

PORT

static final String PORT

See Also:

• Constant Field Values

BIND_ADDRESS

static final String BIND_ADDRESS

See Also:

• Constant Field Values

RUN_SERVER

static final String RUN_SERVER

See Also:

• Constant Field Values

NAME

static final String NAME

See Also:

• Constant Field Values

LOG_LEVEL

static final String LOG_LEVEL

See Also:

• Constant Field Values

MAX_CLIENTS

static final String MAX_CLIENTS

See Also:

• Constant Field Values

USE_SSL

static final String USE_SSL

See Also:

• Constant Field Values

DISALLOW_CONSOLE

static final String DISALLOW_CONSOLE

See Also:

• Constant Field Values

ALLOW_RHOSTS

static final String ALLOW_RHOSTS

See Also:

• Constant Field Values

HOST_NAME

static final String HOST_NAME

See Also:

• Constant Field Values

ALLOW_ALIAS

static final String ALLOW_ALIAS

See Also:

• Constant Field Values

ENABLE_HTTP

static final String ENABLE_HTTP

See Also:

• Constant Field Values

ENABLE_SSL

static final String ENABLE_SSL

See Also:

• Constant Field Values

SSL_TRUST_STORE

static final String SSL_TRUST_STORE

See Also:

• Constant Field Values

SSL_TRUST_STORE_PASSWORD

static final String SSL_TRUST_STORE_PASSWORD

See Also:

• Constant Field Values

SSL_CLIENT_TRUST_STORE

static final String SSL_CLIENT_TRUST_STORE

See Also:

• Constant Field Values

SSL_CLIENT_TRUST_STORE_PASSWORD

static final String SSL_CLIENT_TRUST_STORE_PASSWORD

See Also:

• Constant Field Values

CONTEXTS

static final String CONTEXTS

See Also:

• Constant Field Values

SKIP_IDENT_VERIFICATION

static final String SKIP_IDENT_VERIFICATION

See Also:

• Constant Field Values

SKIP_RHOST_VERIFICATION

static final String SKIP_RHOST_VERIFICATION

See Also:

• Constant Field Values

DEFAULT_USER

static final String DEFAULT_USER

See Also:

• Constant Field Values

FORCE_DEFAULT_USER

static final String FORCE_DEFAULT_USER

See Also:

• Constant Field Values

DEFAULT_CONFIG

static final String DEFAULT_CONFIG

See Also:

• Constant Field Values

FORCE_DEFAULT_CONFIG

static final String FORCE_DEFAULT_CONFIG

See Also:

• Constant Field Values

DEFAULT_WORKING_DIR

static final String DEFAULT_WORKING_DIR

See Also:

• Constant Field Values

FORCE_DEFAULT_WORKING_DIR

static final String FORCE_DEFAULT_WORKING_DIR

See Also:

• Constant Field Values

USE_DEFAULT_ALIAS

static final String USE_DEFAULT_ALIAS

See Also:

• Constant Field Values

IS_RUNNING

static final String IS_RUNNING

See Also:

• Constant Field Values

Method Details

getType

BBjAdminServer.ServerType getType()

Set the server type.

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

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

startServer

void startServer()
          throws BBjAdminException

Start the individual server instance as currently committed. This will error if there are uncommitted configuration changes.

Throws:

BBjAdminException

stopServer

void stopServer()
         throws BBjAdminException

Stop the server.

Throws:

BBjAdminException

restartServer

void restartServer()
            throws BBjAdminException

Restart the server.

Throws:

BBjAdminException