Skip navigation links


com.essbase.api.domain
Interface IEssDomain

All Superinterfaces:
IEssBaseObject, IEssExtendedObject, IEssProperties

public interface IEssDomain
extends IEssExtendedObject, IEssProperties

The IEssDomain is the Essbase domain. It allows to create/delete/enumerate/ get domain objects such as user, group, domain, server.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

Nested Class Summary
static class IEssDomain.EEssDomainObjectType
          The EEssDomainObjectType is an enumeration of domain object types.

 

Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties
IEssProperties.EEssPropertyMode

 

Field Summary
static int PROP_COUNT_DOMAINS
           
static int PROP_COUNT_ENTERPRISE_SERVERS
           
static int PROP_COUNT_GROUPS
           
static int PROP_COUNT_OLAP_SERVERS
           
static int PROP_COUNT_USERS
           
static int PROP_DESCRIPTION
           
static int PROP_HIERARCHICAL_NAME
           
static int PROP_IS_ROOT_DOMAIN
           
static int PROP_NAME
           
static int s_countProperties
           
static IEssValueAny.EEssDataType[] s_propDataTypes
           
static IEssProperties.EEssPropertyMode[] s_propModes
           
static java.lang.String[] s_propNames
           

 

Method Summary
 void copyCube(java.lang.String srcOlapSvrName, java.lang.String srcOlapAppName, java.lang.String srcCubeName, java.lang.String destOlapSvrName, java.lang.String destOlapAppName, java.lang.String destCubeName)
          Copies cube from one server to another.
 void copyOlapApplication(java.lang.String srcOlapSvrName, java.lang.String srcOlapAppName, java.lang.String destOlapSvrName, java.lang.String destOlapAppName)
          Copies olap application from one server to another.
 com.essbase.api.domain.IEssApplication createApplication(java.lang.String appName)
          Creates a distributed application in the domain.
 IEssBaseObject createChildObject(java.lang.String objName, IEssDomain.EEssDomainObjectType objType)
          Deprecated. This functionality has been deprecated.
 IEssCluster createCluster(java.lang.String clusterName)
          Creates a cluster in the domain.
 IEssConnectionPool createConnectionPool(java.lang.String connPoolName)
          Deprecated. This functionality has been deprecated.
 IEssDomain createDomain(java.lang.String domainName)
          Deprecated. This functionality has been deprecated.
 IEssEnterpriseServer createEnterpriseServer(java.lang.String svrName)
          Deprecated. EDS/AHAS server does not exist from version 930.
 IEssGroup createGroup(java.lang.String groupName)
          Deprecated. This functionality has been deprecated.
 IEssOlapServer createOlapServer(java.lang.String svrName)
          Creates/Registers a olap server in the domain.
 com.essbase.api.domain.IEssRole createRole(java.lang.String roleName)
          Deprecated. This functionality has been deprecated.
 IEssUser createUser(java.lang.String userName)
          Deprecated. This functionality has been deprecated.
 IEssUser createUser(java.lang.String userName, java.lang.String password)
          Deprecated. This functionality has been deprecated.
 void delete()
          Deletes this domain.
 void deleteApplication(java.lang.String appName)
          Deletes a distributed application in the domain.
 void deleteChildObject(java.lang.String objName, IEssDomain.EEssDomainObjectType objType)
          Deprecated. This functionality has been deprecated.
 void deleteCluster(java.lang.String clusterName)
          Deletes a cluster in the domain.
 void deleteConnectionPool(java.lang.String connPoolName)
          Deprecated. This functionality has been deprecated.
 void deleteDomain(java.lang.String domainName)
          Deprecated. This functionality has been deprecated.
 void deleteEnterpriseServer(java.lang.String svrName)
          Deprecated. EDS/AHAS server does not exist from version 930
 void deleteGroup(java.lang.String groupName)
          Deprecated. This functionality has been deprecated.
 void deleteOlapServer(java.lang.String svrName)
          Deletes/Unregisters a olap server in the domain.
 void deleteRole(java.lang.String roleName)
          Deprecated. This functionality has been deprecated.
 void deleteUser(java.lang.String userName)
          Deprecated. This functionality has been deprecated.
 void disableComponent(java.lang.String componentName)
          Disable one component.
 void enableComponent(java.lang.String componentName)
          Enable a disabled component.
 com.essbase.api.domain.IEssApplication getApplication(java.lang.String appName)
          Gets the specified application in the domain.
 IEssIterator getApplications()
          Gets the list of distributed applications in the domain.
 IEssBaseObject getChildObject(java.lang.String objName, IEssDomain.EEssDomainObjectType objType)
          Deprecated. This functionality has been deprecated.
 IEssIterator getChildObjects(IEssDomain.EEssDomainObjectType objType)
          Deprecated. This functionality has been deprecated.
 IEssCluster getCluster(java.lang.String clusterName)
          Gets the specified cluster in the domain.
 IEssIterator getClusters()
          Gets the list of clusters in the domain.
 IEssConnectionPool getConnectionPool(java.lang.String connPoolName)
          Deprecated. This functionality has been deprecated.
 IEssIterator getConnectionPools()
          Deprecated. This functionality has been deprecated.
 int getCountApplications()
          Gets the count of distributed applications in the domain.
 int getCountChildObjects(IEssDomain.EEssDomainObjectType objType)
          Gets the count of objects of the specified type in the domain.
 int getCountClusters()
          Gets the count of clusters in the domain.
 int getCountConnectionPools()
          Deprecated. This functionality has been deprecated.
 int getCountDomains()
          Deprecated. This functionality has been deprecated.
 int getCountEnterpriseServers()
          Deprecated. EDS/AHAS server does not exist from version 930
 int getCountGroups()
          Deprecated. This functionality has been deprecated.
 int getCountOlapServers()
          Gets the count of olap servers in the domain.
 int getCountRoles()
          Deprecated. This functionality has been deprecated.
 int getCountUsers()
          Deprecated. This functionality has been deprecated.
 java.lang.String getDescription()
          Gets the domain description.
 IEssDomain getDomain(java.lang.String domainName)
          Deprecated. This functionality has been deprecated.
 IEssIterator getDomains()
          Deprecated. This functionality has been deprecated.
 IEssEnterpriseServer getEnterpriseServer(java.lang.String svrName)
          Deprecated. EDS/AHAS server does not exist from version 930
 IEssIterator getEnterpriseServers()
          Deprecated. EDS/AHAS server does not exist from version 930
 java.lang.String[][] getExternalUsers(java.lang.String firstName, java.lang.String lastName, java.lang.String userName, java.lang.String emailAddress)
          Deprecated. This functionality has been deprecated.
 IEssGroup getGroup(java.lang.String groupName)
          Deprecated. This functionality has been deprecated.
 IEssIterator getGroups()
          Deprecated. This functionality has been deprecated.
 java.lang.String getHierarchicalName()
          Deprecated. This functionality has been deprecated.
 java.lang.String getName()
          Gets the domain name.
 IEssOlapServer getOlapServer(java.lang.String svrName)
          Creates and returns an IEssOlapServer type object.
 IEssIterator getOlapServers()
          Gets the list of olap servers in the domain.
 com.essbase.api.domain.IEssRole getRole(java.lang.String roleName)
          Deprecated. This functionality has been deprecated.
 IEssIterator getRoles()
          Deprecated. This functionality has been deprecated.
 IEssUser getUser(java.lang.String userName)
          Deprecated. This functionality has been deprecated.
 IEssIterator getUsers()
          Deprecated. This functionality has been deprecated.
 boolean isRootDomain()
          Checks if this domain is the root domain of the domain forest.
 IEssCubeView openCubeView(java.lang.String cubeViewName, java.lang.String connPoolName, boolean connPerOp)
          Deprecated. Since 9.3.0.0, Connection Pooling functionality not supported.
 IEssCubeView openCubeView(java.lang.String cubeViewName, java.lang.String olapSvrName, java.lang.String appName, java.lang.String cubeName)
          Opens a view of the Cube.
 IEssCubeView openCubeView(java.lang.String cubeViewName, java.lang.String olapSvrName, java.lang.String appName, java.lang.String cubeName, boolean useConnPool, boolean connPerOp, boolean useCluster, boolean readOnly)
          Deprecated. As of 9.3.0.0, replaced by openCubeView(String, String, String, String)
 IEssMaxlSession openMaxlSession(java.lang.String maxlSessionName, java.lang.String olapSvrName)
          Deprecated. Replaced by IEssOlapServer.openMaxlSession(String)
 void refreshPropertyValues()
          Refreshes the property values.
 void setDescription(java.lang.String desc)
          Sets the domain description.
 void syncCubeReplicas(java.lang.String mainCubeName, java.lang.String[] replicaCubeNames)
          Synchronizes the essbase cubes by copying the data from the main cube to the replica cubes.
 java.lang.Object[] syncSecurityStores(boolean essSecFileToEesStore, java.lang.String domName, java.lang.String olapSvrName)
          Deprecated. This functionality has been deprecated.
 java.lang.Object[] syncSecurityStores(boolean essSecFileToEesStore, java.lang.String domName, java.lang.String olapSvrName, java.lang.String olapAdminName, java.lang.String olapAdminPwd)
          Deprecated. This functionality has been deprecated.
 void updatePropertyValues()
          Updates the property values.

 

