Skip navigation links

com.essbase.eas.essbase.defs
Interface Server

All Known Implementing Classes:

DefaultServer, FactoryServer

public interface Server

Defines a generic interface for Essbase servers. This interface should be useable in both server and client side servers.

Version:

1.00, 09/13/2000

Author:

Hank Cox

See Also:

DefaultServer

Method Summary

void	addApplication(Application value) adds an application to this server's collection.
void	addApplications(Application[] values) return a list of duplicates
void	addFunction(Function value) adds a Function to this server's collection.
void	addGroup(Group value) adds an Group to this server's collection.
void	addGroup(Group value, boolean replace) adds a group to this server's collection.
void	addLicense(java.lang.String key)
void	addMacro(Macro value) adds a Macro to this server's collection.
void	addServerListener(ServerListener l) adds a listener for events on a server.
void	addUser(User value) adds an user to this server's collection.
void	addUser(User value, boolean replace) adds a user to this server's collection.
void	addUsers(User[] values) return a list of duplicates
void	addVariable(Variable value) adds a Variable to this db's collection.
void	addVariableForServer(Variable value)
void	applicationRenamed(java.lang.String oldname, java.lang.String newname, java.lang.Object application)
void	decFunctionsAccess() decrements the functions list user access.
void	decGroupsAccess() decrements the groups list user access.
void	decMacrosAccess() decrements the macros list user access.
void	decUsersAccess() decrements the users list user access.
void	decVariablesAccess() decrements the variables list user access.
Application	getApplication(java.lang.String name) retrieves a specific application
int	getApplicationIndex(Application app)
int	getApplicationIndex(java.lang.String name)
Application[]	getApplications() retrieves this server's collection of applications.
java.lang.String	getArborPath()
java.lang.String	getCluster()
Function	getFunction(java.lang.String name) retrieves a specific Function
Function	getFunction(java.lang.String appName, java.lang.String name) retrieves a specific Function
Function[]	getFunctions() retrieves this server's collection of Functions.
Function[]	getFunctionsByAppName(java.lang.String appName) retrieves this server's collection of Functions.
Group	getGroup(java.lang.String groupName)
Group[]	getGroups() retrieves this server's collection of Groups.
Application[]	getLoadedApplications() retrieves this server's currently loaded applications.
Macro	getMacro(java.lang.String name) retrieves a specific Macro from Server
Macro	getMacro(java.lang.String appName, java.lang.String name) retrieves a specific Macro with app name
Macro[]	getMacros() retrieves this server's collection of Macros.
Macro[]	getMacrosByAppName(java.lang.String appName) retrieves this server's collection of Macros for an application.
java.lang.String	getName() returns the name associated with this server.
ServerPlatform	getPlatform() retrieves this server's platform information
ServerProperties	getProperties() retrieves this server's property information
Version	getServerVersion()
User	getSessionUser() gets the logged in user associated with this server.
User	getUser(java.lang.String userName)
User	getUser(java.lang.String userName, java.lang.String providerName)
User[]	getUsers() retrieves this server's collection of users.
Variable	getVariable(java.lang.String name) Returns the Variable associated with the name from the collection of variables
Variable	getVariableByNames(java.lang.String appName, java.lang.String dbName, java.lang.String value) Returns the Variable associated with the appname, dbname, name from the collection of variables
Variable[]	getVariables() retrieves this server's collection of variables.
boolean	hasLicense(java.lang.String key) Returns true if the server has a license for a module rep by the key
void	incFunctionsAccess() increments the functions list user access.
void	incGroupsAccess() increments the groups list user access.
void	incMacrosAccess() increments the macros list user access.
void	incUsersAccess() increments the users list user access.
void	incVariablesAccess() increments the variables list access.
boolean	isConnected() is the server connected
void	isDisconnecting() Inform server is disconnecting
java.lang.Boolean	isEssbaseCasEnabled()
java.lang.Boolean	isEssbaseCssEnabled()
boolean	isRunning() Inform server is running
boolean	isRunningSet() Has the server running status been set.
boolean	isSessionUserName(java.lang.String name, java.lang.String providerName)
void	removeAllApplications() removes all applications from this server's collection of applications.
void	removeAllFunctions()
void	removeAllMacros()
void	removeAllVariables()
void	removeApplication(Application value) removes an application from this server's collection of applications.
void	removeFunction(Function value) removes a Function from this server's collection of Groups.
void	removeGroup(Group value) removes an Group from this server's collection of Groups.
void	removeMacro(Macro value) removes a Macro from this server's collection of Groups.
void	removeServerListener(ServerListener l) removes an event listener from a server
void	removeUser(User value) removes an User from this server's collection of Users.
void	removeVariable(Variable value) removes a Variable from this db's collection of Variables.
void	resetServer() resets the server usually after a disconnect, so that all lists are forced to be refreshed.
void	setArborPath(java.lang.String arborpath)
void	setCluster(java.lang.String string)
void	setConnected(boolean value) Set the server's connection state
void	setEssbaseCasEnabled(boolean enabled)
void	setEssbaseCssEnabled(boolean enabled)
void	setName(java.lang.String value) sets the name associated with this server.
void	setPlatform(ServerPlatform serverPlat) sets this server's platform information
void	setProperties(ServerProperties serverProps) sets this server's property information
void	setRunning(boolean value) Set the running status of the server
void	setServerVersion(Version version)
void	setSessionUser(User user) sets the logged in user associated with this server.
void	userModifed(User user)
void	userRenamed(java.lang.String oldname, java.lang.String newname, java.lang.Object user)

