Skip navigation links


com.essbase.eas.essbase.api.jni
Class EssCoreJni

java.lang.Object
  extended by com.essbase.eas.essbase.defs.EssbaseObjectsConstants
      extended by com.essbase.eas.essbase.api.jni.EssCoreJni


public final class EssCoreJni
extends EssbaseObjectsConstants

This class defines the JNI wrapper to the core API.

Notes:

Version:
1.00, 06/17/2000
Author:
Hank Cox
See Also:
CoreFactory

Field Summary

 

Fields inherited from class com.essbase.eas.essbase.defs.EssbaseObjectsConstants
FILETYPE_DATA, FILETYPE_INDEX, MAXIMUM_VALUE, MINIMUM_VALUE, OBJTYPE_ALIAS, OBJTYPE_ALL, OBJTYPE_ASCBACKUP, OBJTYPE_BACKUP, OBJTYPE_BINBACKUP, OBJTYPE_CALCSCRIPT, OBJTYPE_CONFIG, OBJTYPE_DATA, OBJTYPE_EQD, OBJTYPE_EXCEL, OBJTYPE_LOTUS2, OBJTYPE_LOTUS3, OBJTYPE_LOTUS4, OBJTYPE_LRO, OBJTYPE_MAX, OBJTYPE_NONE, OBJTYPE_OPG, OBJTYPE_OUTLINE, OBJTYPE_PARTITION, OBJTYPE_REPORT, OBJTYPE_RULES, OBJTYPE_SELECTION, OBJTYPE_STRUCTURE, OBJTYPE_TEXT, OBJTYPE_WIZARD, OBJTYPE_WORKSHEET

 

Method Summary
static int addToGroup(ContextHandle handle, java.lang.String groupname, java.lang.String username)
          wraps the core AddToGroup() API
static int calcScriptVerify(ContextHandle handle, java.lang.String calcScript)
          wraps the core CalcScriptVerify() API
static int calcScriptVerifyFile(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String calcScript)
          wraps the core CalcScriptVerify() API
static int clearDatabase(ContextHandle handle)
          wraps the core ClearDatabase() API
static int copyObject(ContextHandle handle, int objType, java.lang.String srcApp, java.lang.String destApp, java.lang.String srcDb, java.lang.String destDb, java.lang.String srcObj, java.lang.String destObj)
          wraps the core copyObject() API
static int createApplication(ContextHandle handle, java.lang.String name)
          wraps the core CreateApplication() API
static int createDatabase(ContextHandle handle, java.lang.String appName, java.lang.String dbName, boolean bCurrency)
          wraps the core CreateDatabase() API
static int createDatabaseEx(ContextHandle handle, java.lang.String appName, java.lang.String dbName, boolean bCurrency, boolean bNonUnique)
          Wraps the CreateDatabaseEx() API
static int createExternalUser(ContextHandle handle, java.lang.String userName, java.lang.String password, java.lang.String protocol, java.lang.String connParameter, short domainAccess)
          wraps the createExternalUser() API
static int createLocalContext(InstanceHandle instance, ContextHandle context)
          creates a local API context for use in local API operations
static int createStorageTypedApplication(ContextHandle handle, java.lang.String name, short type)
          wraps the core CreateStorageTypedApplication() API
static int createUserKey(ContextHandle handle, java.lang.String username, UserKey userKey)
          wraps the unpublished CreateUserWithKey() API
static int deleteApplication(ContextHandle handle, java.lang.String name)
          wraps the core DeleteApplication() API
static int deleteDatabase(ContextHandle handle, java.lang.String appName, java.lang.String dbName)
          wraps the core DeleteDatabase() API
static int deleteFromGroup(ContextHandle handle, java.lang.String groupname, java.lang.String username)
          wraps the core DeleteFromGroup() API
static int deleteLocalContext(ContextHandle context)
           
static int deleteObject(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName)
          wraps the core deleteObject() API
protected  void finalize()
           
static int getActive(ContextHandle context, java.lang.StringBuffer appName, java.lang.StringBuffer dbName, BitField access)
          wraps the core GetActive() API
static int getAlias(ContextHandle handle, java.lang.StringBuffer aliasName)
          wraps the core GetAlias() API
static int getAllowedStorageTypes(ContextHandle handle, ServerStorageTypesInfo types)
          wraps the EssGetAllowedStorageTypes() API
 int getAPIVersion(Version version)
          retrieves the version number of the functional API being used.
static int getApplicationAccess(ContextHandle handle, java.lang.String userName, java.lang.String appName, java.util.ArrayList userAppList)
          wraps the core GetApplicationAccess() API
static int getApplicationAccessEx(ContextHandle handle, java.lang.String userName, java.lang.String appName, java.util.ArrayList userAppList, boolean usingIdentity, boolean isUser)
           
static int getApplicationAccessEx(EssSession session, java.lang.String userName, java.lang.String appName, java.util.ArrayList userAppList, boolean isUser)
           
static int getApplicationFrontEndAppType(ContextHandle handle, java.lang.String appName, AppFrontEndType frontEndAppType)
           
static int getApplicationID(ContextHandle handle, java.lang.String appName, java.lang.StringBuffer appID)
           
static int getApplicationInfoEx(ContextHandle handle, java.lang.String name, ApplicationInfoEx info)
          wraps the core GetApplicationInfoEx() API
static int getApplicationState(ContextHandle handle, java.lang.String name, ApplicationState state)
          wraps the core GetApplicationState() API
static int getCalcList(ContextHandle handle, UserCalcList userCalc)
          wraps the core GetCalcList() API
static int getConfigValues(ContextHandle handle, GlobalInfo globalInfo)
          wraps the unpublished GetConfigValues API
static EssCoreJni getCoreJni()
           
static int getDatabaseAccess(ContextHandle handle, java.lang.String userName, java.lang.String appName, java.lang.String dbName, java.util.ArrayList userDbList)
          wraps the core GetDatabaseAccess() API
static int getDatabaseAccessEx(ContextHandle handle, java.lang.String userName, java.lang.String appName, java.lang.String dbName, java.util.ArrayList userDbList, boolean usingIdentity, boolean isUser)
           
static int getDatabaseAccessEx(EssSession session, java.lang.String userName, java.lang.String appName, java.lang.String dbName, java.util.ArrayList userDbList, boolean isUser)
           
static int getDatabaseInfo(ContextHandle handle, java.lang.String appName, java.lang.String dbName, DatabaseProperties dbProps)
          wraps the core GetDatabaseInfo() API
static int getDatabaseNote(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.StringBuffer dbNote)
          wraps the core GetDatabaseNote() API
static int getDatabaseState(ContextHandle handle, java.lang.String appName, java.lang.String dbName, DatabaseState state)
          wraps the core GetDatabaseState() API
static int getDatabaseStats(ContextHandle handle, java.lang.String appName, java.lang.String dbName, DatabaseStats stats, java.util.List dimensions)
          wraps the core GetDatabaseStats() API
static int getDatabaseStatus(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.util.List statusList)
          wraps the core getDatabaseStatus() API
static int getDefaultCalc(ContextHandle handle, java.lang.StringBuffer calcScript)
          wraps the core GetDefaultCalc() API
static int getExternalUser(ContextHandle handle, java.lang.String userName, UserProperties userProp)
          wraps the core getExternalUser() API
static int getFilterList(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String filterName, java.util.ArrayList userList)
          wraps the core GetFilterList() API
static int getGlobalState(ContextHandle handle, ServerGlobalState state)
          wraps the core GetGlobalState() API
static int getGroup(ContextHandle handle, java.lang.String groupName, GroupProperties groupProp)
          wraps the core GetGroup() API
static int getGroupEx(EssSession session, java.lang.String groupName, GroupProperties groupProp)
           
static int getGroupInfoEx(ContextHandle handle, java.lang.String groupName, GroupProperties groupProp)
          wraps the core GetGroup() API
static int getGroupList(ContextHandle handle, java.lang.String groupName, java.util.List userList)
          wraps the core GetGroupList() API
