Skip navigation links


com.essbase.eas.server
Class AdminCommandListener

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.server.AdminCommandListener

All Implemented Interfaces:
ApplicationPart, CommandListener

public class AdminCommandListener
extends AppManCommandListener
Since:
6.2.0
Version:
6.5.4
Author:
Hyperion Solutions

Field Summary

 

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
AdminCommandListener()
           

 

Method Summary
 boolean acceptReplication(CommandEvent theEvent, ServiceContext theContext, java.lang.String dataXML)
          Deprecated.  
 boolean addServerToMasterList(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverType, java.lang.String serverName)
          Add a server to the master list of servers
 boolean addServerToUserList(CommandEvent theEvent, ServiceContext theContext, java.lang.String userName, java.lang.String serverType, java.lang.String serverName, java.lang.String serverUserName, java.lang.String serverPassword, java.lang.String external)
          Add a server to a user's list of server
 boolean addToReplicationList(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverName, java.lang.String serverURL, java.lang.String serverUser, java.lang.String serverPassword)
          Deprecated.  
 boolean adminUpdateServerFromUserList(CommandEvent theEvent, ServiceContext theContext, java.lang.String userName, java.lang.String serverType, java.lang.String serverName, java.lang.String serverUserName, java.lang.String serverPassword, java.lang.String serverExternalLogin)
          Update the server list for a user
 boolean createNativeGroup(CommandEvent theEvent, ServiceContext theContext, DefaultAdminGroup group)
          Create a native group on this server
 boolean createNativeUser(CommandEvent theEvent, ServiceContext theContext, DefaultAdminUser user)
          Create a native user on this server
 boolean createUser(CommandEvent theEvent, ServiceContext theContext, DefaultAdminUser user, java.lang.String fillList)
          Create a user on this server
 boolean deleteUser(CommandEvent theEvent, ServiceContext theContext, java.lang.String userName)
          Delete a user from this server
 boolean editUser(CommandEvent theEvent, ServiceContext theContext, DefaultAdminUser user)
          Edit the user properties for this user
 boolean findGroup(CommandEvent theEvent, ServiceContext theContext, FindRequest request)
          Find CSS groups
 boolean findUser(CommandEvent theEvent, ServiceContext theContext, FindRequest request)
          Find CSS users using
 CommandDescriptor[] getCommands()
          Implementation of the CommandListener.getCommands() method.
 boolean getMasterServerList(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverType)
          Return the master list of server for a server type
 boolean getNativeUsersList(CommandEvent theEvent, ServiceContext theContext)
           
 boolean getReplicationList(CommandEvent theEvent, ServiceContext theContext)
          Deprecated.  
 boolean getUserList(CommandEvent theEvent, ServiceContext theContext)
          Return the list of EAS users for this server
 boolean getUserServerList(CommandEvent theEvent, ServiceContext theContext, java.lang.String userName, java.lang.String serverType)
          Return the users server list
 boolean isCSSConfigured(CommandEvent theEvent, ServiceContext theContext)
          Is CSS configured for this server
 boolean isSupervisor(CommandEvent theEvent, ServiceContext theContext)
          Does the user have supervisor permissions
 boolean isUserAdmin(CommandEvent theEvent, ServiceContext theContext)
          Is the user having admin role
 boolean removeFromReplicationList(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverURL)
          Deprecated.  
 boolean removeServerFromMasterList(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverType, java.lang.String serverName)
          Remove a server from the master list
 boolean removeServerFromUserList(CommandEvent theEvent, ServiceContext theContext, java.lang.String userName, java.lang.String serverType, java.lang.String serverName)
          Remove a server from a user's list
 boolean renameUser(CommandEvent theEvent, ServiceContext theContext, java.lang.String newUserName, java.lang.String oldUserName)
          Rename this user
 boolean replicate(CommandEvent theEvent, ServiceContext theContext)
          Deprecated.  
 boolean retrieveData(CommandEvent theEvent, ServiceContext theContext, java.lang.String key)
          Retrieve data stored under a key
 boolean setEmailStatus(CommandEvent theEvent, ServiceContext theContext, java.lang.String command, java.lang.String message, java.lang.String error)
          Set the result of sending an email from the client to the FAF process table
 boolean setUserMigrated(CommandEvent theEvent, ServiceContext theContext, java.lang.String userName)
           
 boolean storeData(CommandEvent theEvent, ServiceContext theContext, java.lang.String key, java.lang.String data)
          Store data under a key
 boolean updateEssbaseusers(CommandEvent theEvent, ServiceContext theContext, java.lang.String essbaseServerName, java.lang.String userList, java.lang.String pwdList)
           

 