Methods inherited from interface com.essbase.api.base.IEssExtendedObject
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled

 

Methods inherited from interface com.essbase.api.base.IEssProperties
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny

 

Field Detail

PROP_NAME

static final int PROP_NAME
See Also:
Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION
See Also:
Constant Field Values

PROP_HIERARCHICAL_NAME

static final int PROP_HIERARCHICAL_NAME
See Also:
Constant Field Values

PROP_IS_ROOT_DOMAIN

static final int PROP_IS_ROOT_DOMAIN
See Also:
Constant Field Values

PROP_COUNT_USERS

static final int PROP_COUNT_USERS
See Also:
Constant Field Values

PROP_COUNT_GROUPS

static final int PROP_COUNT_GROUPS
See Also:
Constant Field Values

PROP_COUNT_OLAP_SERVERS

static final int PROP_COUNT_OLAP_SERVERS
See Also:
Constant Field Values

PROP_COUNT_ENTERPRISE_SERVERS

static final int PROP_COUNT_ENTERPRISE_SERVERS
See Also:
Constant Field Values

PROP_COUNT_DOMAINS

static final int PROP_COUNT_DOMAINS
See Also:
Constant Field Values

s_countProperties

static final int s_countProperties
See Also:
Constant Field Values

s_propNames

static final java.lang.String[] s_propNames

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Gets the domain name.
Specified by:
getName in interface IEssExtendedObject
Returns:
The domain name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getHierarchicalName