static int getGroupListEx(ContextHandle handle, java.lang.String groupName, java.util.List userList, boolean usingIdentity, boolean isUser)
           
static int getGroupListEx(EssSession session, java.lang.String groupName, java.util.List userList, boolean isUser)
           
 InstanceHandle getInstanceHandle()
          returns the instance handle associated with this invocation of the Essbase API.
static int getLicenseInfo(ContextHandle handle, LicenseInfo licenseInfo, java.lang.String serverName)
          wraps the unpublished GetLicenseInfo() API
static int getLockInfo(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.util.ArrayList lockArrayList)
          wraps the core EssListLocks() API
static int getLogFile(ContextHandle handle, java.lang.String appName, long dateStamp, java.lang.String localFile)
          wraps the core GetLogFile() API
static long getLogFileFromOffset(ContextHandle handle, java.lang.String appName, long offset, java.lang.String localFile)
          wraps the core GetLogFile() API
static int getObject(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean lock)
          wraps the core getObject() API
static int getObjectInfo(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName, NamedObjectInfo objInfo)
          wraps the EssGetObjectInfo() API Gets information about a specified Essbase file object.
static int getOSResources(ContextHandle handle, SystemInfo systemInfo)
          wraps the unpublished GetOSResources API
static int getOutputString(ContextHandle handle, java.lang.StringBuffer output)
          wraps the core EssGetString() API for retrieving report script output and EssQueryDatabaseMembers calls.
static int getReport(ContextHandle handle, java.lang.Object output)
          calls EssGetString() API till the entire report is fetched for retrieving report script output and EssQueryDatabaseMembers calls.
static int getServerLocaleString(ContextHandle handle, java.lang.StringBuffer localeBuffer)
           
static int getSMStats(ContextHandle handle, java.lang.String appName, java.lang.String dbName, TimeRecord resetTime, java.util.ArrayList runTimeVals)
          wraps the unpublished GetSMStats() API
static int getSpoolFile(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String spoolName, java.lang.String targetFile)
          wraps the EssGetSpoolFile() API
static int getUser(ContextHandle handle, java.lang.String userName, UsrGrpProperties userProps)
          wraps the core GetUser() API
static int getUserEx(EssSession session, java.lang.String userName, UserProperties userProps)
           
static int getUserInfoEx(ContextHandle handle, java.lang.String userName, UserProperties userProp)
          wraps the core getUserUserInfoEx() API
static int getUserKey(ContextHandle handle, java.lang.String username, UserKey userKey)
          wraps the unpublished GetUserKey() API
static int getVersion(ContextHandle handle, Version version)
          wraps the core GetVersion() API.
static boolean hasAppManOption(ContextHandle handle)
          wraps for private API eSSGetClientSettings Checks to see if the application manager is allowed to run
 boolean initialize(short maxHandles)
          Sets up the EssCoreJni for usage.
static boolean isDatabaseLocked(ContextHandle handle, java.lang.String appName, java.lang.String dbName)
           
static boolean isSubsetCodepage(ContextHandle handle, java.lang.String locale1, java.lang.String locale2)
          Is codepage for locale 1 a subset of locale 2
static boolean isValidContext(ContextHandle handle)
          wraps for public API EssValidateHCtx() Checks to see if the Essbase context handle is valid
static int listAliases(ContextHandle handle, java.util.List aliasList)
          wraps the core ListAliases() API
static int listApplications(ContextHandle handle, java.util.List names)
          wraps the core ListApplications() API
static int listDatabases(ContextHandle handle, java.lang.String appName, java.util.List names)
          wrapts the core ListDatabases() API
static int listDbFiles(ContextHandle handle, java.lang.String appName, java.lang.String dbName, short fileType, java.util.List dbFileInfos)
          wraps the core ListDbFiles() API
static int listFilters(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.util.List names)
          wrapts the core ListFilters() API
static int listGroups(ContextHandle handle, java.lang.String appName, java.lang.String dbName, int count, java.util.List userList)
          wraps the core ListGroups() API
static int listGroupsEx(EssSession session, java.lang.String appName, java.lang.String dbName, int count, java.util.List userList)
           
static int listGroupsInfoEx(ContextHandle handle, java.lang.String appName, java.lang.String dbName, int count, java.util.List userList)
          wraps the core ListGroupsInfoEx() API
static int listObjects(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.util.List names)
          wraps the core ListObjects() API
static int listObjectsInfo(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.util.ArrayList objList)
          wraps the EssListObjects() API Returns a list of Essbase file object information.
static int listUserGroupsForAppInHSSMode(ContextHandle handle, java.lang.String appName, java.util.List userList, java.util.List grpList)
           
static int listUserGroupsForAppInHSSModeEx(ContextHandle handle, java.lang.String appName, java.util.List userList, java.util.List grpList, boolean usingIdentity)
           
static int listUserGroupsForAppInHSSModeEx(EssSession session, java.lang.String appName, java.util.List userList, java.util.List grpList)
           
static int listUsers(ContextHandle handle, java.lang.String appName, java.lang.String dbName, int count, java.util.List userList)
          wraps the core ListUsers() API
static int listUsersEx(EssSession session, java.lang.String appName, java.lang.String dbName, int count, java.util.List userList, boolean skipAccessType)
           
static int listUsersFile(ContextHandle handle, java.lang.String appName, java.lang.String dbName, int count, java.lang.String userList)
          wraps the core ListUsers() API
static int listUsersFileEx(ContextHandle handle, java.lang.String appName, java.lang.String dbName, int count, java.lang.String userList, boolean skipAccessType)
          wraps the core ListUsers() API
static int listUsersFileEx(EssSession session, java.lang.String appName, java.lang.String dbName, int count, java.lang.String userList, boolean skipAccessType)
           
static int listUsersInfoEx(ContextHandle handle, java.lang.String appName, java.lang.String dbName, int count, java.util.List userList, boolean skipAccessType)
          wraps the core ListUsersInfoEx() API
static int listUsersInfoFileEx(ContextHandle handle, java.lang.String appName, java.lang.String dbName, int count, java.lang.String userList, boolean skipAccessType)
          wraps the core ListUsersInfoEx() API
static int loadApplication(ContextHandle handle, java.lang.String name)
          wraps the core LoadApplication() API
static int loadDatabase(ContextHandle handle, java.lang.String appName, java.lang.String dbName)
          wraps the core LoadDatabase() API
static int lockObject(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String name)
          wraps the core LockObject() API
static int login(InstanceHandle instance, java.lang.String server, java.lang.String user, java.lang.String password, ContextHandle context)
          creates a login connection to an Essbase server.
static int loginEx(InstanceHandle instance, java.lang.String server, java.lang.String token, ContextHandle context)
          use external authentication to create an login connection to an Essbase server.
static int loginSetPassword(InstanceHandle hInstance, java.lang.String Server, java.lang.String UserName, java.lang.String Password, java.lang.String NewPassword, int pDbCount, java.util.List ppDbList, ContextHandle phCtx)
          wraps the core LoginSetPassword() API
 int logout(ContextHandle context)
           
static int logout(long handle)
          disconnects from an Essbase server.
static int logSize(ContextHandle handle, boolean isAppLog, java.lang.String appName, FileInfo fileInfo)
          wraps the core LogSize() API
static int lroDeleteObject(ContextHandle handle, LroHandle lHandle)
          wraps the EssLRODeleteObject() API
static int lroGetObject(ContextHandle handle, LroHandle lHandle, java.lang.String targetFile, short option, LroInfo lro)
          wraps the EssLROGetObject() API
static int lroListObjects(ContextHandle handle, java.lang.String userName, long date, java.util.ArrayList lroList)
          wraps the EssLROListObjects() API
static int lroPurgeObjects(ContextHandle handle, java.lang.String userName, long date)
          wraps the EssLROPurgeObjects() API
static int lroUpdateObject(ContextHandle handle, LroHandle lHandle, short option, LroInfo lro)
          wraps the EssLROUpdateObject() API
static void main(java.lang.String[] args)
          driver for independently testing EssCoreJni API calls
static int putObject(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean unlock)
          wraps the core putObject() API
