Skip navigation links


com.essbase.eas.essbase.server
Class ServerCommandListener

java.lang.Object
  extended by com.essbase.eas.framework.server.application.DefaultApplicationPart
      extended by com.essbase.eas.framework.server.application.AbstractCommandListener
          extended by com.essbase.eas.server.AppManCommandListener
              extended by com.essbase.eas.essbase.server.EssbaseCommandListener
                  extended by com.essbase.eas.essbase.server.ServerCommandListener

All Implemented Interfaces:
ApplicationPart, CommandListener

public class ServerCommandListener
extends EssbaseCommandListener
Since:
6.2.0
Version:
6.5.4
Author:
Hyperion Solutions

Field Summary

 

Fields inherited from class com.essbase.eas.essbase.server.EssbaseCommandListener
DEADEND, DEADEND_KEY, FAILED, FAILED_KEY, NOT_CONNECTED, NOT_CONNECTED_KEY, NOT_CONNECTING, NOT_CONNECTING_KEY, RELOGIN, RELOGIN_KEY, requestMap, TOKEN_TIMEOUT1_KEY, TOKEN_TIMEOUT2_KEY

 

Fields inherited from class com.essbase.eas.framework.server.application.AbstractCommandListener
aliasMap, methodMap, RESULT, THERESULT, UPLOAD

 

Fields inherited from class com.essbase.eas.framework.server.application.DefaultApplicationPart
CHAIN_SEPARATOR, manager, parts, serviceContext, serviceManager, state, STATE_BEFORE_WORKERS_ASSIGNED, STATE_CONSTRUCTED, STATE_DESTROYED, STATE_INITIALIZED, STATE_MANAGED, STATE_NULL, STATE_WORKERS_ASSIGNED, STATE_WORKERS_INITIALIZED, storeService

 

Constructor Summary
ServerCommandListener()
           

 