java.lang.String getHierarchicalName()
                                     throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the fully qualified domain name.
Returns:
The fully qualified domain name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                                throws com.essbase.api.base.EssException
Gets the domain description. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only]
Returns:
The domain description.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDescription

void setDescription(java.lang.String desc)
                    throws com.essbase.api.base.EssException
Sets the domain description. The change will become effective after you invoke updatePropertyValues(). [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only]
Parameters:
desc - The domain description.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isRootDomain

boolean isRootDomain()
                     throws com.essbase.api.base.EssException
Checks if this domain is the root domain of the domain forest.
Returns:
true if this is the root domain.
Throws:
com.essbase.api.base.EssException - is an error occurs.

refreshPropertyValues

void refreshPropertyValues()
                           throws com.essbase.api.base.EssException
Refreshes the property values. The JAPI cache for this object is refreshed with the latest values from the server, so that all the getXXX() methods will return the latest values.
Specified by:
refreshPropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

updatePropertyValues

void updatePropertyValues()
                          throws com.essbase.api.base.EssException
Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues(). [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, there is no real Domain store and this method acts as dummy invokation.]
Specified by:
updatePropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

createUser

IEssUser createUser(java.lang.String userName)
                    throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Creates an user in the domain with the default password ("password").
Parameters:
userName - The user name (in lower case).
Returns:
The name of the user to create.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createUser