static int putOutlineObject(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String localName, boolean unlock)
          wrapper around a variety of APIs to handle uploading an outline Note: This in not appropriate here, but it is a quick method to get this done as a full fledged outline API will not be used anytime soon.
static int registerEventServer(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String url, java.lang.String user, java.lang.String password, boolean registerServer)
           
 boolean release()
          releases this instance of the EssCoreJni connection to Essbase.
static int removeLock(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String loginId)
          wraps the core EssRemoveLocks() API
static int renameApplication(ContextHandle handle, java.lang.String oldName, java.lang.String newName)
          wraps the core RenameApplication() API
static int renameDatabase(ContextHandle handle, java.lang.String appName, java.lang.String oldName, java.lang.String newName)
          wraps the core RenameDatabase() API
static int renameFilter(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String oldName, java.lang.String newName)
          wraps the core RenameFilter() API
static int renameObject(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String oldName, java.lang.String newName)
          wraps the core renameObject() API
static int reportScriptExecute(ContextHandle handle, java.lang.String reportScript)
          wraps the core EssReport() API for execution
static int reportScriptExecuteFile(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String reportScript)
          wraps the core EssReport() API for execution
static int reportScriptVerify(ContextHandle handle, java.lang.String reportScript)
          wraps the core EssReport() API
static int reportScriptVerifyFile(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String reportScript)
          wraps the core EssReport() API
static int setActive(ContextHandle handle, java.lang.String appName, java.lang.String dbName, BitField access)
          wraps the core SetActive() API
static int setAlias(ContextHandle handle, java.lang.String aliasName)
          wraps the core SetAlias() API
static int setApplicationAccess(ContextHandle handle, java.util.ArrayList userAppList)
          wraps the core SetApplicationAccess() API
static int setApplicationAccessEx(ContextHandle handle, java.util.ArrayList userAppList)
           
static int setApplicationAccessEx(EssSession session, java.util.ArrayList userAppList)
           
static int setApplicationState(ContextHandle handle, java.lang.String name, ApplicationState state)
          wraps the core SetApplicationState() API
static int setCalcList(ContextHandle handle, UserCalcList userCalc)
          wraps the core SetCalcList() API
static int setDatabaseAccess(ContextHandle handle, java.util.ArrayList userDbList)
          wraps the core SetDatabaseAccess() API
static int setDatabaseAccessEx(ContextHandle handle, java.util.ArrayList userDbList)
           
static int setDatabaseAccessEx(EssSession session, java.util.ArrayList userDbList)
           
static int setDatabaseNote(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String dbNote)
          wraps the core SetDatabaseNote() API
static int setDatabaseState(ContextHandle handle, java.lang.String appName, java.lang.String dbName, DatabaseState state)
          wraps the core SetDatabaseState() API
static int setDefaultCalc(ContextHandle handle, java.lang.String calcScript)
          wraps the core SetDefaultCalc() API
static int setDefaultCalcFile(ContextHandle destHandle, ContextHandle srcHandle, java.lang.String appName, java.lang.String dbName, java.lang.String fileName)
          wraps the core SetDefaultCalcFile() API
static int setExternalUser(ContextHandle handle, short type, java.lang.String userName, java.lang.String password, java.lang.String protocol, java.lang.String connParameter, short domainAccess)
          wraps the core setExternalUser() API
static int setFilterList(ContextHandle handle, java.lang.String appName, java.lang.String dbName, java.lang.String filterName, java.util.ArrayList userList)
          wraps the core SetFilterList() API
static int setFiltersInCASMode(ContextHandle handle, java.util.ArrayList userDbList)
          wraps the core SetDatabaseAccess() API
static int setGlobalState(ContextHandle handle, ServerGlobalState state)
          wraps the core SetGlobalState() API
static int setGroup(ContextHandle handle, GroupProperties groupProp)
          wraps the core SetGroup() API
static int setGroupList(ContextHandle handle, java.lang.String groupName, java.util.List userList)
          wraps the core SetGroupList() API
static int setGroupListEx(ContextHandle handle, java.lang.String groupName, java.util.List userList, boolean usingIdentity, boolean isUser)
           
static int setGroupListEx(EssSession session, java.lang.String groupName, java.util.List userList, boolean isUser)
           
static int setPassword(ContextHandle handle, java.lang.String userName, java.lang.String password)
          wraps the core SetPassword() API
static int setUser(ContextHandle handle, UsrGrpProperties userProps)
          wraps the core SetUser() API
static int setUserKey(ContextHandle handle, java.lang.String username, UserKey userKey)
          wraps the unpublished SetUserKey() API
static int setUserType(ContextHandle handle, java.lang.String userName, short domainAccess)
           
static int shutdownServer(InstanceHandle handle, java.lang.String server, java.lang.String user, java.lang.String password)
           
static int unloadApplication(ContextHandle handle, java.lang.String name)
          wraps the core UnloadApplication() API
static int unloadDatabase(ContextHandle handle, java.lang.String appName, java.lang.String dbName)
          wraps the core UnloadDatabase() API
static int unlockObject(ContextHandle handle, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String name)
          wraps the core UnlockObject() API
static int updateEventServerFile(ContextHandle handle, java.lang.String url, java.lang.String user, java.lang.String password)
           
static int verifyFilter(ContextHandle handle, java.lang.String appName, java.lang.String dbName)
          wraps the EssVerifyFilter () API Follow a call to this function with subsequent calls to verifyFilterRows()
static int verifyFilterRows(ContextHandle handle, java.lang.String rowText)
          wraps the EssVerifyFilterRows() API Call verifyFilterRows() for each row of the filter to be verified.
static int verifyFormula(ContextHandle context, java.lang.String formula)
          wraps the EssVerifyFormula() API Verifies the syntax of a formula

 

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Method Detail

getCoreJni

public static EssCoreJni getCoreJni()

getAPIVersion

public int getAPIVersion(Version version)
retrieves the version number of the functional API being used.

login

public static int login(InstanceHandle instance,
                        java.lang.String server,
                        java.lang.String user,
                        java.lang.String password,
                        ContextHandle context)
creates a login connection to an Essbase server.

loginEx

public static int loginEx(InstanceHandle instance,
                          java.lang.String server,
                          java.lang.String token,
                          ContextHandle context)
use external authentication to create an login connection to an Essbase server. Wraps the core EssLoginEx() API.

logout

public static int logout(long handle)
disconnects from an Essbase server.

logout

public int logout(ContextHandle context)

loginSetPassword

public static int loginSetPassword(InstanceHandle hInstance,
                                   java.lang.String Server,
                                   java.lang.String UserName,
                                   java.lang.String Password,
                                   java.lang.String NewPassword,
                                   int pDbCount,
                                   java.util.List ppDbList,
                                   ContextHandle phCtx)
wraps the core LoginSetPassword() API
Parameters:
hInstance - - Essbase API instance handle .
Server - - Network server name .
Password - - Old Password.
NewPassword - - New Password.
pDbCount - - Number of accessible databases
ppDbList - - Address of the pointer to an array of accessible application-database structures
phCtx - - Pointer to the Essbase context handle
Returns:
success/failure status code.

getActive

public static int getActive(ContextHandle context,
                            java.lang.StringBuffer appName,
                            java.lang.StringBuffer dbName,
                            BitField access)
wraps the core GetActive() API
Parameters:
context - - context handle to be used.
appName - - the active application name is returned here.
dbName - - the active database name is returned here.
access - - this user's access privileges are returned here.
Returns:
success/failure status code.

setActive

public static int setActive(ContextHandle handle,
                            java.lang.String appName,
                            java.lang.String dbName,
                            BitField access)
wraps the core SetActive() API
Parameters:
context - - context handle to be used
appName - - application to set as active
dbName - - database to set as active
access - - this user's acces privileges are returned here.

getGlobalState

public static int getGlobalState(ContextHandle handle,
                                 ServerGlobalState state)
wraps the core GetGlobalState() API
Parameters:
context - - context handle to be used.
state - - a GlobalState object to place the results in.