Method Detail

getName

java.lang.String getName()

returns the name associated with this server.

setName

void setName(java.lang.String value)

sets the name associated with this server.

addApplication

void addApplication(Application value)
                    throws DuplicateApplicationException

adds an application to this server's collection.

Throws:

DuplicateApplicationException

addApplications

void addApplications(Application[] values)

return a list of duplicates

Parameters:

values -

applicationRenamed

void applicationRenamed(java.lang.String oldname,
                        java.lang.String newname,
                        java.lang.Object application)

addUser

void addUser(User value,
             boolean replace)
             throws DuplicateUserException

adds a user to this server's collection.

Throws:

DuplicateUserException

addUser

void addUser(User value)
             throws DuplicateUserException

adds an user to this server's collection.

Throws:

DuplicateUserException

userRenamed

void userRenamed(java.lang.String oldname,
                 java.lang.String newname,
                 java.lang.Object user)

userModifed

void userModifed(User user)

addUsers

void addUsers(User[] values)

return a list of duplicates

Parameters:

values -

addGroup

void addGroup(Group value,
              boolean replace)
              throws DuplicateGroupException

adds a group to this server's collection.

Throws:

DuplicateGroupException

addGroup

void addGroup(Group value)
              throws DuplicateGroupException

adds an Group to this server's collection.

Throws:

DuplicateGroupException

addMacro

void addMacro(Macro value)
              throws DuplicateGroupException

adds a Macro to this server's collection.

Throws:

DuplicateGroupException

addFunction

void addFunction(Function value)
                 throws DuplicateGroupException

adds a Function to this server's collection.

Throws:

DuplicateGroupException

addVariable

void addVariable(Variable value)
                 throws DuplicateVariableException

adds a Variable to this db's collection.

Throws:

DuplicateVariableException

addVariableForServer

void addVariableForServer(Variable value)
                          throws DuplicateVariableException

Throws:

DuplicateVariableException

getApplications

Application[] getApplications()

retrieves this server's collection of applications.

getLoadedApplications

Application[] getLoadedApplications()

retrieves this server's currently loaded applications.

getApplication

Application getApplication(java.lang.String name)

retrieves a specific application

getApplicationIndex

int getApplicationIndex(java.lang.String name)

getApplicationIndex

int getApplicationIndex(Application app)

getUsers

User[] getUsers()

retrieves this server's collection of users.

getUser

User getUser(java.lang.String userName)

getUser

User getUser(java.lang.String userName,
             java.lang.String providerName)

getGroups

Group[] getGroups()

retrieves this server's collection of Groups.

getGroup

Group getGroup(java.lang.String groupName)

getMacros

Macro[] getMacros()

retrieves this server's collection of Macros.

getMacrosByAppName

Macro[] getMacrosByAppName(java.lang.String appName)

retrieves this server's collection of Macros for an application.

getMacro

Macro getMacro(java.lang.String name)

retrieves a specific Macro from Server

getMacro

Macro getMacro(java.lang.String appName,
               java.lang.String name)

retrieves a specific Macro with app name

getFunctions

Function[] getFunctions()

retrieves this server's collection of Functions.

getFunctionsByAppName

Function[] getFunctionsByAppName(java.lang.String appName)

retrieves this server's collection of Functions.

getFunction

Function getFunction(java.lang.String name)

retrieves a specific Function

getFunction

Function getFunction(java.lang.String appName,
                     java.lang.String name)

retrieves a specific Function

getVariables

Variable[] getVariables()

retrieves this server's collection of variables.

getVariable

Variable getVariable(java.lang.String name)

Returns the Variable associated with the name from the collection of variables

getVariableByNames

Variable getVariableByNames(java.lang.String appName,
                            java.lang.String dbName,
                            java.lang.String value)

Returns the Variable associated with the appname, dbname, name from the collection of variables