IEssUser createUser(java.lang.String userName,
                    java.lang.String password)
                    throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Creates an user in the domain.
Parameters:
userName - The user name (in lower case).
password - The password.
Returns:
The name of the user to create.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteUser

void deleteUser(java.lang.String userName)
                throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Deletes an user in the domain.
Parameters:
userName - The name of the user to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountUsers

int getCountUsers()
                  throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the count of users in the domain.
Returns:
The count of users in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUser

IEssUser getUser(java.lang.String userName)
                 throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the specified user in the domain.
Parameters:
userName - The user name.
Returns:
The user.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUsers

IEssIterator getUsers()
                      throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the list of users in the domain.
Returns:
The users (each of type IEssUser).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getExternalUsers

java.lang.String[][] getExternalUsers(java.lang.String firstName,
                                      java.lang.String lastName,
                                      java.lang.String userName,
                                      java.lang.String emailAddress)
                                      throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the list of users from external directories filtered by identity, firstName, lastName, userName, emailAddress.
Parameters:
firstName - The first name to filter on.
lastName - The last name to filter on.
emailAddress - The e-mail address to filter on.
Returns:
The users as two dimensional array where each row represents user and each column represents user properties. e.g: [0][0] - login name, [0][1] - first name, [0][2] - last name, [0][3] - identity, [0][4] - email address.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createGroup

IEssGroup createGroup(java.lang.String groupName)
                      throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Creates a group in the domain.
Parameters:
groupName - The group name (in lower case).
Returns:
The group.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteGroup

void deleteGroup(java.lang.String groupName)
                 throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Deletes a group in the domain.
Parameters:
groupName - The name of the group to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountGroups

int getCountGroups()
                   throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the count of groups in the domain.
Returns:
The count of groups in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getGroup

IEssGroup getGroup(java.lang.String groupName)
                   throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the specified group in the domain.
Parameters:
groupName - The group name.
Returns:
The group.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getGroups

IEssIterator getGroups()
                       throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the list of groups in the domain.
Returns:
The groups (each of type IEssGroup).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createRole

com.essbase.api.domain.IEssRole createRole(java.lang.String roleName)
                                           throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Creates a role in the domain. (FOR FUTURE USE)
Parameters:
roleName - The role name (in lower case).
Returns:
The role.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteRole

void deleteRole(java.lang.String roleName)
                throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Deletes a role in the domain. (FOR FUTURE USE)
Parameters:
roleName - The name of the role to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountRoles

int getCountRoles()
                  throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the count of roles in the domain. (FOR FUTURE USE)
Returns:
The count of roles in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRole

com.essbase.api.domain.IEssRole getRole(java.lang.String roleName)
                                        throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the specified role in the domain. (FOR FUTURE USE)
Parameters:
roleName - The role name.
Returns:
The role.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRoles

IEssIterator getRoles()
                      throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the list of roles in the domain. (FOR FUTURE USE)
Returns:
The roles (each of type IEssRole).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createApplication

com.essbase.api.domain.IEssApplication createApplication(java.lang.String appName)
                                                         throws com.essbase.api.base.EssException
Creates a distributed application in the domain. (FOR FUTURE USE) [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, its a dummy method.]
Parameters:
appName - The application name (in lower case).
Returns:
The service.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteApplication

void deleteApplication(java.lang.String appName)
                       throws com.essbase.api.base.EssException
Deletes a distributed application in the domain. (FOR FUTURE USE) [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, its a dummy method.]
Parameters:
appName - The name of the application to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountApplications

int getCountApplications()
                         throws com.essbase.api.base.EssException
Gets the count of distributed applications in the domain. (FOR FUTURE USE) [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, returns 0]
Returns:
The count of distributed applications in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getApplication

com.essbase.api.domain.IEssApplication getApplication(java.lang.String appName)
                                                      throws com.essbase.api.base.EssException
Gets the specified application in the domain. (FOR FUTURE USE) [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only.]
Parameters:
appName - The application name.
Returns:
The application.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getApplications

IEssIterator getApplications()
                             throws com.essbase.api.base.EssException
Gets the list of distributed applications in the domain. (FOR FUTURE USE) [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, returns empty iterator]
Returns:
The applications (each of type IEssApplication).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createOlapServer

IEssOlapServer createOlapServer(java.lang.String svrName)
                                throws com.essbase.api.base.EssException
Creates/Registers a olap server in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, doesn't add the Olap Server as there is no real Domain Database]
Parameters:
svrName - The server name or address (in lower case).
Returns:
The olap server
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteOlapServer

void deleteOlapServer(java.lang.String svrName)
                      throws com.essbase.api.base.EssException
Deletes/Unregisters a olap server in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, doesn't delete the Olap Server as there is no real Domain Database]
Parameters:
svrName - The name/address of the olap server to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountOlapServers

int getCountOlapServers()
                        throws com.essbase.api.base.EssException
Gets the count of olap servers in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, returns 0 as there is no real Domain Database]
Returns:
The count of olap servers in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getOlapServer

IEssOlapServer getOlapServer(java.lang.String svrName)
                             throws com.essbase.api.base.EssException
Creates and returns an IEssOlapServer type object. This call does not connect to an Olap server and hence should be followed by IEssOlapServer.connect().
Parameters:
svrName - The olap server name.
Returns:
The olap server.
Throws:
com.essbase.api.base.EssException - if an error occurs.
See Also:
IEssOlapServer.connect()

getOlapServers

IEssIterator getOlapServers()
                            throws com.essbase.api.base.EssException
Gets the list of olap servers in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, returns empty as there is no real Domain Database]
Returns:
The servers (each of type IEssOlapServer).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createEnterpriseServer

IEssEnterpriseServer createEnterpriseServer(java.lang.String svrName)
                                            throws com.essbase.api.base.EssException
Deprecated. EDS/AHAS server does not exist from version 930.
Creates/Registers an enterprise server in the domain.
Parameters:
svrName - The server name or address (in lower case).
Returns:
The enterprise server.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteEnterpriseServer

void deleteEnterpriseServer(java.lang.String svrName)
                            throws com.essbase.api.base.EssException
Deprecated. EDS/AHAS server does not exist from version 930
Deletes/Unregisters a enterprise server in the domain.
Parameters:
svrName - The name/address of the enterprise server to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountEnterpriseServers

int getCountEnterpriseServers()
                              throws com.essbase.api.base.EssException
Deprecated. EDS/AHAS server does not exist from version 930
Gets the count of enterprise servers in the domain.
Returns:
The count of enterprise servers in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getEnterpriseServer

IEssEnterpriseServer getEnterpriseServer(java.lang.String svrName)
                                         throws com.essbase.api.base.EssException
Deprecated. EDS/AHAS server does not exist from version 930
Gets the specified enterprise server in the domain.
Parameters:
svrName - The enterprise server name.
Returns:
The Enterprise server.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getEnterpriseServers

IEssIterator getEnterpriseServers()
                                  throws com.essbase.api.base.EssException
Deprecated. EDS/AHAS server does not exist from version 930
Gets the list of enterprise servers in the domain.
Returns:
The servers (each of type IEssEnterpriseServer).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createDomain

IEssDomain createDomain(java.lang.String domainName)
                        throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Creates a domain in the domain.
Parameters:
domainName - The name of the domain to create (in lower case).
Returns:
The domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteDomain

void deleteDomain(java.lang.String domainName)
                  throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Deletes a domain in the domain.