setGlobalState

public static int setGlobalState(ContextHandle handle,
                                 ServerGlobalState state)
wraps the core SetGlobalState() API
Parameters:
context - - context handle to be used.
state - - a GlobalState object to place the results in.

getVersion

public static int getVersion(ContextHandle handle,
                             Version version)
wraps the core GetVersion() API. Note: do not confuse this with getAPIVersion().

listApplications

public static int listApplications(ContextHandle handle,
                                   java.util.List names)
wraps the core ListApplications() API
Parameters:
context - - context handle to be used
names - - List object to be filled with the application names.

createApplication

public static int createApplication(ContextHandle handle,
                                    java.lang.String name)
wraps the core CreateApplication() API
Parameters:
context - - context handle to be used
name - - String with the name of the create application.

createStorageTypedApplication

public static int createStorageTypedApplication(ContextHandle handle,
                                                java.lang.String name,
                                                short type)
wraps the core CreateStorageTypedApplication() API
Parameters:
context - - context handle to be used
name - - String with the name of the create application.
type - - A short specifying the storage type (see constants in ServerStorageType.java for options)

deleteApplication

public static int deleteApplication(ContextHandle handle,
                                    java.lang.String name)
wraps the core DeleteApplication() API
Parameters:
context - - context handle to be used
name - - String with the name of the application to delete.

getApplicationState

public static int getApplicationState(ContextHandle handle,
                                      java.lang.String name,
                                      ApplicationState state)
wraps the core GetApplicationState() API
Parameters:
context - - context handle to be used
name - - String with the name of the application to retrieve information for.
state - - an application state object to put the results in.

setApplicationState

public static int setApplicationState(ContextHandle handle,
                                      java.lang.String name,
                                      ApplicationState state)
wraps the core SetApplicationState() API
Parameters:
handle - - context handle to be used
name - - application name to set the state for.
state - - an application state object to take the values from.

getApplicationInfoEx

public static int getApplicationInfoEx(ContextHandle handle,
                                       java.lang.String name,
                                       ApplicationInfoEx info)
wraps the core GetApplicationInfoEx() API
Parameters:
handle - - context handle to be used
name - - application name to get the information for.
info - - an application info ex object populate.

loadApplication

public static int loadApplication(ContextHandle handle,
                                  java.lang.String name)
wraps the core LoadApplication() API
Parameters:
context - - context handle to be used.
name - - String with the name of the application to delete.

unloadApplication

public static int unloadApplication(ContextHandle handle,
                                    java.lang.String name)
wraps the core UnloadApplication() API
Parameters:
context - - context handle to be used.
name - - String with the name of the application to delete.

removeLock

public static int removeLock(ContextHandle handle,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String loginId)
wraps the core EssRemoveLocks() API
Parameters:
context - - context handle to be used.
appName - - name of application to remove lock from.
dbName - - name of database to remove lock from.
loginId - - Login ID that identifys the lock to be removed.

renameApplication

public static int renameApplication(ContextHandle handle,
                                    java.lang.String oldName,
                                    java.lang.String newName)
wraps the core RenameApplication() API
Parameters:
context - - context handle to be used.
oldName - - original name of the application.
newName - - new name of the application

listDatabases

public static int listDatabases(ContextHandle handle,
                                java.lang.String appName,
                                java.util.List names)
wrapts the core ListDatabases() API
Parameters:
context - - context handle to be used
appName - - name of application to retrieve database names for.
names - - List object to be filled with database names

listFilters

public static int listFilters(ContextHandle handle,
                              java.lang.String appName,
                              java.lang.String dbName,
                              java.util.List names)
wrapts the core ListFilters() API
Parameters:
context - - context handle to be used
appName - - name of application to retrieve filter names for.
dbName - - name of database to retrieve filter names for.
names - - List object to be filled with filter names

createDatabase

public static int createDatabase(ContextHandle handle,
                                 java.lang.String appName,
                                 java.lang.String dbName,
                                 boolean bCurrency)
wraps the core CreateDatabase() API
Parameters:
context - - context handle to be used
appName - - name of application database will be in
dbName - - name of database to create
bCurrency - - indicates currency database or normal database

createDatabaseEx

public static int createDatabaseEx(ContextHandle handle,
                                   java.lang.String appName,
                                   java.lang.String dbName,
                                   boolean bCurrency,
                                   boolean bNonUnique)
Wraps the CreateDatabaseEx() API
Parameters:
handle -
appName -
dbName -
bCurrency -
bNonUnique -
Returns:

deleteDatabase

public static int deleteDatabase(ContextHandle handle,
                                 java.lang.String appName,
                                 java.lang.String dbName)
wraps the core DeleteDatabase() API
Parameters:
context - - context handle to be used
appName - - name of application database is in
dbName - - name of database to delete

renameDatabase

public static int renameDatabase(ContextHandle handle,
                                 java.lang.String appName,
                                 java.lang.String oldName,
                                 java.lang.String newName)
wraps the core RenameDatabase() API
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
oldName - - existing name of database
newName - - updated name of database

loadDatabase

public static int loadDatabase(ContextHandle handle,
                               java.lang.String appName,
                               java.lang.String dbName)
wraps the core LoadDatabase() API
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database to start

unloadDatabase

public static int unloadDatabase(ContextHandle handle,
                                 java.lang.String appName,
                                 java.lang.String dbName)
wraps the core UnloadDatabase() API
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database to stop

clearDatabase

public static int clearDatabase(ContextHandle handle)
wraps the core ClearDatabase() API
Parameters:
context - - context handle to be used

setDatabaseNote

public static int setDatabaseNote(ContextHandle handle,
                                  java.lang.String appName,
                                  java.lang.String dbName,
                                  java.lang.String dbNote)
wraps the core SetDatabaseNote() API
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database to stop
dbNote - - database note string

getDatabaseNote

public static int getDatabaseNote(ContextHandle handle,
                                  java.lang.String appName,
                                  java.lang.String dbName,
                                  java.lang.StringBuffer dbNote)
wraps the core GetDatabaseNote() API
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database to stop
dbNote - - database note buffer to retrieve

setAlias

public static int setAlias(ContextHandle handle,
                           java.lang.String aliasName)
wraps the core SetAlias() API
Parameters:
context - - context handle to be used
aliasName - - alias table name to set active

getAlias

public static int getAlias(ContextHandle handle,
                           java.lang.StringBuffer aliasName)
wraps the core GetAlias() API
Parameters:
context - - context handle to be used
aliasName - - alias table name to retrieve

listAliases

public static int listAliases(ContextHandle handle,
                              java.util.List aliasList)
wraps the core ListAliases() API
Parameters:
context - - context handle to be used
aliasList - - list of alias tables in the active database

getDatabaseState

public static int getDatabaseState(ContextHandle handle,
                                   java.lang.String appName,
                                   java.lang.String dbName,
                                   DatabaseState state)
wraps the core GetDatabaseState() API
Parameters:
context - - context handle to be used
appName - - String with the name of the application to retrieve information for.
dbName - - String with the name of the database to retrieve information for.
state - - a database state object to put the results in.

setDatabaseState

public static int setDatabaseState(ContextHandle handle,
                                   java.lang.String appName,
                                   java.lang.String dbName,
                                   DatabaseState state)
wraps the core SetDatabaseState() API
Parameters:
context - - context handle to be used
appName - - String with the name of the application to retrieve information for.
dbName - - String with the name of the database to retrieve information for.
state - - a database state object to put the results in.

getDatabaseStats

public static int getDatabaseStats(ContextHandle handle,
                                   java.lang.String appName,
                                   java.lang.String dbName,
                                   DatabaseStats stats,
                                   java.util.List dimensions)
wraps the core GetDatabaseStats() API
Parameters:
context - - context handle to be used
appName - - String with the name of the application to retrieve information for.
dbName - - String with the name of the database to retrieve information for.
filePath - - String witha database statistics object to put the results in.
dimensions - - a list to place dimensions statistics into.

getDatabaseStatus

public static int getDatabaseStatus(ContextHandle handle,
                                    java.lang.String appName,
                                    java.lang.String dbName,
                                    java.util.List statusList)
