Class AdminBeanEventHandler
- java.lang.Object
-
- com.microstrategy.web.beans.GenericEventHandler
-
- com.microstrategy.web.beans.SysEventHandler
-
- com.microstrategy.web.admin.beans.AdminBeanEventHandler
-
- All Implemented Interfaces:
EnumAdminBeanEvents
,WebEventHandler
,WebEventTags
,java.lang.Cloneable
public class AdminBeanEventHandler extends SysEventHandler implements EnumAdminBeanEvents
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.beans.GenericEventHandler
GenericEventHandler.GenericEventKeys
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.beans.SysEventHandler
DEFAULT_CONFIG_PATH
-
Fields inherited from class com.microstrategy.web.beans.GenericEventHandler
_extraEvents, layerOfHandleRequest, MULTIPLE_EVENT_SOURCE_SUFFIX, NO_EVENT_ID
-
Fields inherited from interface com.microstrategy.web.admin.beans.EnumAdminBeanEvents
WebEventAdminAddConnectServer, WebEventAdminAddServer, WebEventAdminConnectServer, WebEventAdminCreateTrustedRelationship, WebEventAdminDeleteServers, WebEventAdminDeleteTrustedRelationship, WebEventAdminDisConnectServer, WebEventAdminLoadDefaultOtherConfigurationOptions, WebEventAdminLoadDefaultSecurityOptions, WebEventAdminModifyConnectedServerProperties, WebEventAdminModifyDisconnectedServerProperties, WebEventAdminOpenTrustedRelationshipPage, WebEventAdminOpenUsherConfig, WebEventAdminSaveConnectNewServer, WebEventAdminSaveHelpOptions, WebEventAdminSaveOfficeOptions, WebEventAdminSaveOtherConfigurationOptions, WebEventAdminSaveSecurityOptions, WebEventAdminSaveServer, WebEventAdminSaveUsherConfig, WebEventArgumentAdminAddServerButton, WebEventArgumentAdminConnectServerButton, WebEventArgumentAdminSaveServerButton, WebEventArgumentAdminServerBusyTimeOut, WebEventArgumentAdminServerConnectMode, WebEventArgumentAdminServerDefaultLogin, WebEventArgumentAdminServerEnabledLogin, WebEventArgumentAdminServerEnabledWebLogin, WebEventArgumentAdminServerInitialPoolSize, WebEventArgumentAdminServerKeepAlive, WebEventArgumentAdminServerLoadBalance, WebEventArgumentAdminServerMaxPoolSize, WebEventArgumentAdminServerName, WebEventArgumentAdminServerPort, WebEventArgumentAdminServerRequestTimeOut, WebEventArgumentAllowAdminApplyAllProjects, WebEventArgumentAllowAutocomplete, WebEventArgumentAllowChangePassword, WebEventArgumentAllowHTMLOnMetricValues, WebEventArgumentAllowHTMLOnNoDataReturnedDesc, WebEventArgumentAllowHTMLOnObjDesc, WebEventArgumentAllowHTMLOnPrintHeader, WebEventArgumentAllowHTMLOnProjectDescription, WebEventArgumentAllowHTMLOnPromptDescription, WebEventArgumentAllowInputEmail, WebEventArgumentAllowLoginByUrl, WebEventArgumentAllowRSHyperlinkJSExecution, WebEventArgumentAllowSeamlessLogin, WebEventArgumentApplicationName, WebEventArgumentAuthenticationMode, WebEventArgumentCreateNewSession, WebEventArgumentCustomErrorMessage, WebEventArgumentEnableFencing, WebEventArgumentEnableFrameBreaking, WebEventArgumentEnableHttpProxy, WebEventArgumentEncodeExportResults, WebEventArgumentEncodeTooltips, WebEventArgumentHelpLocation, WebEventArgumentHelpURL, WebEventArgumentHttpProxyServerAddress, WebEventArgumentHttpProxyServerPort, WebEventArgumentIdentityTokenSecretKey, WebEventArgumentImportUsherUser, WebEventArgumentIncludeSessionUrl, WebEventArgumentIncludeTimeStamp, WebEventArgumentOfficeAppendPath, WebEventArgumentOfficeSetupLocation, WebEventArgumentOfficeShowLink, WebEventArgumentOverrideIServerErrorMessage, WebEventArgumentOverrideProjectLoginModes, WebEventArgumentPreventCaching, WebEventArgumentProjectListLoginFirst, WebEventArgumentProjectSorting, WebEventArgumentRenderRequestInfo, WebEventArgumentRenderStackTrace, WebEventArgumentSalesforceClientID, WebEventArgumentSalesforceClientSecret, WebEventArgumentSalesforceRedirectURL, WebEventArgumentServerSorting, WebEventArgumentShowAboutPageInfo, WebEventArgumentShowLoginPageAfterLogout, WebEventArgumentSSLValidate, WebEventArgumentTrustedAuthProvider, WebEventArgumentUseCookies, WebEventArgumentUseEncryption, WebEventArgumentUseIEEdgeMode, WebEventArgumentUserId, WebEventArgumentUserPassword, WebEventArgumentUseSessionCookie, WebEventArgumentUsher2Factor, WebEventArgumentUsherAppId, WebEventArgumentUsherBaseURL, WebEventArgumentUsherOrgId, WebEventArgumentUsherRegistrationEmailDomain, WebEventArgumentUsherToken, WebEventArgumentUsherUserRegistration, WebEventArgumentXFrameOptions, WebEventShowAdminServers
-
Fields inherited from interface com.microstrategy.web.beans.WebEventTags
ATT_ARGUMENT_ENUMERATOR, ATT_ARGUMENT_ID, ATT_ARGUMENT_INDEX, ATT_ARGUMENT_NAME, ATT_ARGUMENT_REQUIRED, ATT_ARGUMENT_TYPE, ATT_ARGUMENT_VALIDATOR, ATT_ARGUMENT_VALUE, ATT_EVENT_DEPRECATED, ATT_EVENT_ENUMERATOR, ATT_EVENT_HANDLER_ENUMERATOR, ATT_EVENT_HANDLER_NAME, ATT_EVENT_HANDLER_TYPE, ATT_EVENT_ID, ATT_EVENT_NAME, ATT_EVENT_TARGET, TAG_ARGUMENT, TAG_ARGUMENTS, TAG_EVENT, TAG_EVENT_HANDLER, TAG_EVENT_HANDLERS, TAG_EVENTS
-
-
Constructor Summary
Constructors Constructor Description AdminBeanEventHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Class
getSupportedWebComponentType()
Returns theWebComponent
class by default.WebComponent
getWebComponent()
Gets the corresponding web component for this event handlerboolean
processRequest(RequestKeys keys)
Handle the request specified by the RequestKeysvoid
setWebComponent(WebComponent component)
Set the corresponding web component (should be of typeAdminBean
) for this event handler-
Methods inherited from class com.microstrategy.web.beans.SysEventHandler
getCatalog, getWebEvent, getWebEvents, initEvents, initEvents, newDefaultEventInstance, newWebEvent
-
Methods inherited from class com.microstrategy.web.beans.GenericEventHandler
addEvent, addEvent, addEvents, addEventsFromRequestKeys, addEventsFromXML, appendRemainingEvent, clone, delegateRequest, getEventID, getEventTarget, getHandlerType, getName, getNextSourceName, getNextSourceName, getOrderedEvents, getPendingEvents, getWebEvent, getWebEvent, getWebEventsFromRequest, handleRequest, isInitialized, isMyEvent, markInitailized, processExtraEvents, processMultipleEvents, processMultipleEvents, setHandlerType, setName, validateRequiredArgument
-
-
-
-
Method Detail
-
setWebComponent
public void setWebComponent(WebComponent component)
Set the corresponding web component (should be of typeAdminBean
) for this event handler- Specified by:
setWebComponent
in interfaceWebEventHandler
- Overrides:
setWebComponent
in classGenericEventHandler
- Parameters:
component
- the input web component
-
getWebComponent
public WebComponent getWebComponent()
Gets the corresponding web component for this event handler- Specified by:
getWebComponent
in interfaceWebEventHandler
- Overrides:
getWebComponent
in classGenericEventHandler
- Returns:
- The WebComponent for this event handler.
-
processRequest
public boolean processRequest(RequestKeys keys) throws WebException
Handle the request specified by the RequestKeys- Specified by:
processRequest
in interfaceWebEventHandler
- Overrides:
processRequest
in classGenericEventHandler
- Parameters:
keys
-RequestKeys
instance with the input request- Returns:
True
meaning some event is handled, orFalse
meaning nothing was handled- Throws:
WebException
- if an error ocurrs while handling the request- Since:
- MicroStrategy Web 8.0.0
-
getSupportedWebComponentType
public java.lang.Class getSupportedWebComponentType()
Description copied from class:GenericEventHandler
Returns theWebComponent
class by default. Subclasses should override this to return their respectiveWebComponent
orWebBean
int.- Specified by:
getSupportedWebComponentType
in interfaceWebEventHandler
- Overrides:
getSupportedWebComponentType
in classGenericEventHandler
- Returns:
- the
Class
of theWebComponent
this event handler is associated with.
-
-