getProperties

ServerProperties getProperties()

retrieves this server's property information

setProperties

void setProperties(ServerProperties serverProps)

sets this server's property information

getPlatform

ServerPlatform getPlatform()

retrieves this server's platform information

setPlatform

void setPlatform(ServerPlatform serverPlat)

sets this server's platform information

removeAllApplications

void removeAllApplications()
                           throws MissingApplicationException

removes all applications from this server's collection of applications.

Throws:

MissingApplicationException

removeApplication

void removeApplication(Application value)
                       throws MissingApplicationException

removes an application from this server's collection of applications. Note: this does not remove the application from the Essbase server.

Throws:

MissingApplicationException

removeUser

void removeUser(User value)
                throws MissingUserException

removes an User from this server's collection of Users.

Throws:

MissingUserException

removeGroup

void removeGroup(Group value)
                 throws MissingGroupException

removes an Group from this server's collection of Groups.

Throws:

MissingGroupException

removeAllMacros

void removeAllMacros()
                     throws MissingMacroException

Throws:

MissingMacroException

removeMacro

void removeMacro(Macro value)
                 throws MissingMacroException

removes a Macro from this server's collection of Groups.

Throws:

MissingMacroException

removeAllFunctions

void removeAllFunctions()
                        throws MissingFunctionException

Throws:

MissingFunctionException

removeFunction

void removeFunction(Function value)
                    throws MissingFunctionException

removes a Function from this server's collection of Groups.

Throws:

MissingFunctionException

removeAllVariables

void removeAllVariables()
                        throws MissingVariableException

Throws:

MissingVariableException

removeVariable

void removeVariable(Variable value)
                    throws MissingVariableException

removes a Variable from this db's collection of Variables.

Throws:

MissingVariableException

addServerListener

void addServerListener(ServerListener l)

adds a listener for events on a server.

removeServerListener

void removeServerListener(ServerListener l)

removes an event listener from a server

isConnected

boolean isConnected()

is the server connected

setConnected

void setConnected(boolean value)

Set the server's connection state

isDisconnecting

void isDisconnecting()

Inform server is disconnecting

setRunning

void setRunning(boolean value)

Set the running status of the server

Parameters:

value -

isRunning

boolean isRunning()

Inform server is running

Returns:

true if the server is running

isRunningSet

boolean isRunningSet()

Has the server running status been set.

Returns:

hasLicense

boolean hasLicense(java.lang.String key)

Returns true if the server has a license for a module rep by the key

addLicense

void addLicense(java.lang.String key)

resetServer

void resetServer()

resets the server usually after a disconnect, so that all lists are forced to be refreshed.

setSessionUser

void setSessionUser(User user)

sets the logged in user associated with this server.

getSessionUser

User getSessionUser()

gets the logged in user associated with this server.

incVariablesAccess

void incVariablesAccess()

increments the variables list access. used to keep list reference not null and in memory

decVariablesAccess

void decVariablesAccess()

decrements the variables list user access. used to free list reference in memory for potential garbage collection

incMacrosAccess

void incMacrosAccess()

increments the macros list user access. used to keep list reference not null and in memory

decMacrosAccess

void decMacrosAccess()

decrements the macros list user access. used to free list reference in memory for potential garbage collection

incFunctionsAccess

void incFunctionsAccess()

increments the functions list user access. used to keep list reference not null and in memory

decFunctionsAccess

void decFunctionsAccess()

decrements the functions list user access. used to free list reference in memory for potential garbage collection

incUsersAccess

void incUsersAccess()

increments the users list user access. used to keep list reference not null and in memory

decUsersAccess

void decUsersAccess()

decrements the users list user access. used to free list reference in memory for potential garbage collection

incGroupsAccess

void incGroupsAccess()

increments the groups list user access. used to keep list reference not null and in memory

decGroupsAccess

void decGroupsAccess()

decrements the groups list user access. used to free list reference in memory for potential garbage collection

setEssbaseCasEnabled

void setEssbaseCasEnabled(boolean enabled)

isEssbaseCasEnabled

java.lang.Boolean isEssbaseCasEnabled()

setEssbaseCssEnabled

void setEssbaseCssEnabled(boolean enabled)

isEssbaseCssEnabled

java.lang.Boolean isEssbaseCssEnabled()

setCluster

void setCluster(java.lang.String string)

getCluster

java.lang.String getCluster()

setServerVersion

void setServerVersion(Version version)

getServerVersion

Version getServerVersion()

isSessionUserName

boolean isSessionUserName(java.lang.String name,
                          java.lang.String providerName)

setArborPath

void setArborPath(java.lang.String arborpath)

getArborPath

java.lang.String getArborPath()

Skip navigation links