wraps the core getDatabaseStatus() API
Parameters:
context - - context handle to be used
appName - - Application name or NULL for all applications and databases that user has privilege to.
dbName - - Database name or NULL for all databases in the specified application that the user has privilege to. If appName is NULL, this field is ignored. statusList - Pointer to pointer to non-allocated database status list. Function allocates the memory.

getDatabaseInfo

public static int getDatabaseInfo(ContextHandle handle,
                                  java.lang.String appName,
                                  java.lang.String dbName,
                                  DatabaseProperties dbProps)
wraps the core GetDatabaseInfo() API
Parameters:
context - - context handle to be used
appName - - String with the name of the application to retrieve information for
dbName - - String with the name of the database to retrieve information for
dbInfo - - DatabaseInfo structure to place database info into
See Also:
com.hyperion.essbase.core.DatabaseInfo

listDbFiles

public static int listDbFiles(ContextHandle handle,
                              java.lang.String appName,
                              java.lang.String dbName,
                              short fileType,
                              java.util.List dbFileInfos)
wraps the core ListDbFiles() API
Parameters:
context - - context handle to be used
appName - - String with the name of the application to retrieve information for
dbName - - String with the name of the database to retrieve information for
fileType - - file type to retrieve information for: FILETYPE_INDEX FILETYPE_DATA FILETYPE_INDEX | FILETYPE_DATA.
dbFileInfos - - a list to place database file information into

setDefaultCalc

public static int setDefaultCalc(ContextHandle handle,
                                 java.lang.String calcScript)
wraps the core SetDefaultCalc() API
Parameters:
context - - context handle to be used
calcScript - - default calc script string

setDefaultCalcFile

public static int setDefaultCalcFile(ContextHandle destHandle,
                                     ContextHandle srcHandle,
                                     java.lang.String appName,
                                     java.lang.String dbName,
                                     java.lang.String fileName)
wraps the core SetDefaultCalcFile() API
Parameters:
destHandle - - context handle of target database on the server
srcHandle - - context handle context handle for calc script file location. The calc script file can reside on the client or on the same server as the target database.
appName - - application name for calc script file location
dbName - - database name for calc script file location
fileName - - name of default calc script file

getDefaultCalc

public static int getDefaultCalc(ContextHandle handle,
                                 java.lang.StringBuffer calcScript)
wraps the core GetDefaultCalc() API
Parameters:
context - - context handle to be used
calcScript - - default calc script string

getCalcList

public static int getCalcList(ContextHandle handle,
                              UserCalcList userCalc)
wraps the core GetCalcList() API
Parameters:
context - - context handle to be used
userCalc - - userCalc Object

setCalcList

public static int setCalcList(ContextHandle handle,
                              UserCalcList userCalc)
wraps the core SetCalcList() API
Parameters:
context - - context handle to be used
userCalc - - userCalc Object

getLicenseInfo

public static int getLicenseInfo(ContextHandle handle,
                                 LicenseInfo licenseInfo,
                                 java.lang.String serverName)
wraps the unpublished GetLicenseInfo() API
Parameters:
context - - context handle to be used
licenseInfo - - a structure to place license information into

getSMStats

public static int getSMStats(ContextHandle handle,
                             java.lang.String appName,
                             java.lang.String dbName,
                             TimeRecord resetTime,
                             java.util.ArrayList runTimeVals)
wraps the unpublished GetSMStats() API
Parameters:
content -
resetTime - - a structure to place reset time into

getLockInfo

public static int getLockInfo(ContextHandle handle,
                              java.lang.String appName,
                              java.lang.String dbName,
                              java.util.ArrayList lockArrayList)
wraps the core EssListLocks() API
Parameters:
context - - context handle to be used
appName - - application name
dbName - - database name
lockArrayList - - an arrayList of lockInfo objects

getOSResources

public static int getOSResources(ContextHandle handle,
                                 SystemInfo systemInfo)
wraps the unpublished GetOSResources API
Parameters:
context - - context handle to be used
systemInfo - - a structure to place system resources information into

getConfigValues

public static int getConfigValues(ContextHandle handle,
                                  GlobalInfo globalInfo)
wraps the unpublished GetConfigValues API
Parameters:
context - - context handle to be used
globalInfo - - a structure to place global configuration information into

getObject

public static int getObject(ContextHandle handle,
                            int objType,
                            java.lang.String appName,
                            java.lang.String dbName,
                            java.lang.String objName,
                            java.lang.String localName,
                            boolean lock)
wraps the core getObject() API
Parameters:
context - - context handle to be used
objType - - object type
appName - - name of the application the database is in
dbName - - name of the database the object is in
objName - - name of the object
localName - - name of the local object (perhaps a path)
lock - - Boolean to lock the object

deleteObject

public static int deleteObject(ContextHandle handle,
                               int objType,
                               java.lang.String appName,
                               java.lang.String dbName,
                               java.lang.String objName)
wraps the core deleteObject() API
Parameters:
context - - context handle to be used
objType - - object type
appName - - name of the application the database is in
dbName - - name of the database the object is in
objName - - name of the object

putObject

public static int putObject(ContextHandle handle,
                            int objType,
                            java.lang.String appName,
                            java.lang.String dbName,
                            java.lang.String objName,
                            java.lang.String localName,
                            boolean unlock)
wraps the core putObject() API
Parameters:
context - - context handle to be used
objType - - object type
appName - - name of the application the database is in
dbName - - name of the database the object is in
objName - - name of the object
localName - - name of the local object (perhaps a path)
unlock - - Boolean to unlock the object

listObjects

public static int listObjects(ContextHandle handle,
                              int objType,
                              java.lang.String appName,
                              java.lang.String dbName,
                              java.util.List names)
wraps the core ListObjects() API
Parameters:
context - - context handle to be used
objType - - object type
appName - - name of the application the database is in
dbName - - name of the database the object is in
names - - List object to be filled with object names

lockObject

public static int lockObject(ContextHandle handle,
                             int objType,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String name)
wraps the core LockObject() API
Parameters:
context - - context handle to be used
objType - - object type
appName - - name of the application the database is in
dbName - - name of the database the object is in
name - - name of the object to lock

unlockObject

public static int unlockObject(ContextHandle handle,
                               int objType,
                               java.lang.String appName,
                               java.lang.String dbName,
                               java.lang.String name)
wraps the core UnlockObject() API
Parameters:
context - - context handle to be used
objType - - object type
appName - - name of the application the database is in
dbName - - name of the database the object is in
name - - name of the object to lock

putOutlineObject

public static int putOutlineObject(ContextHandle handle,
                                   java.lang.String appName,
                                   java.lang.String dbName,
                                   java.lang.String localName,
                                   boolean unlock)
wrapper around a variety of APIs to handle uploading an outline Note: This in not appropriate here, but it is a quick method to get this done as a full fledged outline API will not be used anytime soon.
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database the object is in
name - - name of the object to lock

getLogFile

public static int getLogFile(ContextHandle handle,
                             java.lang.String appName,
                             long dateStamp,
                             java.lang.String localFile)
wraps the core GetLogFile() API
Parameters:
context - - context handle to be used
appName - - name of the Essbase application (null for server log)
dateStamp - - date in seconds from midnight 00:00:00 1/1/1970, date for starting entries, null for all entries
localFile - - name of a local file to copy the log to

getLogFileFromOffset

public static long getLogFileFromOffset(ContextHandle handle,
                                        java.lang.String appName,
                                        long offset,
                                        java.lang.String localFile)
wraps the core GetLogFile() API
Parameters:
context - - context handle to be used
appName - - name of the Essbase application (null for server log)
offset - - offset to read from the file
localFile - - name of a local file to copy the log to

calcScriptVerifyFile

public static int calcScriptVerifyFile(ContextHandle handle,
                                       java.lang.String appName,
                                       java.lang.String dbName,
                                       java.lang.String calcScript)
wraps the core CalcScriptVerify() API
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database the object is in
name - - name of the calcscript to verify

