Package org.opencms.workplace

Class CmsWorkplaceAction

java.lang.Object
org.opencms.module.A_CmsModuleAction
org.opencms.workplace.CmsWorkplaceAction
All Implemented Interfaces:
org.opencms.main.I_CmsEventListener, org.opencms.module.I_CmsModuleAction
public class CmsWorkplaceAction extends org.opencms.module.A_CmsModuleAction
The workplace manager class to get the admin CmsObject.

Since:
7.5.0

  • Field Summary

    Fields inherited from interface 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_REINDEX_OFFLINE, EVENT_REINDEX_ONLINE, 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_IS_ONLINE, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REINDEX_RELATED, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_SKIPINDEX, KEY_USER_ACTION, KEY_USER_CHANGES, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_CREATE_SIBLING, 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

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsWorkplaceAction()
    Constructor for a photo album manager object.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opencms.file.CmsObject
    getCmsAdminObject()
    Gets the admin cmsObject.
    static CmsWorkplaceAction
    getInstance()
    Returns the instance of the login manager to use.
    void
    initialize(org.opencms.file.CmsObject adminCms, org.opencms.configuration.CmsConfigurationManager configurationManager, org.opencms.module.CmsModule module)
     

    Methods inherited from class org.opencms.module.A_CmsModuleAction

    cmsEvent, moduleUninstall, moduleUpdate, publishProject, shutDown

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CmsWorkplaceAction

      public CmsWorkplaceAction()
      Constructor for a photo album manager object.

  • Method Details

    • getInstance

      public static CmsWorkplaceAction getInstance()
      Returns the instance of the login manager to use.

      Returns:
      the instance of the login manager to use

    • getCmsAdminObject

      public org.opencms.file.CmsObject getCmsAdminObject() throws org.opencms.main.CmsException
      Gets the admin cmsObject.

      Returns:
      Admin cmsObject
      Throws:
      org.opencms.main.CmsException - is something goes wrong

    • initialize

      public void initialize(org.opencms.file.CmsObject adminCms, org.opencms.configuration.CmsConfigurationManager configurationManager, org.opencms.module.CmsModule module)
      Specified by:
      initialize in interface org.opencms.module.I_CmsModuleAction
      Overrides:
      initialize in class org.opencms.module.A_CmsModuleAction
      See Also:
      • A_CmsModuleAction.initialize(org.opencms.file.CmsObject, org.opencms.configuration.CmsConfigurationManager, org.opencms.module.CmsModule)