Parameters:
domainName - The name of the domain to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountDomains

int getCountDomains()
                    throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the count of domains in the domain.
Returns:
The count of domains in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDomain

IEssDomain getDomain(java.lang.String domainName)
                     throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the specified domain in the domain.
Parameters:
domainName - The domain name.
Returns:
The domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDomains

IEssIterator getDomains()
                        throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the list of domains in the domain.
Returns:
The domains (each of type IEssDomain).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createCluster

IEssCluster createCluster(java.lang.String clusterName)
                          throws com.essbase.api.base.EssException
Creates a cluster in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, returns empty as there is no real Domain Database]
Parameters:
clusterName - The name of the cluster to create (in lower case).
Returns:
The Cluster.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteCluster

void deleteCluster(java.lang.String clusterName)
                   throws com.essbase.api.base.EssException
Deletes a cluster in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, doesn't delete the cluster as there is no real Domain Database]
Parameters:
clusterName - The name of the cluster to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountClusters

int getCountClusters()
                     throws com.essbase.api.base.EssException
Gets the count of clusters in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, returns 0 as there is no real Domain Database]
Returns:
The count of clusters in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCluster

IEssCluster getCluster(java.lang.String clusterName)
                       throws com.essbase.api.base.EssException
Gets the specified cluster in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, returns no cluster as there is no real Domain Database]
Parameters:
clusterName - The cluster name (in lower case).
Returns:
The cluster.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getClusters

IEssIterator getClusters()
                         throws com.essbase.api.base.EssException
Gets the list of clusters in the domain. [This is deprecated in Embedded Java API Mode since 11.1.2.0.00 and available in Provider Services mode only. In Embedded mode, returns empty as there is no real Domain Database]
Returns:
The clusters (each of type IEssCluster).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createConnectionPool

IEssConnectionPool createConnectionPool(java.lang.String connPoolName)
                                        throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Creates a connection pool in the domain.
Parameters:
connPoolName - The name of the connection pool to create (in lower case).
Returns:
The connection pool.
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteConnectionPool

void deleteConnectionPool(java.lang.String connPoolName)
                          throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Deletes a connection pool in the domain.
Parameters:
connPoolName - The name of the connection pool to delete.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountConnectionPools

int getCountConnectionPools()
                            throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the count of connection pools in the domain.
Returns:
The count of connection pools in the domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getConnectionPool

IEssConnectionPool getConnectionPool(java.lang.String connPoolName)
                                     throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the specified connection pool in the domain.
Parameters:
connPoolName - The connection pool name.
Returns:
The connection pool.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getConnectionPools

IEssIterator getConnectionPools()
                                throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the list of connection pools in the domain.
Returns:
The connection pools (each of type IEssConnectionPool).
Throws:
com.essbase.api.base.EssException - if an error occurs.

createChildObject

IEssBaseObject createChildObject(java.lang.String objName,
                                 IEssDomain.EEssDomainObjectType objType)
                                 throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Creates an object in the domain.
Parameters:
objName - The object name (in lower case).
objType - The object type.
Returns:
The child object (One of IEssDomain, IEssUser, IEssGroup, IEssEnterpriseServer, IEssOlapServer, IEssApplication based on the objType).
Throws:
com.essbase.api.base.EssException - if an error occurs.

deleteChildObject

void deleteChildObject(java.lang.String objName,
                       IEssDomain.EEssDomainObjectType objType)
                       throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Deletes an object in the domain.
Parameters:
objName - The object name.
objType - The object type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCountChildObjects

int getCountChildObjects(IEssDomain.EEssDomainObjectType objType)
                         throws com.essbase.api.base.EssException
Gets the count of objects of the specified type in the domain.
Parameters:
objType - The object type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getChildObject

IEssBaseObject getChildObject(java.lang.String objName,
                              IEssDomain.EEssDomainObjectType objType)
                              throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the specified object in the domain.