Methods inherited from class com.essbase.eas.server.AppManCommandListener
getSession, getSession, getSession, handleEventException, handleEventPost, handleEventPrep, 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

AdminCommandListener

public AdminCommandListener()

Method Detail

getUserList

public boolean getUserList(CommandEvent theEvent,
                           ServiceContext theContext)
Return the list of EAS users for this server
Parameters:
theEvent - - the command event
theContext - - the service context
Returns:
true

createUser

public boolean createUser(CommandEvent theEvent,
                          ServiceContext theContext,
                          DefaultAdminUser user,
                          java.lang.String fillList)
Create a user on this server
Parameters:
theEvent -
theContext -
user - - the user to create
fillList - - if true create an entry for all servers
Returns:
true but ignored by caller

deleteUser

public boolean deleteUser(CommandEvent theEvent,
                          ServiceContext theContext,
                          java.lang.String userName)
Delete a user from this server
Parameters:
theEvent -
theContext -
userName -

renameUser

public boolean renameUser(CommandEvent theEvent,
                          ServiceContext theContext,
                          java.lang.String newUserName,
                          java.lang.String oldUserName)
Rename this user
Parameters:
theEvent -
theContext -
newUserName - - the new name
oldUserName - - the old name

editUser

public boolean editUser(CommandEvent theEvent,
                        ServiceContext theContext,
                        DefaultAdminUser user)
Edit the user properties for this user
Parameters:
theEvent -
theContext -
user - - the new user properties

isCSSConfigured

public boolean isCSSConfigured(CommandEvent theEvent,
                               ServiceContext theContext)
Is CSS configured for this server
Parameters:
theEvent -
theContext -

isSupervisor

public boolean isSupervisor(CommandEvent theEvent,
                            ServiceContext theContext)
Does the user have supervisor permissions
Parameters:
theEvent -
theContext -
Returns:
true if the user has permission

isUserAdmin

public boolean isUserAdmin(CommandEvent theEvent,
                           ServiceContext theContext)
Is the user having admin role
Parameters:
theEvent -
theContext -
Returns:
true if the user has permission

getMasterServerList

public boolean getMasterServerList(CommandEvent theEvent,
                                   ServiceContext theContext,
                                   java.lang.String serverType)
Return the master list of server for a server type
Parameters:
theEvent -
theContext -
serverType - - the string name of the serverType or ParameterKeys.ALL

addServerToMasterList

public boolean addServerToMasterList(CommandEvent theEvent,
                                     ServiceContext theContext,
                                     java.lang.String serverType,
                                     java.lang.String serverName)
Add a server to the master list of servers
Parameters:
theEvent -
theContext -
serverType -
serverName -

removeServerFromMasterList

public boolean removeServerFromMasterList(CommandEvent theEvent,
                                          ServiceContext theContext,
                                          java.lang.String serverType,
                                          java.lang.String serverName)
Remove a server from the master list
Parameters:
theEvent -
theContext -
serverType -
serverName -

getUserServerList

public boolean getUserServerList(CommandEvent theEvent,
                                 ServiceContext theContext,
                                 java.lang.String userName,
                                 java.lang.String serverType)
Return the users server list
Parameters:
theEvent -
theContext -
userName -
serverType -

addServerToUserList

public boolean addServerToUserList(CommandEvent theEvent,
                                   ServiceContext theContext,
                                   java.lang.String userName,
                                   java.lang.String serverType,
                                   java.lang.String serverName,
                                   java.lang.String serverUserName,
                                   java.lang.String serverPassword,
                                   java.lang.String external)
Add a server to a user's list of server
Parameters:
theEvent -
theContext -
userName -
serverType -
serverName -
serverUserName -
serverPassword -
external -

