com.businessobjects.sdk.plugin.desktop.enterprisenode
Interface IEnterpriseNodeBase

All Known Subinterfaces:

IEnterpriseNode

public interface IEnterpriseNodeBase

This interface represents an environment where BusinessObjects Enterprise binary files are installed and running. It includes information about the physical machine and the user account under which BusinessObjects Enterprise is running as well as information about the servers it is running.

Field Summary

static java.lang.String	KIND
static java.lang.String	PROGID
static int	TYPEID The TypeId for Enterprise Node objects.

Method Summary

IConfigProperties	getConfigProps() Returns the configuration properties that will be applied to the servers for this enterprise node.
java.lang.String	getHostName() Returns the host name of the machine that is running the servers associated with this enterprise node.
int	getInstallID() Returns the ID of the install associated with this enterprise node.
int	getPID() Returns the process ID of this enterprise node.
INameValuePairs	getPlaceholders() Returns the placeholder resolutions used in various paths throughout the Server Intelligence model.
java.util.Set	getServers() Returns the IDs of the servers that are associated with this enterprise node To read this value, this object must contain the SI_SERVER4ENTNODE property.
java.lang.String	getTempDir() Returns the temp dir of this enterprise node.
java.lang.String	getUserName() Returns the name of the operating system account under which the servers are running.
boolean	isAlive() Returns whether the Server Intelligence Agent is alive.
void	setInstallID(int installID) Associates this EnterpriseNode with an Install.
void	setTempDir(java.lang.String tempdir) Sets the temp dir of this enterprise node

Field Detail

TYPEID

static final int TYPEID

The TypeId for Enterprise Node objects.

See Also:

Constant Field Values

KIND

static final java.lang.String KIND

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

See Also:

Constant Field Values

Method Detail

getHostName

java.lang.String getHostName()

Returns the host name of the machine that is running the servers associated with this enterprise node.

To read this value, this object must contain the SI_SERVER_NAME property.

Returns:

String containing the host name.

InfoObject properties to query for:

SI_SERVER_NAME

getServers

java.util.Set getServers()
                         throws SDKException

Returns the IDs of the servers that are associated with this enterprise node

To read this value, this object must contain the SI_SERVER4ENTNODE property.

Returns:

A set of server IDs.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SERVER4ENTNODE

getInstallID

int getInstallID()
                 throws SDKException

Returns the ID of the install associated with this enterprise node.

To read this value, this object must contain the SI_ENTNODE_INSTALL property.

Returns:

The ID of the associated install.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_ENTNODE_INSTALL

setInstallID

void setInstallID(int installID)
                  throws SDKException

Associates this EnterpriseNode with an Install.

Parameters:

installID - The install ID.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPlaceholders

INameValuePairs getPlaceholders()

Returns the placeholder resolutions used in various paths throughout the Server Intelligence model.

To read this value, this object must contain the SI_PLACEHOLDERS property.

Returns:

com.businessobjects.sdk.plugin.desktop.common.INameValuePairs containing the mappings of placeholder strings to their actual values.

InfoObject properties to query for:

SI_PLACEHOLDERS

getUserName

java.lang.String getUserName()

Returns the name of the operating system account under which the servers are running.

To read this value, this object must contain the SI_USERNAME property.

Returns:

name of the operating system account running the servers.

InfoObject properties to query for:

SI_USERNAME

isAlive

boolean isAlive()
                throws SDKException

Returns whether the Server Intelligence Agent is alive.

To read this value, this object must contain the SI_SERVER_IS_ALIVE property.

Returns:

true if the server is running, false otherwise.

Throws:

SDKException - if the corresponding property is missing.

InfoObject properties to query for:

SI_SERVER_IS_ALIVE

getPID

int getPID()
           throws SDKException

Returns the process ID of this enterprise node.

To read this value, this object must contain the SI_PID property.

Returns:

The process ID of this enterprise node

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_PID

getTempDir

java.lang.String getTempDir()
                            throws SDKException

Returns the temp dir of this enterprise node.

To read this value, this object must contain the SI_TEMP_DIR property.

Returns:

The temp dir of this enterprise node

Throws:

SDKException - if the process is unsuccessful.

Since:

4.0

InfoObject properties to query for:

SI_TEMP_DIR

setTempDir

void setTempDir(java.lang.String tempdir)

Sets the temp dir of this enterprise node

Parameters:

tempdir - the temp dir of this enterprise node

Throws:

SDKException - This is thrown if the process is unsuccessful.

getConfigProps

IConfigProperties getConfigProps()

Returns the configuration properties that will be applied to the servers for this enterprise node. These configuration properties can be modified.

Note that some changes may not be applied immediately. As such, these values may not reflect the values that are currently being used by the servers.

Returns:

Configuration properties to be used by the server for the enterprise node.