calcScriptVerify

public static int calcScriptVerify(ContextHandle handle,
                                   java.lang.String calcScript)
wraps the core CalcScriptVerify() API
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database the object is in
name - - name of the calcscript to verify

reportScriptVerifyFile

public static int reportScriptVerifyFile(ContextHandle handle,
                                         java.lang.String appName,
                                         java.lang.String dbName,
                                         java.lang.String reportScript)
wraps the core EssReport() API
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database the object is in
name - - name of the reportScript to verify

reportScriptVerify

public static int reportScriptVerify(ContextHandle handle,
                                     java.lang.String reportScript)
wraps the core EssReport() API
Parameters:
context - - context handle to be used
name - - name of the reportscript to verify

reportScriptExecuteFile

public static int reportScriptExecuteFile(ContextHandle handle,
                                          java.lang.String appName,
                                          java.lang.String dbName,
                                          java.lang.String reportScript)
wraps the core EssReport() API for execution
Parameters:
context - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database the object is in
name - - name of the reportScript to verify

reportScriptExecute

public static int reportScriptExecute(ContextHandle handle,
                                      java.lang.String reportScript)
wraps the core EssReport() API for execution
Parameters:
context - - context handle to be used
name - - name of the reportscript to verify

getOutputString

public static int getOutputString(ContextHandle handle,
                                  java.lang.StringBuffer output)
wraps the core EssGetString() API for retrieving report script output and EssQueryDatabaseMembers calls.
Parameters:
handle - - context handle to be used
output - - string to receive the output report script

getReport

public static int getReport(ContextHandle handle,
                            java.lang.Object output)
calls EssGetString() API till the entire report is fetched for retrieving report script output and EssQueryDatabaseMembers calls.
Parameters:
handle - - context handle to be used
output - - file to receive the output report script

logSize

public static int logSize(ContextHandle handle,
                          boolean isAppLog,
                          java.lang.String appName,
                          FileInfo fileInfo)
wraps the core LogSize() API
Parameters:
context - - context handle to be used
isAppLog - - true if getting size of an application log, false for a server log
appName - - name of the Essbase application (null for server log)
logSize - - size of the log

getInstanceHandle

public InstanceHandle getInstanceHandle()
returns the instance handle associated with this invocation of the Essbase API.

initialize

public boolean initialize(short maxHandles)
Sets up the EssCoreJni for usage.

release

public boolean release()
releases this instance of the EssCoreJni connection to Essbase.

setGroup

public static int setGroup(ContextHandle handle,
                           GroupProperties groupProp)
wraps the core SetGroup() API
Parameters:
context - - context handle to be used
groupProp - - object to set GroupProperties structure to

getGroup

public static int getGroup(ContextHandle handle,
                           java.lang.String groupName,
                           GroupProperties groupProp)
wraps the core GetGroup() API
Parameters:
context - - context handle to be used
groupName - - group name
groupProp - - object to receive GroupProperties structure

getGroupInfoEx

public static int getGroupInfoEx(ContextHandle handle,
                                 java.lang.String groupName,
                                 GroupProperties groupProp)
wraps the core GetGroup() API
Parameters:
context - - context handle to be used
groupName - - group name
groupProp - - object to receive GroupProperties structure

getGroupEx

public static int getGroupEx(EssSession session,
                             java.lang.String groupName,
                             GroupProperties groupProp)

listUsers

public static int listUsers(ContextHandle handle,
                            java.lang.String appName,
                            java.lang.String dbName,
                            int count,
                            java.util.List userList)
wraps the core ListUsers() API
Parameters:
context - - context handle to be used
appName - - name of application to retrieve user names for.
dbName - - name of database to retrieve user names for.
count - - returns the number of structures returned in the userList
userList - - List of returned UserProperties objects

listUsersInfoEx

public static int listUsersInfoEx(ContextHandle handle,
                                  java.lang.String appName,
                                  java.lang.String dbName,
                                  int count,
                                  java.util.List userList,
                                  boolean skipAccessType)
wraps the core ListUsersInfoEx() API
Parameters:
context - - context handle to be used
appName - - name of application to retrieve user names for.
dbName - - name of database to retrieve user names for.
count - - returns the number of structures returned in the userList
userList - - List of returned UserProperties objects
skipAccessType - - skip EssGetUserType call

listUsersEx

public static int listUsersEx(EssSession session,
                              java.lang.String appName,
                              java.lang.String dbName,
                              int count,
                              java.util.List userList,
                              boolean skipAccessType)

listUsersFile

public static int listUsersFile(ContextHandle handle,
                                java.lang.String appName,
                                java.lang.String dbName,
                                int count,
                                java.lang.String userList)
wraps the core ListUsers() API
Parameters:
context - - context handle to be used
appName - - name of application to retrieve user names for.
dbName - - name of database to retrieve user names for.
count - - returns the number of structures returned in the userList
userList - - List of returned UserProperties objects

listUsersFileEx

public static int listUsersFileEx(ContextHandle handle,
                                  java.lang.String appName,
                                  java.lang.String dbName,
                                  int count,
                                  java.lang.String userList,
                                  boolean skipAccessType)
wraps the core ListUsers() API
Parameters:
handle -
appName -
dbName -
count -
userList -
skipAccessType -
Returns:

listUsersInfoFileEx

public static int listUsersInfoFileEx(ContextHandle handle,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      int count,
                                      java.lang.String userList,
                                      boolean skipAccessType)
wraps the core ListUsersInfoEx() API
Parameters:
context - - context handle to be used
appName - - name of application to retrieve user names for.
dbName - - name of database to retrieve user names for.
count - - returns the number of structures returned in the userList
userList - - List of returned UserProperties objects

listUsersFileEx

public static int listUsersFileEx(EssSession session,
                                  java.lang.String appName,
                                  java.lang.String dbName,
                                  int count,
                                  java.lang.String userList,
                                  boolean skipAccessType)

listGroups

public static int listGroups(ContextHandle handle,
                             java.lang.String appName,
                             java.lang.String dbName,
                             int count,
                             java.util.List userList)
wraps the core ListGroups() API
Parameters:
context - - context handle to be used
appName - - name of application to retrieve user names for.
dbName - - name of database to retrieve user names for.
count - - returns the number of structures returned in the userList
userList - - List of returned GroupProperties objects

listGroupsInfoEx

public static int listGroupsInfoEx(ContextHandle handle,
                                   java.lang.String appName,
                                   java.lang.String dbName,
                                   int count,
                                   java.util.List userList)
wraps the core ListGroupsInfoEx() API
Parameters:
context - - context handle to be used
appName - - name of application to retrieve user names for.
dbName - - name of database to retrieve user names for.
count - - returns the number of structures returned in the userList
userList - - List of returned GroupProperties objects

listGroupsEx

public static int listGroupsEx(EssSession session,
                               java.lang.String appName,
                               java.lang.String dbName,
                               int count,
                               java.util.List userList)

setUser

public static int setUser(ContextHandle handle,
                          UsrGrpProperties userProps)
wraps the core SetUser() API
Parameters:
context - - context handle to be used
userProps - - object to set UserProperties structure to

getUser

public static int getUser(ContextHandle handle,
                          java.lang.String userName,
                          UsrGrpProperties userProps)
wraps the core GetUser() API
Parameters:
context - - context handle to be used
userName - - user name
userProps - - object to receive UserProperties structure

getUserEx

public static int getUserEx(EssSession session,
                            java.lang.String userName,
                            UserProperties userProps)

setPassword

public static int setPassword(ContextHandle handle,
                              java.lang.String userName,
                              java.lang.String password)
wraps the core SetPassword() API
Parameters:
context - - context handle to be used
userName - - user name
password - - password to set to

setGroupList

public static int setGroupList(ContextHandle handle,
                               java.lang.String groupName,
                               java.util.List userList)
wraps the core SetGroupList() API
Parameters:
context - - context handle to be used
userName - - group name
userList - - list of user names to set to the group

setGroupListEx

public static int setGroupListEx(ContextHandle handle,
                                 java.lang.String groupName,
                                 java.util.List userList,
                                 boolean usingIdentity,
                                 boolean isUser)

