org.opencms.workplace

类 CmsWorkplaceAction

java.lang.Object

org.opencms.module.A_CmsModuleAction

org.opencms.workplace.CmsWorkplaceAction

所有已实现的接口:

I_CmsEventListener, I_CmsModuleAction

public class CmsWorkplaceAction
extends A_CmsModuleAction

The workplace manager class to get the admin CmsObject.

从以下版本开始:

7.5.0

字段概要

从接口继承的字段 org.opencms.main.I_CmsEventListener

EVENT_BEFORE_PUBLISH_PROJECT, EVENT_CLEAR_CACHES, EVENT_CLEAR_OFFLINE_CACHES, EVENT_CLEAR_ONLINE_CACHES, EVENT_CLEAR_PRINCIPAL_CACHES, EVENT_FLEX_CACHE_CLEAR, EVENT_FLEX_PURGE_JSP_REPOSITORY, EVENT_FULLSTATIC_EXPORT, EVENT_GROUP_MODIFIED, EVENT_LOGIN_USER, EVENT_OU_MODIFIED, EVENT_PROJECT_MODIFIED, EVENT_PROPERTY_DEFINITION_CREATED, EVENT_PROPERTY_DEFINITION_MODIFIED, EVENT_PROPERTY_MODIFIED, EVENT_PUBLISH_PROJECT, EVENT_REBUILD_SEARCHINDEXES, EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, EVENT_RESOURCE_COPIED, EVENT_RESOURCE_CREATED, EVENT_RESOURCE_DELETED, EVENT_RESOURCE_MODIFIED, EVENT_RESOURCE_MOVED, EVENT_RESOURCES_AND_PROPERTIES_MODIFIED, EVENT_RESOURCES_MODIFIED, EVENT_SITEMAP_CHANGED, EVENT_UPDATE_EXPORTS, EVENT_USER_MODIFIED, KEY_CHANGE, KEY_DBCONTEXT, KEY_GROUP_ID, KEY_GROUP_NAME, KEY_INDEX_NAMES, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_USER_ACTION, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_GROUP_MODIFIED_ACTION_CREATE, VALUE_GROUP_MODIFIED_ACTION_DELETE, VALUE_GROUP_MODIFIED_ACTION_WRITE, VALUE_OU_MODIFIED_ACTION_CREATE, VALUE_OU_MODIFIED_ACTION_DELETE, VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP, VALUE_USER_MODIFIED_ACTION_CREATE_USER, VALUE_USER_MODIFIED_ACTION_DELETE_USER, VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP, VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD, VALUE_USER_MODIFIED_ACTION_SET_OU, VALUE_USER_MODIFIED_ACTION_WRITE_USER

构造器概要

构造器

构造器和说明
CmsWorkplaceAction() Constructor for a photo album manager object.

方法概要

方法

限定符和类型	方法和说明
CmsObject	getCmsAdminObject() Gets the admin cmsObject.
static CmsWorkplaceAction	getInstance() Returns the instance of the login manager to use.
void	initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module) Will be called by the OpenCms system during server startup.

从类继承的方法 org.opencms.module.A_CmsModuleAction

cmsEvent, moduleUninstall, moduleUpdate, publishProject, shutDown

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsWorkplaceAction

public CmsWorkplaceAction()

Constructor for a photo album manager object.

方法详细资料

getInstance

public static CmsWorkplaceAction getInstance()

Returns the instance of the login manager to use.

返回:

the instance of the login manager to use

getCmsAdminObject

public CmsObject getCmsAdminObject()
                            throws CmsException

Gets the admin cmsObject.

返回:

Admin cmsObject

抛出:

CmsException - is something goes wrong

initialize

public void initialize(CmsObject adminCms,
              CmsConfigurationManager configurationManager,
              CmsModule module)

从接口复制的说明: I_CmsModuleAction

Will be called by the OpenCms system during server startup.

If a module requires special initialization code, this is a good place to to implement this functions.

Moreover, if the module requires special "one time" setup code, this should also be implemented here. For example if the module requires special DB tables to be created, you should implement a check if theses tables exist in this method, and if they don't exist create them as needed.

指定者:

initialize 在接口中 I_CmsModuleAction

覆盖:

initialize 在类中 A_CmsModuleAction

参数:

adminCms - an initialized CmsObject with "Admin" permissions

configurationManager - the initialized OpenCms configuration manager

module - the module of this action instance

另请参阅:

A_CmsModuleAction.initialize(org.opencms.file.CmsObject, org.opencms.configuration.CmsConfigurationManager, org.opencms.module.CmsModule)