Parameters:
objName - The object name.
objType - The object type.
Returns:
The child object (One of IEssDomain, IEssUser, IEssGroup, IEssEnterpriseServer, IEssOlapServer, IEssAppService based on the objType).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getChildObjects

IEssIterator getChildObjects(IEssDomain.EEssDomainObjectType objType)
                             throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the list of objects of the specified type in the domain.
Parameters:
objType - The object type.
Returns:
The child objects (One of IEssDomain, IEssUser, IEssGroup, IEssEnterpriseServer, IEssOlapServer, IEssAppService based on the objType).
Throws:
com.essbase.api.base.EssException - if an error occurs.

syncSecurityStores

java.lang.Object[] syncSecurityStores(boolean essSecFileToEesStore,
                                      java.lang.String domName,
                                      java.lang.String olapSvrName)
                                      throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Synchronizes the olap security file and the enterprise security store, there by ensuring that enterprise server is compatible to run with any version of essbase olap server. If you are not sure whether user with the same name/password exists in the olap server, as that of currently signed on user, use the other syncSecurityStores() method, explicitly passing the olap server user name/password.
Parameters:
essSecFileToEesStore - true, to sync ees store from security file. false to sync security file from ees store.
domName - The domain name in enterprise store.
olapSvrName - The olap server name that holds the security file.
Returns:
An array of 3 objects (each of type String[]). First object - list of user names who got added, Second object - list of user names whose password got changed, Third object - list of user names whose admin/supervisor status has changed.
Throws:
com.essbase.api.base.EssException - if an error occurs.

syncSecurityStores

java.lang.Object[] syncSecurityStores(boolean essSecFileToEesStore,
                                      java.lang.String domName,
                                      java.lang.String olapSvrName,
                                      java.lang.String olapAdminName,
                                      java.lang.String olapAdminPwd)
                                      throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Synchronizes the olap security file and the enterprise security store, there by ensuring that enterprise server is compatible to run with any version of essbase olap server.
Parameters:
essSecFileToEesStore - true, to sync ees store from security file. false to sync security file from ees store.
domName - The domain name in enterprise store.
olapSvrName - The olap server name that holds the security file.
olapAdminName - The supervisor name of the olap server.
olapAdminPwd - The password for the above supervisor.
Returns:
An array of 3 objects (each of type String[]). First object - list of user names who got added, Second object - list of user names whose password got changed, Third object - list of user names whose admin/supervisor status has changed.
Throws:
com.essbase.api.base.EssException - if an error occurs.

syncCubeReplicas

void syncCubeReplicas(java.lang.String mainCubeName,
                      java.lang.String[] replicaCubeNames)
                      throws com.essbase.api.base.EssException
Synchronizes the essbase cubes by copying the data from the main cube to the replica cubes.
Parameters:
mainCubeName - The main cube name in the format olapSvrName/appName/cubeName (eg: localhost/sample/basic).
replicaCubeNames - The replica cube names. Each cube name should be of the format olapSvrName/appName/cubeName.
Throws:
com.essbase.api.base.EssException - if an error occurs.

copyOlapApplication

void copyOlapApplication(java.lang.String srcOlapSvrName,
                         java.lang.String srcOlapAppName,
                         java.lang.String destOlapSvrName,
                         java.lang.String destOlapAppName)
                         throws com.essbase.api.base.EssException
Copies olap application from one server to another.
Parameters:
srcOlapSvrName - The source olap server name/ip-address.
srcOlapAppName - The source olap application name.
destOlapSvrName - The destination olap server name/ip-address.
destOlapAppName - The destination olap application name.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Note:
This function should no longer be used to copy applications across servers. That functionality has been deprecated. It can still be used to copy applications in the same server by passing same values for both srcOlapSvrName and destOlapSvrName parameters.

copyCube

void copyCube(java.lang.String srcOlapSvrName,
              java.lang.String srcOlapAppName,
              java.lang.String srcCubeName,
              java.lang.String destOlapSvrName,
              java.lang.String destOlapAppName,
              java.lang.String destCubeName)
              throws com.essbase.api.base.EssException
