|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssDomain is the Essbase domain. It allows to create/delete/enumerate/ get domain objects such as user, group, domain, server.
Nested Class Summary | |
static class |
IEssDomain.EEssDomainObjectType
The EEssDomainObjectType is an enumeration of domain object types. |
Nested classes inherited from class 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)
Creates an object in the domain. |
IEssCluster |
createCluster(java.lang.String clusterName)
Creates a cluster in the domain. |
IEssConnectionPool |
createConnectionPool(java.lang.String connPoolName)
Creates a connection pool in the domain. |
IEssDomain |
createDomain(java.lang.String domainName)
Creates a domain in the domain. |
IEssEnterpriseServer |
createEnterpriseServer(java.lang.String svrName)
Creates/Registers an enterprise server in the domain. |
IEssGroup |
createGroup(java.lang.String groupName)
Creates a group in the domain. |
IEssOlapServer |
createOlapServer(java.lang.String svrName)
Creates/Registers a olap server in the domain. |
com.essbase.api.domain.IEssRole |
createRole(java.lang.String roleName)
Creates a role in the domain. |
IEssUser |
createUser(java.lang.String userName)
Deprecated. Use createUser(String userName, String password). |
IEssUser |
createUser(java.lang.String userName,
java.lang.String password)
Creates an user in the domain. |
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)
Deletes an object in the domain. |
void |
deleteCluster(java.lang.String clusterName)
Deletes a cluster in the domain. |
void |
deleteConnectionPool(java.lang.String connPoolName)
Deletes a connection pool in the domain. |
void |
deleteDomain(java.lang.String domainName)
Deletes a domain in the domain. |
void |
deleteEnterpriseServer(java.lang.String svrName)
Deletes/Unregisters a enterprise server in the domain. |
void |
deleteGroup(java.lang.String groupName)
Deletes a group in the domain. |
void |
deleteOlapServer(java.lang.String svrName)
Deletes/Unregisters a olap server in the domain. |
void |
deleteRole(java.lang.String roleName)
Deletes a role in the domain. |
void |
deleteUser(java.lang.String userName)
Deletes an user in the domain. |
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)
Gets the specified object in the domain. |
IEssIterator |
getChildObjects(IEssDomain.EEssDomainObjectType objType)
Gets the list of objects of the specified type in the domain. |
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)
Gets the specified connection pool in the domain. |
IEssIterator |
getConnectionPools()
Gets the list of connection pools in the domain. |
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()
Gets the count of connection pools in the domain. |
int |
getCountDomains()
Gets the count of domains in the domain. |
int |
getCountEnterpriseServers()
Gets the count of enterprise servers in the domain. |
int |
getCountGroups()
Gets the count of groups in the domain. |
int |
getCountOlapServers()
Gets the count of olap servers in the domain. |
int |
getCountRoles()
Gets the count of roles in the domain. |
int |
getCountUsers()
Gets the count of users in the domain. |
java.lang.String |
getDescription()
Gets the domain description. |
IEssDomain |
getDomain(java.lang.String domainName)
Gets the specified domain in the domain. |
IEssIterator |
getDomains()
Gets the list of domains in the domain. |
IEssEnterpriseServer |
getEnterpriseServer(java.lang.String svrName)
Gets the specified enterprise server in the domain. |
IEssIterator |
getEnterpriseServers()
Gets the list of enterprise servers in the domain. |
java.lang.String[][] |
getExternalUsers(java.lang.String firstName,
java.lang.String lastName,
java.lang.String userName,
java.lang.String emailAddress)
Gets the list of users from external directories filtered by identity, firstName, lastName, userName, emailAddress. |
IEssGroup |
getGroup(java.lang.String groupName)
Gets the specified group in the domain. |
IEssIterator |
getGroups()
Gets the list of groups in the domain. |
java.lang.String |
getHierarchicalName()
Gets the fully qualified domain name. |
java.lang.String |
getName()
Gets the domain name. |
IEssOlapServer |
getOlapServer(java.lang.String svrName)
Gets the specified olap server in the domain. |
IEssIterator |
getOlapServers()
Gets the list of olap servers in the domain. |
com.essbase.api.domain.IEssRole |
getRole(java.lang.String roleName)
Gets the specified role in the domain. |
IEssIterator |
getRoles()
Gets the list of roles in the domain. |
IEssUser |
getUser(java.lang.String userName)
Gets the specified user in the domain. |
IEssIterator |
getUsers()
Gets the list of users in the domain. |
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)
Opens a cube view for the specified connection pool name. |
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)
Opens a cube view. |
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)
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. |
java.lang.Object[] |
syncSecurityStores(boolean essSecFileToEesStore,
java.lang.String domName,
java.lang.String olapSvrName,
java.lang.String olapAdminName,
java.lang.String olapAdminPwd)
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. |
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 |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_HIERARCHICAL_NAME
public static final int PROP_IS_ROOT_DOMAIN
public static final int PROP_COUNT_USERS
public static final int PROP_COUNT_GROUPS
public static final int PROP_COUNT_OLAP_SERVERS
public static final int PROP_COUNT_ENTERPRISE_SERVERS
public static final int PROP_COUNT_DOMAINS
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occurs.public java.lang.String getHierarchicalName() throws EssException
EssException
- if an error occurs.public java.lang.String getDescription() throws EssException
EssException
- if an error occurs.public void setDescription(java.lang.String desc) throws EssException
desc
- The domain description.
EssException
- if an error occurs.public boolean isRootDomain() throws EssException
EssException
- is an error occurs.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public IEssUser createUser(java.lang.String userName) throws EssException
userName
- The user name (in lower case).
EssException
- if an error occurs.public IEssUser createUser(java.lang.String userName, java.lang.String password) throws EssException
userName
- The user name (in lower case).password
- The password.
EssException
- if an error occurs.public void deleteUser(java.lang.String userName) throws EssException
userName
- The name of the user to delete.
EssException
- if an error occurs.public int getCountUsers() throws EssException
EssException
- if an error occurs.public IEssUser getUser(java.lang.String userName) throws EssException
userName
- The user name.
EssException
- if an error occurs.public IEssIterator getUsers() throws EssException
EssException
- if an error occurs.public java.lang.String[][] getExternalUsers(java.lang.String firstName, java.lang.String lastName, java.lang.String userName, java.lang.String emailAddress) throws EssException
firstName
- The first name to filter on.lastName
- The last name to filter on.emailAddress
- The e-mail address to filter on.
EssException
- if an error occurs.public IEssGroup createGroup(java.lang.String groupName) throws EssException
groupName
- The group name (in lower case).
EssException
- if an error occurs.public void deleteGroup(java.lang.String groupName) throws EssException
groupName
- The name of the group to delete.
EssException
- if an error occurs.public int getCountGroups() throws EssException
EssException
- if an error occurs.public IEssGroup getGroup(java.lang.String groupName) throws EssException
groupName
- The group name.
EssException
- if an error occurs.public IEssIterator getGroups() throws EssException
EssException
- if an error occurs.public com.essbase.api.domain.IEssRole createRole(java.lang.String roleName) throws EssException
roleName
- The role name (in lower case).
EssException
- if an error occurs.public void deleteRole(java.lang.String roleName) throws EssException
roleName
- The name of the role to delete.
EssException
- if an error occurs.public int getCountRoles() throws EssException
EssException
- if an error occurs.public com.essbase.api.domain.IEssRole getRole(java.lang.String roleName) throws EssException
roleName
- The role name.
EssException
- if an error occurs.public IEssIterator getRoles() throws EssException
EssException
- if an error occurs.public com.essbase.api.domain.IEssApplication createApplication(java.lang.String appName) throws EssException
appName
- The application name (in lower case).
EssException
- if an error occurs.public void deleteApplication(java.lang.String appName) throws EssException
appName
- The name of the application to delete.
EssException
- if an error occurs.public int getCountApplications() throws EssException
EssException
- if an error occurs.public com.essbase.api.domain.IEssApplication getApplication(java.lang.String appName) throws EssException
appName
- The application name.
EssException
- if an error occurs.public IEssIterator getApplications() throws EssException
EssException
- if an error occurs.public IEssOlapServer createOlapServer(java.lang.String svrName) throws EssException
svrName
- The server name or address (in lower case).
EssException
- if an error occurs.public void deleteOlapServer(java.lang.String svrName) throws EssException
svrName
- The name/address of the olap server to delete.
EssException
- if an error occurs.public int getCountOlapServers() throws EssException
EssException
- if an error occurs.public IEssOlapServer getOlapServer(java.lang.String svrName) throws EssException
svrName
- The olap server name.
EssException
- if an error occurs.public IEssIterator getOlapServers() throws EssException
EssException
- if an error occurs.public IEssEnterpriseServer createEnterpriseServer(java.lang.String svrName) throws EssException
svrName
- The server name or address (in lower case).
EssException
- if an error occurs.public void deleteEnterpriseServer(java.lang.String svrName) throws EssException
svrName
- The name/address of the enterprise server to delete.
EssException
- if an error occurs.public int getCountEnterpriseServers() throws EssException
EssException
- if an error occurs.public IEssEnterpriseServer getEnterpriseServer(java.lang.String svrName) throws EssException
svrName
- The enterprise server name.
EssException
- if an error occurs.public IEssIterator getEnterpriseServers() throws EssException
EssException
- if an error occurs.public IEssDomain createDomain(java.lang.String domainName) throws EssException
domainName
- The name of the domain to create (in lower case).
EssException
- if an error occurs.public void deleteDomain(java.lang.String domainName) throws EssException
EssException
- if an error occurs.public int getCountDomains() throws EssException
EssException
- if an error occurs.public IEssDomain getDomain(java.lang.String domainName) throws EssException
domainName
- The domain name.
EssException
- if an error occurs.public IEssIterator getDomains() throws EssException
EssException
- if an error occurs.public IEssCluster createCluster(java.lang.String clusterName) throws EssException
clusterName
- The name of the cluster to create (in lower case).
EssException
- if an error occurs.public void deleteCluster(java.lang.String clusterName) throws EssException
EssException
- if an error occurs.public int getCountClusters() throws EssException
EssException
- if an error occurs.public IEssCluster getCluster(java.lang.String clusterName) throws EssException
clusterName
- The cluster name (in lower case).
EssException
- if an error occurs.public IEssIterator getClusters() throws EssException
EssException
- if an error occurs.public IEssConnectionPool createConnectionPool(java.lang.String connPoolName) throws EssException
connPoolName
- The name of the connection pool to create (in lower
case).
EssException
- if an error occurs.public void deleteConnectionPool(java.lang.String connPoolName) throws EssException
connPoolName
- The name of the connection pool to delete.
EssException
- if an error occurs.public int getCountConnectionPools() throws EssException
EssException
- if an error occurs.public IEssConnectionPool getConnectionPool(java.lang.String connPoolName) throws EssException
connPoolName
- The connection pool name.
EssException
- if an error occurs.public IEssIterator getConnectionPools() throws EssException
EssException
- if an error occurs.public IEssBaseObject createChildObject(java.lang.String objName, IEssDomain.EEssDomainObjectType objType) throws EssException
objName
- The object name (in lower case).objType
- The object type.
EssException
- if an error occurs.public void deleteChildObject(java.lang.String objName, IEssDomain.EEssDomainObjectType objType) throws EssException
objName
- The object name.objType
- The object type.
EssException
- if an error occurs.public int getCountChildObjects(IEssDomain.EEssDomainObjectType objType) throws EssException
objType
- The object type.
EssException
- if an error occurs.public IEssBaseObject getChildObject(java.lang.String objName, IEssDomain.EEssDomainObjectType objType) throws EssException
objName
- The object name.objType
- The object type.
EssException
- if an error occurs.public IEssIterator getChildObjects(IEssDomain.EEssDomainObjectType objType) throws EssException
objType
- The object type.
EssException
- if an error occurs.public java.lang.Object[] syncSecurityStores(boolean essSecFileToEesStore, java.lang.String domName, java.lang.String olapSvrName) throws EssException
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.
EssException
- if an error occurs.public java.lang.Object[] syncSecurityStores(boolean essSecFileToEesStore, java.lang.String domName, java.lang.String olapSvrName, java.lang.String olapAdminName, java.lang.String olapAdminPwd) throws EssException
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.
EssException
- if an error occurs.public void syncCubeReplicas(java.lang.String mainCubeName, java.lang.String[] replicaCubeNames) throws EssException
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.
EssException
- if an error occurs.public void copyOlapApplication(java.lang.String srcOlapSvrName, java.lang.String srcOlapAppName, java.lang.String destOlapSvrName, java.lang.String destOlapAppName) throws EssException
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.
EssException
- if an error occurs.public 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 EssException
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 source cube name.
EssException
- if an error occurs.public 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 EssException
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.
EssException
- if an error occurs.public IEssCubeView openCubeView(java.lang.String cubeViewName, java.lang.String connPoolName, boolean connPerOp) throws EssException
connPoolName
- The name of the connection pool representing the cube.connPerOp
- true for connection per operation. false for connection
per session.
EssException
- if an error occurs.public void delete() throws EssException
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |