Skip navigation links

com.essbase.eas.essbase.server
Class ApplicationPrimitives

java.lang.Object
com.essbase.eas.essbase.server.ApplicationPrimitives

public final class ApplicationPrimitives

extends java.lang.Object

This class provides the primitive operations for an Essbase Application object. In the current implementation, no instances of this class should ever be instantiated.

Note: When passing commands to Maxl, we have enclosed all application names in single quote marks. This is because Maxl doesn't understand that application names can start with numeric digits.

Methods that need to be implemented

1. getProperties()
2. setProperties()
3. sendInfo()

Version:

1.01, 05/31/2000 1.1.0, 08/04/2000 Upgraded to PW Framework 0.9

Author:

Hank Cox

See Also:

EssSession, EssSessionMessage

Method Summary

static boolean	copy(ISession session, java.lang.String destApp, java.lang.String srcApp) copies an application.
static boolean	copy(ISession session, java.lang.String destApp, java.lang.String srcApp, java.lang.String comment)
static boolean	copyAccess(EssSession session, java.lang.String destApp, java.lang.String srcApp) copies an application access
static boolean	create(EssSession session, java.lang.String newName, boolean replace, short storageType) creates an application with a specified storage type
static boolean	create(ISession session, java.lang.String newName, boolean unicode, boolean replace) Eventually should be abletemporary wrapper method until we fix the other references to this signature in copy operation processing).
static boolean	create(ISession session, java.lang.String newName, boolean unicode, java.lang.String comment, boolean replace)
static boolean	create(ISession session, java.lang.String newName, boolean unicode, java.lang.String comment, boolean replace, short appType) creates an application.
static boolean	delete(ISession session, java.lang.String appName) deletes an application.
static boolean	delete(ISession session, java.lang.String appName, short appType) deletes an application.
static void	enableUnicodeMode(ISession session, java.lang.String appName, java.util.List errors)
static java.lang.String	getApplicationID(EssSession session, java.lang.String appName)
static short	getApplicationType(ISession session, java.lang.String appName) getApplicationType returns the type of application -- Aggregate Storage versus Block Storage
static short	getAppType(ISession session, java.lang.String appName)
static boolean	getASOCacheLimit(ISession session, java.lang.String appName, ApplicationProperties appProps)
static java.lang.Short	getFrontEndAppType(EssSession session, java.lang.String appName)
static java.util.List	getList(EssSession session) Creates a list of applications that belong to a specific server.
static ApplicationProperties	getProperties(ISession session, java.lang.String appName) Retrieves the properties for a set of applications.
static short	getStatus(EssSession session, java.lang.String appName)
static TableSpaceInfo	getTableSpaceInfo(ISession session, java.lang.String appName, java.lang.String tbName, short appStatus)
static java.util.List	getUserGroupList(EssSession session, java.lang.String appName) Gets the users/groups list that have access to this Application
static boolean	hasApplication(ISession session, java.lang.String appName)
static boolean	rename(ISession session, java.lang.String newName, java.lang.String oldName) renames an application.
static boolean	reRegisterApplication(EssSession session, java.lang.String appName) reRegister an application with Shared Services
static java.util.List	setProperties(ISession session, java.lang.String appName, ApplicationProperties properties)
static boolean	setTableSpaceInfo(ISession session, java.lang.String appName, TableSpaceCommand tbCommand)
static boolean	start(ISession session, java.lang.String appName) starts an application.
static boolean	start(ISession session, java.lang.String appName, short appType) starts an application.
static boolean	stop(ISession session, java.lang.String appName) stops an application.
static boolean	stop(ISession session, java.lang.String appName, short appType) stops an application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getList

public static java.util.List getList(EssSession session)

Creates a list of applications that belong to a specific server.

Parameters:

session - object for this Essbase session.

Returns:

a list collection containing strings with the application names.

hasApplication

public static boolean hasApplication(ISession session,
                                     java.lang.String appName)

copy

public static boolean copy(ISession session,
                           java.lang.String destApp,
                           java.lang.String srcApp)

copies an application.

Parameters:

session - - session object

destApp - - application name for the copy.

srcApp - - application to be copied.

Returns:

true if the application is successfully copied. What do we do about messages if the call fails?

copy

public static boolean copy(ISession session,
                           java.lang.String destApp,
                           java.lang.String srcApp,
                           java.lang.String comment)

create

public static boolean create(ISession session,
                             java.lang.String newName,
                             boolean unicode,
                             java.lang.String comment,
                             boolean replace,
                             short appType)

creates an application.

Parameters:

session - - session object for this command.

newName - - name for the created application.

Returns:

true if the creation succeeds.What do we do about messages if the call fails?

copyAccess

public static boolean copyAccess(EssSession session,
                                 java.lang.String destApp,
                                 java.lang.String srcApp)

copies an application access

Parameters:

session - - session object

destApp - - application name for the copy.

srcApp - - application to be copied.

Returns:

true if the application is successfully copied. What do we do about messages if the call fails?

rename

public static boolean rename(ISession session,
                             java.lang.String newName,
                             java.lang.String oldName)

renames an application.

Parameters:

session - - session object for this command.

newName - - new name for this application.

oldName - - old name for this application.

Returns:

true if the rename succeeds. What do we do about messages if the call fails?

create

public static boolean create(ISession session,
                             java.lang.String newName,
                             boolean unicode,
                             boolean replace)

Eventually should be abletemporary wrapper method until we fix the other references to this signature in copy operation processing). At that point we can get rid of it.

create

public static boolean create(ISession session,
                             java.lang.String newName,
                             boolean unicode,
                             java.lang.String comment,
                             boolean replace)

create

public static boolean create(EssSession session,
                             java.lang.String newName,
                             boolean replace,
                             short storageType)

creates an application with a specified storage type

Parameters:

session - - session object for this command.

newName - - name for the created application.

storageType - - storage type for the application (see constants in ServerStorageTypes.java for options)

Returns:

true if the creation succeeds. SG: Feedback from Vaishnavi: StorageTyped Applications are not being supported Eventually this API should go away,.

delete

public static boolean delete(ISession session,
                             java.lang.String appName)

deletes an application.

Parameters:

session - - session object for this command.

appName - - name of application to be deleted.

delete

public static boolean delete(ISession session,
                             java.lang.String appName,
                             short appType)

deletes an application.

Parameters:

session - - session object for this command.

appName - - name of application to be deleted.

appType - - type of application to be deleted.

Returns:

true if the delete succeeds. What do we do about messages if the call fails?

start

public static boolean start(ISession session,
                            java.lang.String appName)

starts an application.

Parameters:

session - - session object for this command.

appName - - name of application to start.

Returns:

true if the application is started.

start

public static boolean start(ISession session,
                            java.lang.String appName,
                            short appType)

starts an application.

Parameters:

session - - session object for this command.

appName - - name of application to start.

appType - - type of application to start.

Returns:

true if the application is started. What do we do about messages if the call fails?

stop

public static boolean stop(ISession session,
                           java.lang.String appName)

stops an application. This API should get removed soon as part of cleanup -- once copy operation as well as stop (single application) have been completed.

stop

public static boolean stop(ISession session,
                           java.lang.String appName,
                           short appType)

stops an application.

Parameters:

session - - session object for this command.

appName - - name of application to stop.

appType - - type of application to stop.

Returns:

true if the application is stopped. What do we do about messages if the call fails?

getProperties

public static ApplicationProperties getProperties(ISession session,
                                                  java.lang.String appName)

Retrieves the properties for a set of applications. Instantiates an Application object for each row returned by MaxL.

Parameters:

session - - session object for this command.

appNames - - array of application names.

Returns:

List containing Application objects.

getASOCacheLimit

public static boolean getASOCacheLimit(ISession session,
                                       java.lang.String appName,
                                       ApplicationProperties appProps)

enableUnicodeMode

public static void enableUnicodeMode(ISession session,
                                     java.lang.String appName,
                                     java.util.List errors)

setProperties

public static java.util.List setProperties(ISession session,
                                           java.lang.String appName,
                                           ApplicationProperties properties)

getUserGroupList

public static java.util.List getUserGroupList(EssSession session,
                                              java.lang.String appName)

Gets the users/groups list that have access to this Application

Parameters:

session - - session object for this command.

appName - - name of application for which to retrieve the list.

Returns:

list of the users/groups.

getAppType

public static short getAppType(ISession session,
                               java.lang.String appName)

Parameters:

session - - session object for this command.

appName - - application name

Returns:

boolean : true if app is unicode false if app is non unicode

getApplicationType

public static short getApplicationType(ISession session,
                                       java.lang.String appName)

getApplicationType returns the type of application -- Aggregate Storage versus Block Storage

Parameters:

session -

appName -

getTableSpaceInfo

public static TableSpaceInfo getTableSpaceInfo(ISession session,
                                               java.lang.String appName,
                                               java.lang.String tbName,
                                               short appStatus)

Parameters:

session - - session object for this command.

appName - - application name.

tbName - -- if null, or empty string or "*", all tablespaces for the application

Returns:

information about TableSpace in TableSpaceInfo class object.

setTableSpaceInfo

public static boolean setTableSpaceInfo(ISession session,
                                        java.lang.String appName,
                                        TableSpaceCommand tbCommand)

Parameters:

session - - session object for this command.

appName - - application name.

tbName - -- if null, or empty string or "*", all tablespaces for the application

Returns:

information about TableSpace in TableSpaceInfo class object.

getStatus

public static short getStatus(EssSession session,
                              java.lang.String appName)

getFrontEndAppType

public static java.lang.Short getFrontEndAppType(EssSession session,
                                                 java.lang.String appName)

reRegisterApplication

public static boolean reRegisterApplication(EssSession session,
                                            java.lang.String appName)

reRegister an application with Shared Services

Parameters:

session - - session object for this command.

appName - - name of application to start.

Returns:

true if successful

Since:

9.3.0

getApplicationID

public static java.lang.String getApplicationID(EssSession session,
                                                java.lang.String appName)

Skip navigation links