setGroupListEx

public static int setGroupListEx(EssSession session,
                                 java.lang.String groupName,
                                 java.util.List userList,
                                 boolean isUser)

getGroupList

public static int getGroupList(ContextHandle handle,
                               java.lang.String groupName,
                               java.util.List userList)
wraps the core GetGroupList() API
Parameters:
context - - context handle to be used
userName - - group name
userList - - list of user names retrieve from the the group

getGroupListEx

public static int getGroupListEx(ContextHandle handle,
                                 java.lang.String groupName,
                                 java.util.List userList,
                                 boolean usingIdentity,
                                 boolean isUser)

getGroupListEx

public static int getGroupListEx(EssSession session,
                                 java.lang.String groupName,
                                 java.util.List userList,
                                 boolean isUser)

setApplicationAccess

public static int setApplicationAccess(ContextHandle handle,
                                       java.util.ArrayList userAppList)
wraps the core SetApplicationAccess() API
Parameters:
context - - context handle to be used
userAppList - - list of user application structures

setApplicationAccessEx

public static int setApplicationAccessEx(ContextHandle handle,
                                         java.util.ArrayList userAppList)

setApplicationAccessEx

public static int setApplicationAccessEx(EssSession session,
                                         java.util.ArrayList userAppList)

getApplicationAccess

public static int getApplicationAccess(ContextHandle handle,
                                       java.lang.String userName,
                                       java.lang.String appName,
                                       java.util.ArrayList userAppList)
wraps the core GetApplicationAccess() API
Parameters:
context - - context handle to be used
userName - - user name
appName - - application name
userAppList - - list of user application structures

getApplicationAccessEx

public static int getApplicationAccessEx(ContextHandle handle,
                                         java.lang.String userName,
                                         java.lang.String appName,
                                         java.util.ArrayList userAppList,
                                         boolean usingIdentity,
                                         boolean isUser)

getApplicationAccessEx

public static int getApplicationAccessEx(EssSession session,
                                         java.lang.String userName,
                                         java.lang.String appName,
                                         java.util.ArrayList userAppList,
                                         boolean isUser)

setDatabaseAccess

public static int setDatabaseAccess(ContextHandle handle,
                                    java.util.ArrayList userDbList)
wraps the core SetDatabaseAccess() API
Parameters:
context - - context handle to be used
userDbList - - list of user application structures

setDatabaseAccessEx

public static int setDatabaseAccessEx(ContextHandle handle,
                                      java.util.ArrayList userDbList)

setDatabaseAccessEx

public static int setDatabaseAccessEx(EssSession session,
                                      java.util.ArrayList userDbList)

getDatabaseAccess

public static int getDatabaseAccess(ContextHandle handle,
                                    java.lang.String userName,
                                    java.lang.String appName,
                                    java.lang.String dbName,
                                    java.util.ArrayList userDbList)
wraps the core GetDatabaseAccess() API
Parameters:
context - - context handle to be used
userName - - user name
appName - - application name
dbName - - database name
userDbList - - list of user application structures

getDatabaseAccessEx

public static int getDatabaseAccessEx(ContextHandle handle,
                                      java.lang.String userName,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      java.util.ArrayList userDbList,
                                      boolean usingIdentity,
                                      boolean isUser)

getDatabaseAccessEx

public static int getDatabaseAccessEx(EssSession session,
                                      java.lang.String userName,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      java.util.ArrayList userDbList,
                                      boolean isUser)

setFilterList

public static int setFilterList(ContextHandle handle,
                                java.lang.String appName,
                                java.lang.String dbName,
                                java.lang.String filterName,
                                java.util.ArrayList userList)
wraps the core SetFilterList() API
Parameters:
context - - context handle to be used
appName - - application name
dbName - - database name
filterName - - filter name
userList - - list of user to be assigned to a filter

getFilterList

public static int getFilterList(ContextHandle handle,
                                java.lang.String appName,
                                java.lang.String dbName,
                                java.lang.String filterName,
                                java.util.ArrayList userList)
wraps the core GetFilterList() API
Parameters:
context - - context handle to be used
appName - - application name
dbName - - database name
filterName - - filter name
userList - - list of user who are assigned to a filter

addToGroup

public static int addToGroup(ContextHandle handle,
                             java.lang.String groupname,
                             java.lang.String username)
wraps the core AddToGroup() API
Parameters:
context - - context handle to be used
groupname - - group name
username - - user name

deleteFromGroup

public static int deleteFromGroup(ContextHandle handle,
                                  java.lang.String groupname,
                                  java.lang.String username)
wraps the core DeleteFromGroup() API
Parameters:
context - - context handle to be used
groupname - - group name
username - - user name

getUserKey

public static int getUserKey(ContextHandle handle,
                             java.lang.String username,
                             UserKey userKey)
wraps the unpublished GetUserKey() API
Parameters:
context - - context handle to be used
username - - username
key - - key of the user

createUserKey

public static int createUserKey(ContextHandle handle,
                                java.lang.String username,
                                UserKey userKey)
wraps the unpublished CreateUserWithKey() API
Parameters:
context - - context handle to be used
key - - key to create the user with

setUserKey

public static int setUserKey(ContextHandle handle,
                             java.lang.String username,
                             UserKey userKey)
wraps the unpublished SetUserKey() API
Parameters:
context - - context handle to be used
key - - key to create the user with

renameObject

public static int renameObject(ContextHandle handle,
                               int objType,
                               java.lang.String appName,
                               java.lang.String dbName,
                               java.lang.String oldName,
                               java.lang.String newName)
wraps the core renameObject() API
Parameters:
context - - context handle to be used
objType - - object type
appName - - name of the application the database is in
dbName - - name of the database the object is in
oldName - - old name of the object
newName - - new name of the object

copyObject

public static int copyObject(ContextHandle handle,
                             int objType,
                             java.lang.String srcApp,
                             java.lang.String destApp,
                             java.lang.String srcDb,
                             java.lang.String destDb,
                             java.lang.String srcObj,
                             java.lang.String destObj)
wraps the core copyObject() API
Parameters:
context - - context handle to be used
objType - - object type
srcApp - - name of the application the database is in
destApp - - name of the dest app
srcDb - - name of the database the object is in
destDb - - name of the dest db
srcObj - - name of the object
destObj - - name of the dest obj

getExternalUser

public static int getExternalUser(ContextHandle handle,
                                  java.lang.String userName,
                                  UserProperties userProp)
wraps the core getExternalUser() API
Parameters:
context - - context handle to be used
userName - - name of the external user to get user information
extUserInfo - - structure to retrieve external user information

setExternalUser

public static int setExternalUser(ContextHandle handle,
                                  short type,
                                  java.lang.String userName,
                                  java.lang.String password,
                                  java.lang.String protocol,
                                  java.lang.String connParameter,
                                  short domainAccess)
wraps the core setExternalUser() API
Parameters:
context - - context handle to be used
userName - - name of the external user
password - - password of the external user
protocol - - name of the external authentication protocol
connParameter - - the external connection parameter string

getUserInfoEx

public static int getUserInfoEx(ContextHandle handle,
                                java.lang.String userName,
                                UserProperties userProp)
wraps the core getUserUserInfoEx() API
Parameters:
context - - context handle to be used
userName - - name of the external user to get user information
extUserInfo - - structure to retrieve external user information

createExternalUser

public static int createExternalUser(ContextHandle handle,
                                     java.lang.String userName,
                                     java.lang.String password,
                                     java.lang.String protocol,
                                     java.lang.String connParameter,
                                     short domainAccess)
wraps the createExternalUser() API
Parameters:
context - - context handle to be used
userName - - name of the external user
password - - password of the external user
protcol - - name of the external authentication protocol
connParameter - - the external connection parameter string

getAllowedStorageTypes

public static int getAllowedStorageTypes(ContextHandle handle,
                                         ServerStorageTypesInfo types)
wraps the EssGetAllowedStorageTypes() API
Parameters:
context - - context handle to be used
allowedTypes - - object for returning the allowed storage type information