Copies cube from one server to another.
Parameters:
srcOlapSvrName - The source olap server name/ip-address.
srcOlapAppName - The source olap application name.
srcCubeName - The source cube name.
destOlapSvrName - The destination olap server name/ip-address.
destOlapAppName - The destination olap application name.
destCubeName - The destination cube name.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Note:
This function should no longer be used to copy cubes across servers. That functionality has been deprecated. It can still be used to copy cubes in the same server by passing same values for both srcOlapSvrName and destOlapSvrName parameters.

openMaxlSession

IEssMaxlSession openMaxlSession(java.lang.String maxlSessionName,
                                java.lang.String olapSvrName)
                                throws com.essbase.api.base.EssException
Deprecated. Replaced by IEssOlapServer.openMaxlSession(String)
Opens a maxl session against an olap server.
Parameters:
maxlSessionName - The maxl session name.
olapSvrName - The name of the olap server where the cube resides.
Returns:
The maxl session.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openCubeView

IEssCubeView openCubeView(java.lang.String cubeViewName,
                          java.lang.String olapSvrName,
                          java.lang.String appName,
                          java.lang.String cubeName)
                          throws com.essbase.api.base.EssException
Opens a view of the Cube. JAPI opens and shares a single connection with Essbase between all its interfaces for each JAPI session. JAPI uses counters to track the number of interfaces using the connection based on the IEssCube.openCubeView/IEssDomain.openCubeView/IEssCube.openMemberSelection() calls and hence the number of IEssCubeView.close() calls should match the number of openCubeView() calls for a proper closure of the connection.
Parameters:
cubeViewName - The cube view name.
olapSvrName - The name of the olap server where the cube resides.
appName - The olap application name.
cubeName - The cube name.
Returns:
The cube view.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openCubeView

IEssCubeView openCubeView(java.lang.String cubeViewName,
                          java.lang.String olapSvrName,
                          java.lang.String appName,
                          java.lang.String cubeName,
                          boolean useConnPool,
                          boolean connPerOp,
                          boolean useCluster,
                          boolean readOnly)
                          throws com.essbase.api.base.EssException
Deprecated. As of 9.3.0.0, replaced by openCubeView(String, String, String, String)
Opens a cube view.
Parameters:
cubeViewName - The cube view name.
olapSvrName - The name of the olap server where the cube resides.
appName - The olap application name.
cubeName - The cube name.
useConnPool - true to use connection pool if available.
connPerOp - true for connection per operation. false for connection per session.
useCluster - true to use cluster if available.
readOnly - true if to open in read only mode.
Returns:
The cube view.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openCubeView

IEssCubeView openCubeView(java.lang.String cubeViewName,
                          java.lang.String connPoolName,
                          boolean connPerOp)
                          throws com.essbase.api.base.EssException
Deprecated. Since 9.3.0.0, Connection Pooling functionality not supported.
Opens a cube view for the specified connection pool name.
Parameters:
cubeViewName - The cube view name.
connPoolName - The name of the connection pool representing the cube.
connPerOp - true for connection per operation. false for connection per session.
Returns:
The cube view.
Throws:
com.essbase.api.base.EssException - if an error occurs.

delete

void delete()
            throws com.essbase.api.base.EssException
Deletes this domain. The root domain cannot be deleted.
Throws:
com.essbase.api.base.EssException - if an error occurs.

disableComponent

void disableComponent(java.lang.String componentName)
                      throws com.essbase.api.base.EssException
Disable one component. This will disable all connection pool of this component.
Parameters:
componentName - String
Throws:
com.essbase.api.base.EssException

enableComponent

void enableComponent(java.lang.String componentName)
                     throws com.essbase.api.base.EssException
Enable a disabled component. This will enable all connection pool(s) of this component.
Parameters:
componentName - String
Throws:
com.essbase.api.base.EssException

Skip navigation links