removeServerFromUserList

public boolean removeServerFromUserList(CommandEvent theEvent,
                                        ServiceContext theContext,
                                        java.lang.String userName,
                                        java.lang.String serverType,
                                        java.lang.String serverName)
Remove a server from a user's list
Parameters:
theEvent -
theContext -
userName -
serverType -
serverName -

adminUpdateServerFromUserList

public boolean adminUpdateServerFromUserList(CommandEvent theEvent,
                                             ServiceContext theContext,
                                             java.lang.String userName,
                                             java.lang.String serverType,
                                             java.lang.String serverName,
                                             java.lang.String serverUserName,
                                             java.lang.String serverPassword,
                                             java.lang.String serverExternalLogin)
Update the server list for a user
Parameters:
theEvent -
theContext -
userName -
serverType -
serverName -
serverUserName -
serverPassword -
serverExternalLogin -

storeData

public boolean storeData(CommandEvent theEvent,
                         ServiceContext theContext,
                         java.lang.String key,
                         java.lang.String data)
Store data under a key
Parameters:
theEvent -
theContext -

retrieveData

public boolean retrieveData(CommandEvent theEvent,
                            ServiceContext theContext,
                            java.lang.String key)
Retrieve data stored under a key
Parameters:
theEvent -
theContext -
username -
key -

setEmailStatus

public boolean setEmailStatus(CommandEvent theEvent,
                              ServiceContext theContext,
                              java.lang.String command,
                              java.lang.String message,
                              java.lang.String error)
Set the result of sending an email from the client to the FAF process table
Parameters:
theEvent -
theContext -
command -
message -
error -

findUser

public boolean findUser(CommandEvent theEvent,
                        ServiceContext theContext,
                        FindRequest request)
Find CSS users using
Parameters:
theEvent -
theContext -
request - contains the information to find users

findGroup

public boolean findGroup(CommandEvent theEvent,
                         ServiceContext theContext,
                         FindRequest request)
Find CSS groups
Parameters:
theContext -
request -

getReplicationList

public boolean getReplicationList(CommandEvent theEvent,
                                  ServiceContext theContext)
Deprecated. 
get list of replications

addToReplicationList

public boolean addToReplicationList(CommandEvent theEvent,
                                    ServiceContext theContext,
                                    java.lang.String serverName,
                                    java.lang.String serverURL,
                                    java.lang.String serverUser,
                                    java.lang.String serverPassword)
Deprecated. 
Add to the replication list

removeFromReplicationList

public boolean removeFromReplicationList(CommandEvent theEvent,
                                         ServiceContext theContext,
                                         java.lang.String serverURL)
Deprecated. 
Remove a server from the replication list

replicate

public boolean replicate(CommandEvent theEvent,
                         ServiceContext theContext)
Deprecated. 
Command to start replication

acceptReplication

public boolean acceptReplication(CommandEvent theEvent,
                                 ServiceContext theContext,
                                 java.lang.String dataXML)
Deprecated. 
Command to accept replicated information from another Tomcat server

createNativeUser

public boolean createNativeUser(CommandEvent theEvent,
                                ServiceContext theContext,
                                DefaultAdminUser user)
Create a native user on this server
Parameters:
theEvent -
theContext -
user - - the user to create
Returns:
true but ignored by caller

createNativeGroup

public boolean createNativeGroup(CommandEvent theEvent,
                                 ServiceContext theContext,
                                 DefaultAdminGroup group)
Create a native group on this server
Parameters:
theEvent -
theContext -
group - - the group to create
Returns:
true but ignored by caller

getNativeUsersList

public boolean getNativeUsersList(CommandEvent theEvent,
                                  ServiceContext theContext)

setUserMigrated

public boolean setUserMigrated(CommandEvent theEvent,
                               ServiceContext theContext,
                               java.lang.String userName)

updateEssbaseusers

public boolean updateEssbaseusers(CommandEvent theEvent,
                                  ServiceContext theContext,
                                  java.lang.String essbaseServerName,
                                  java.lang.String userList,
                                  java.lang.String pwdList)

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.