lroListObjects

public static int lroListObjects(ContextHandle handle,
                                 java.lang.String userName,
                                 long date,
                                 java.util.ArrayList lroList)
wraps the EssLROListObjects() API
Parameters:
handle - - context handle to be used
userName - - criteria for retrieving LROs created by a user, null for all users
date - - criteria for retrieving LROs created on or after a certain date specified in seconds from midnight, 1/1/1970, GMT, 0 for all dates
lros - - array to receive the LRO information

lroGetObject

public static int lroGetObject(ContextHandle handle,
                               LroHandle lHandle,
                               java.lang.String targetFile,
                               short option,
                               LroInfo lro)
wraps the EssLROGetObject() API
Parameters:
handle - - context handle to be used
lhandle - - handle for the LRO being accessed
targetFile - - target file location for a file LRO
option - - specifies whether to retrieve the LRO object, LRO catalog entry, or both (see documentation for EssLROGetObject() for details)
lro - - object to contain the LRO catalog information

lroUpdateObject

public static int lroUpdateObject(ContextHandle handle,
                                  LroHandle lHandle,
                                  short option,
                                  LroInfo lro)
wraps the EssLROUpdateObject() API
Parameters:
handle - - context handle to be used
lhandle - - handle for the LRO being accessed
option - - specifies whether to store the LRO object, LRO catalog entry, or both (see documentation for EssLROGetObject() for details)
lro - - object to contain the LRO catalog information

lroDeleteObject

public static int lroDeleteObject(ContextHandle handle,
                                  LroHandle lHandle)
wraps the EssLRODeleteObject() API
Parameters:
handle - - context handle to be used
lhandle - - handle for the LRO being deleted

lroPurgeObjects

public static int lroPurgeObjects(ContextHandle handle,
                                  java.lang.String userName,
                                  long date)
wraps the EssLROPurgeObjects() API
Parameters:
handle - - context handle to be used
userName - - criteria for deleting LROs created by a user, null for all users
date - - criteria for deleting LROs created on or after a certain date specified in seconds from midnight, 1/1/1970, GMT, 0 for all dates

verifyFilter

public static int verifyFilter(ContextHandle handle,
                               java.lang.String appName,
                               java.lang.String dbName)
wraps the EssVerifyFilter () API Follow a call to this function with subsequent calls to verifyFilterRows()
Parameters:
handle - - context handle to be used
appName - - name of the application the database is in
dbName - - name of the database the object is in

verifyFilterRows

public static int verifyFilterRows(ContextHandle handle,
                                   java.lang.String rowText)
wraps the EssVerifyFilterRows() API Call verifyFilterRows() for each row of the filter to be verified. Call this function with a null to end the verification session.
Parameters:
handle - - context handle to be used
rowText - - the member specification information for a row (does not include the access information [None/Read/Write])

renameFilter

public static int renameFilter(ContextHandle handle,
                               java.lang.String appName,
                               java.lang.String dbName,
                               java.lang.String oldName,
                               java.lang.String newName)
wraps the core RenameFilter() API
Parameters:
context - - context handle to be used
appName - - name of the application
dbName - - name of the database
oldName - - existing name of filter
newName - - updated name of filter

listObjectsInfo

public static int listObjectsInfo(ContextHandle handle,
                                  int objType,
                                  java.lang.String appName,
                                  java.lang.String dbName,
                                  java.util.ArrayList objList)
wraps the EssListObjects() API Returns a list of Essbase file object information.
Parameters:
handle - - context handle to be used
objType - - the type of file object to be returned
appName - - name of the application the database is in
dbName - - name of the database the object is in
objList - - returned list of objects

getObjectInfo

public static int getObjectInfo(ContextHandle handle,
                                int objType,
                                java.lang.String appName,
                                java.lang.String dbName,
                                java.lang.String objName,
                                NamedObjectInfo objInfo)
wraps the EssGetObjectInfo() API Gets information about a specified Essbase file object.
Parameters:
handle - - context handle to be used
objType - - the type of file object to be returned
appName - - name of the application the database is in
dbName - - name of the database the object is in
objName - - name of the database the object is in
objInfo - - returned info for the object

verifyFormula

public static int verifyFormula(ContextHandle context,
                                java.lang.String formula)
wraps the EssVerifyFormula() API Verifies the syntax of a formula
Parameters:
handle - - context handle to be used
formula - - the formula to be verified

createLocalContext

public static int createLocalContext(InstanceHandle instance,
                                     ContextHandle context)
creates a local API context for use in local API operations

deleteLocalContext

public static int deleteLocalContext(ContextHandle context)

hasAppManOption

public static boolean hasAppManOption(ContextHandle handle)
wraps for private API eSSGetClientSettings Checks to see if the application manager is allowed to run
Parameters:
handle - - context handle to be used

isValidContext

public static boolean isValidContext(ContextHandle handle)
wraps for public API EssValidateHCtx() Checks to see if the Essbase context handle is valid
Parameters:
handle - - the Essbase API context handle to validate

getServerLocaleString

public static int getServerLocaleString(ContextHandle handle,
                                        java.lang.StringBuffer localeBuffer)

isSubsetCodepage

public static boolean isSubsetCodepage(ContextHandle handle,
                                       java.lang.String locale1,
                                       java.lang.String locale2)
Is codepage for locale 1 a subset of locale 2
Parameters:
handle - - context handle to be used
locale1 - - first locale
locale2 - - second locale
Returns:
true if locale 1 is a subset of locale 1

shutdownServer

public static int shutdownServer(InstanceHandle handle,
                                 java.lang.String server,
                                 java.lang.String user,
                                 java.lang.String password)

isDatabaseLocked

public static boolean isDatabaseLocked(ContextHandle handle,
                                       java.lang.String appName,
                                       java.lang.String dbName)

getSpoolFile

public static int getSpoolFile(ContextHandle handle,
                               java.lang.String appName,
                               java.lang.String dbName,
                               java.lang.String spoolName,
                               java.lang.String targetFile)
wraps the EssGetSpoolFile() API
Parameters:
handle - - context handle to be used
appname - - the application name
dbname - - the database name
spool - name
targetFile - - target file location to copy the spool file into.

registerEventServer

public static int registerEventServer(ContextHandle handle,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      java.lang.String url,
                                      java.lang.String user,
                                      java.lang.String password,
                                      boolean registerServer)

updateEventServerFile

public static int updateEventServerFile(ContextHandle handle,
                                        java.lang.String url,
                                        java.lang.String user,
                                        java.lang.String password)

setUserType

public static int setUserType(ContextHandle handle,
                              java.lang.String userName,
                              short domainAccess)

getApplicationFrontEndAppType

public static int getApplicationFrontEndAppType(ContextHandle handle,
                                                java.lang.String appName,
                                                AppFrontEndType frontEndAppType)

listUserGroupsForAppInHSSMode

public static int listUserGroupsForAppInHSSMode(ContextHandle handle,
                                                java.lang.String appName,
                                                java.util.List userList,
                                                java.util.List grpList)

listUserGroupsForAppInHSSModeEx

public static int listUserGroupsForAppInHSSModeEx(ContextHandle handle,
                                                  java.lang.String appName,
                                                  java.util.List userList,
                                                  java.util.List grpList,
                                                  boolean usingIdentity)

listUserGroupsForAppInHSSModeEx

public static int listUserGroupsForAppInHSSModeEx(EssSession session,
                                                  java.lang.String appName,
                                                  java.util.List userList,
                                                  java.util.List grpList)

getApplicationID

public static int getApplicationID(ContextHandle handle,
                                   java.lang.String appName,
                                   java.lang.StringBuffer appID)

setFiltersInCASMode

public static int setFiltersInCASMode(ContextHandle handle,
                                      java.util.ArrayList userDbList)
wraps the core SetDatabaseAccess() API
Parameters:
context - - context handle to be used
userDbList - - list of user application structures

main

public static void main(java.lang.String[] args)
driver for independently testing EssCoreJni API calls

finalize

protected void finalize()
                 throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.