Method Summary
 boolean connect(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.String userName)
           
 boolean deleteExportDirectory(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.String directory)
           
 boolean disconnect(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
           
 boolean disconnectAll(CommandEvent theEvent, ServiceContext theContext)
           
 boolean emailProperties(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.String appName, java.lang.String dbName, java.lang.String toName, java.lang.String ccName, java.lang.String bccName, java.lang.String subject, java.lang.String text)
          email the properties for a server, application or database
 boolean getAPSServersFromRegistry(CommandEvent theEvent, ServiceContext theContext)
           
 boolean getCASUrl(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
          This method is form manage users and group menu item under secuirty node.
 boolean getClusterName(CommandEvent theEvent, ServiceContext theContext, java.lang.String servername)
           
 CommandDescriptor[] getCommands()
          Implementation of the CommandListener.getCommands() method.
 boolean getEssbaseServersFromRegistry(CommandEvent theEvent, ServiceContext theContext)
           
 boolean getExportDirectoryList(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
          Get the list of exported Lro server directories.
 boolean getList(CommandEvent theEvent, ServiceContext theContext)
           
 boolean getLocaleString(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
           
 boolean getPlatformInfo(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
           
 boolean getProperties(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.Integer subset)
           
 boolean getSessionUser(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
           
 boolean getVersion(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
           
 boolean isEASServerOnClientSystem(CommandEvent theEvent, ServiceContext theContext, java.lang.String clientIPAddress)
          This one is to verify if the eas server and eas client both exist on the same machine.
 boolean isExternalAuthenticationEnabled(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
           
 boolean loginSetPassword(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.String userName, java.lang.String password, java.lang.String newPassword)
          Login and change password at timeof login.
 boolean registerEventServer(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.String url, java.lang.Boolean registerServer)
          Register this EAS server as the Event Server for the specified Essbase Server
 boolean setProperties(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, EssbaseServerList serverList)
           
 boolean start(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.String serverIdentifier, java.lang.String password)
           
 boolean stop(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
           
 boolean syncSecurityBackup(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName)
          Sync the security of the server from the memory to the hard disk.
 boolean validateConnection(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.String userName, java.lang.String password)
          Used to validate a username and password connection to an Essbase server if no connection already exists.
protected  boolean validateSession(CommandEvent command)
          This method will give each command listener a chance to do their validation instead of having to have the knowledge in this module

 

Methods inherited from class com.essbase.eas.essbase.server.EssbaseCommandListener
getEssbaseSession, handleEventException, handleEventPost, handleEventPrep, set, setResult

 

Methods inherited from class com.essbase.eas.server.AppManCommandListener
getSession, getSession, getSession, releaseSession

 

Methods inherited from class com.essbase.eas.framework.server.application.AbstractCommandListener
addMethodAlias, addMethodAlias, assignWorkers, buildMethodMap, convertStringValueToArgument, getArgumentsForCommand, getMethod, getMethodForAlias, getRoles, getSessionObject, handleEvent, init, isRequestFromSameServer, removeSessionObject, setServiceResult, setSessionObject

 

Methods inherited from class com.essbase.eas.framework.server.application.DefaultApplicationPart
destroy, getManager, getManagerChain, getServiceContext, getServiceManager, getStoreService, initWorkers, requestPart, requestPartPool, setManager

 

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

 

Methods inherited from interface com.essbase.eas.framework.server.defs.ApplicationPart
destroy, getManager, getServiceContext, getServiceManager, getStoreService, initWorkers, setManager

 

Constructor Detail

ServerCommandListener

public ServerCommandListener()

Method Detail

getList

public boolean getList(CommandEvent theEvent,
                       ServiceContext theContext)

disconnect

public boolean disconnect(CommandEvent theEvent,
                          ServiceContext theContext,
                          java.lang.String serverName)
                   throws MessageException
Throws:
MessageException

connect

public boolean connect(CommandEvent theEvent,
                       ServiceContext theContext,
                       java.lang.String serverName,
                       java.lang.String userName)
                throws MessageException
Throws:
MessageException

disconnectAll

public boolean disconnectAll(CommandEvent theEvent,
                             ServiceContext theContext)

start

public boolean start(CommandEvent theEvent,
                     ServiceContext theContext,
                     java.lang.String serverName,
                     java.lang.String serverIdentifier,
                     java.lang.String password)
              throws java.lang.Exception
Throws:
java.lang.Exception

stop

public boolean stop(CommandEvent theEvent,
                    ServiceContext theContext,
                    java.lang.String serverName)
             throws java.lang.Exception
Throws:
java.lang.Exception

getProperties

public boolean getProperties(CommandEvent theEvent,
                             ServiceContext theContext,
                             java.lang.String serverName,
                             java.lang.Integer subset)
                      throws java.lang.Exception
Throws:
java.lang.Exception

setProperties

public boolean setProperties(CommandEvent theEvent,
                             ServiceContext theContext,
                             java.lang.String serverName,
                             EssbaseServerList serverList)
                      throws java.lang.Exception
Throws:
java.lang.Exception

getSessionUser

public boolean getSessionUser(CommandEvent theEvent,
                              ServiceContext theContext,
                              java.lang.String serverName)
                       throws java.lang.Exception
Throws:
java.lang.Exception

getPlatformInfo

public boolean getPlatformInfo(CommandEvent theEvent,
                               ServiceContext theContext,
                               java.lang.String serverName)
                        throws java.lang.Exception
Throws:
java.lang.Exception

validateConnection

public boolean validateConnection(CommandEvent theEvent,
                                  ServiceContext theContext,
                                  java.lang.String serverName,
                                  java.lang.String userName,
                                  java.lang.String password)
                           throws java.lang.Exception
Used to validate a username and password connection to an Essbase server if no connection already exists.
Throws:
java.lang.Exception

emailProperties

public boolean emailProperties(CommandEvent theEvent,
                               ServiceContext theContext,
                               java.lang.String serverName,
                               java.lang.String appName,
                               java.lang.String dbName,
                               java.lang.String toName,
                               java.lang.String ccName,
                               java.lang.String bccName,
                               java.lang.String subject,
                               java.lang.String text)
                        throws java.lang.Exception
email the properties for a server, application or database
Throws:
java.lang.Exception

loginSetPassword

public boolean loginSetPassword(CommandEvent theEvent,
                                ServiceContext theContext,
                                java.lang.String serverName,
                                java.lang.String userName,
                                java.lang.String password,
                                java.lang.String newPassword)
                         throws java.lang.Exception
Login and change password at timeof login.
Throws:
java.lang.Exception

syncSecurityBackup

public boolean syncSecurityBackup(CommandEvent theEvent,
                                  ServiceContext theContext,
                                  java.lang.String serverName)
                           throws java.lang.Exception
Sync the security of the server from the memory to the hard disk.
Throws:
java.lang.Exception

getVersion

public boolean getVersion(CommandEvent theEvent,
                          ServiceContext theContext,
                          java.lang.String serverName)
                   throws java.lang.Exception
Throws:
java.lang.Exception

getExportDirectoryList

public boolean getExportDirectoryList(CommandEvent theEvent,
                                      ServiceContext theContext,
                                      java.lang.String serverName)
                               throws java.lang.Exception
Get the list of exported Lro server directories.
Throws:
java.lang.Exception

deleteExportDirectory

public boolean deleteExportDirectory(CommandEvent theEvent,
                                     ServiceContext theContext,
                                     java.lang.String serverName,
                                     java.lang.String directory)
                              throws java.lang.Exception
Throws:
java.lang.Exception

isExternalAuthenticationEnabled

public boolean isExternalAuthenticationEnabled(CommandEvent theEvent,
                                               ServiceContext theContext,
                                               java.lang.String serverName)
                                        throws java.lang.Exception
Throws:
java.lang.Exception

isEASServerOnClientSystem

public boolean isEASServerOnClientSystem(CommandEvent theEvent,
                                         ServiceContext theContext,
                                         java.lang.String clientIPAddress)
                                  throws java.lang.Exception
This one is to verify if the eas server and eas client both exist on the same machine. Verifies the IP address of each one. Note: The comparison could be done once and probably can save the information in the mid tier store.
Throws:
java.lang.Exception

getLocaleString

public boolean getLocaleString(CommandEvent theEvent,
                               ServiceContext theContext,
                               java.lang.String serverName)
                        throws java.lang.Exception
Throws:
java.lang.Exception

registerEventServer

public boolean registerEventServer(CommandEvent theEvent,
                                   ServiceContext theContext,
                                   java.lang.String serverName,
                                   java.lang.String url,
                                   java.lang.Boolean registerServer)
                            throws java.lang.Exception
Register this EAS server as the Event Server for the specified Essbase Server
Throws:
java.lang.Exception

validateSession

protected boolean validateSession(CommandEvent command)
                           throws MessageException
This method will give each command listener a chance to do their validation instead of having to have the knowledge in this module
Overrides:
validateSession in class EssbaseCommandListener
Parameters:
hmap - The hash map containig the params
commandName - The command name
Returns:
true if the session is validated
Throws:
MessageException

getCASUrl

public boolean getCASUrl(CommandEvent theEvent,
                         ServiceContext theContext,
                         java.lang.String serverName)
This method is form manage users and group menu item under secuirty node.
Parameters:
theEvent -
theContext -
serverName -
Returns:

getEssbaseServersFromRegistry

public boolean getEssbaseServersFromRegistry(CommandEvent theEvent,
                                             ServiceContext theContext)

getAPSServersFromRegistry

public boolean getAPSServersFromRegistry(CommandEvent theEvent,
                                         ServiceContext theContext)

getClusterName

public boolean getClusterName(CommandEvent theEvent,
                              ServiceContext theContext,
                              java.lang.String servername)

getCommands

public CommandDescriptor[] getCommands()
Description copied from class: AbstractCommandListener
Implementation of the CommandListener.getCommands() method. This is an empty implementation and should be overridden by any derived classes that use the new introspection method of discovering commands.
Specified by:
getCommands in interface CommandListener
Overrides:
getCommands in class AbstractCommandListener
Returns:
a zero-length array of CommandDescriptor objects.

Skip navigation links


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