|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_CmsEventListener
Implement this interface in case your class has to react to CmsEvents that are thrown by system.
In order to receive system events, your class must register with the OpenCms event mechanism. This can be done in the constructor of a class like this:
org.opencms.main.OpenCms.addCmsEventListener(this);A typical implementation might look like this:
public void cmsEvent(org.opencms.main.CmsEvent event) { switch (event.getType()) { case org.opencms.main.I_CmsEventListener.EVENT_PUBLISH_PROJECT: case org.opencms.main.I_CmsEventListener.EVENT_CLEAR_CACHES: // do something break; case org.opencms.main.I_CmsEventListener.EVENT_LOGIN_USER: // do something else break; } }
CmsEvent
,
OpenCms.addCmsEventListener(I_CmsEventListener)
,
OpenCms.addCmsEventListener(I_CmsEventListener, int[])
Field Summary | |
---|---|
static int |
EVENT_BEFORE_PUBLISH_PROJECT
Event "a project is to published" (but has not yet been published). |
static int |
EVENT_CLEAR_CACHES
Event "all caches must be cleared". |
static int |
EVENT_CLEAR_OFFLINE_CACHES
Event "clear all offline caches". |
static int |
EVENT_CLEAR_ONLINE_CACHES
Event "clear all online caches". |
static int |
EVENT_CLEAR_PRINCIPAL_CACHES
Event "all caches related to user and groups must be cleared". |
static int |
EVENT_FLEX_CACHE_CLEAR
Event "the FlexCache must be cleared". |
static int |
EVENT_FLEX_PURGE_JSP_REPOSITORY
Event "delete all JSP pages in the "real" file system (so they will be rebuild next time the JSP is requested)". |
static int |
EVENT_FULLSTATIC_EXPORT
Event "full static export". |
static int |
EVENT_GROUP_MODIFIED
Event "group modified". |
static int |
EVENT_LOGIN_USER
Event "user has logged in". |
static int |
EVENT_OU_MODIFIED
Event "ou modified". |
static int |
EVENT_PROJECT_MODIFIED
Event "a project was modified" (e.g. a project has been deleted, or the project resources have been changed). |
static int |
EVENT_PROPERTY_DEFINITION_CREATED
Event "a property definition has been created". |
static int |
EVENT_PROPERTY_DEFINITION_MODIFIED
Event "a property definition has been modified". |
static int |
EVENT_PROPERTY_MODIFIED
Event "a single property (and so the resource itself, too) have been modified". |
static int |
EVENT_PUBLISH_PROJECT
Event "a project was published". |
static int |
EVENT_REBUILD_SEARCHINDEXES
Event "rebuild search indexes". |
static int |
EVENT_RESOURCE_AND_PROPERTIES_MODIFIED
Event "all properties (and so the resource itself, too) have been modified". |
static int |
EVENT_RESOURCE_COPIED
|
static int |
EVENT_RESOURCE_CREATED
|
static int |
EVENT_RESOURCE_DELETED
|
static int |
EVENT_RESOURCE_MODIFIED
Event "a single resource has been modified". |
static int |
EVENT_RESOURCE_MOVED
|
static int |
EVENT_RESOURCES_AND_PROPERTIES_MODIFIED
Event "a list of resources and their properties have been modified". |
static int |
EVENT_RESOURCES_MODIFIED
Event "a bunch of resources has been modified". |
static int |
EVENT_UPDATE_EXPORTS
Event "update exported resources". |
static int |
EVENT_USER_MODIFIED
Event "user modified". |
static java.lang.String |
KEY_CHANGE
Key name for passing a change int in the data map - see the CHANGED_XXX constants in CmsDriverManager . |
static java.lang.String |
KEY_DBCONTEXT
Key name for passing a database context in the data map. |
static java.lang.String |
KEY_GROUP_ID
Key name for passing a group ID. |
static java.lang.String |
KEY_GROUP_NAME
Key name for passing a group name. |
static java.lang.String |
KEY_INDEX_NAMES
Key name for passing a comma separated list of search index names in the data map. |
static java.lang.String |
KEY_OU_ID
Key name for passing an OU ID. |
static java.lang.String |
KEY_OU_NAME
Key name for passing a group name. |
static java.lang.String |
KEY_PROJECTID
Key name for passing a project id in the data map. |
static java.lang.String |
KEY_PUBLISHID
Key name for passing a publish history id in the data map. |
static java.lang.String |
KEY_PUBLISHLIST
Key name for passing a publish list in the data map. |
static java.lang.String |
KEY_REPORT
Key name for passing a report in the data map. |
static java.lang.String |
KEY_RESOURCE
Key name for passing a CmsResource in the data map. |
static java.lang.String |
KEY_RESOURCES
Key name for passing a List of CmsResource in the data map. |
static java.lang.String |
KEY_USER_ACTION
Key name for passing a user action. |
static java.lang.String |
KEY_USER_ID
Key name for passing an user ID. |
static java.lang.String |
KEY_USER_NAME
Key name for passing a user name. |
static java.lang.Integer |
LISTENERS_FOR_ALL_EVENTS
Marker for "all events". |
static java.lang.String |
VALUE_GROUP_MODIFIED_ACTION_CREATE
Value for the "group modified" action. |
static java.lang.String |
VALUE_GROUP_MODIFIED_ACTION_DELETE
Value for the "group modified" action. |
static java.lang.String |
VALUE_GROUP_MODIFIED_ACTION_WRITE
Value for the "group modified" action. |
static java.lang.String |
VALUE_OU_MODIFIED_ACTION_CREATE
Value for the "ou modified" action. |
static java.lang.String |
VALUE_OU_MODIFIED_ACTION_DELETE
Value for the "ou modified" action. |
static java.lang.String |
VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP
Value for the "user modified" action. |
static java.lang.String |
VALUE_USER_MODIFIED_ACTION_CREATE_USER
Value for the "user modified" action. |
static java.lang.String |
VALUE_USER_MODIFIED_ACTION_DELETE_USER
Value for the "user modified" action. |
static java.lang.String |
VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP
Value for the "user modified" action. |
static java.lang.String |
VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD
Value for the "user modified" action. |
static java.lang.String |
VALUE_USER_MODIFIED_ACTION_SET_OU
Value for the "user modified" action. |
static java.lang.String |
VALUE_USER_MODIFIED_ACTION_WRITE_USER
Value for the "user modified" action. |
Method Summary | |
---|---|
void |
cmsEvent(CmsEvent event)
Acknowledge the occurrence of the specified event, implement this method to check for CmsEvents in your class. |
Field Detail |
---|
static final int EVENT_BEFORE_PUBLISH_PROJECT
Event data:
KEY_REPORT
: a I_CmsReport
to print output messages toKEY_PUBLISHLIST
: a CmsPublishList
that contains the resources that are to be publishedKEY_PROJECTID
: the ID of the project that is to be publishedKEY_DBCONTEXT
: the current users database context
CmsPublishManager.publishProject(org.opencms.file.CmsObject)
,
EVENT_PUBLISH_PROJECT
,
Constant Field Valuesstatic final int EVENT_CLEAR_CACHES
Not thrown by the core classes, but might be used in modules.
static final int EVENT_CLEAR_OFFLINE_CACHES
Event data: none
static final int EVENT_CLEAR_ONLINE_CACHES
Event data: none
static final int EVENT_CLEAR_PRINCIPAL_CACHES
Not thrown by the core classes, but might be used in modules.
static final int EVENT_FLEX_CACHE_CLEAR
This is thrown on the "FlexCache Administration" page if you press
one ot the "Clear cache" buttons, or if you use the _flex=clearcache
request parameter.
static final int EVENT_FLEX_PURGE_JSP_REPOSITORY
This is thrown on the "FlexCache Administration" page if you press
the button "Purge JSP repository", or if you use the _flex=purge
request parameter.
static final int EVENT_FULLSTATIC_EXPORT
This is thrown in CmsStaticExportManager
.
Event data:
KEY_REPORT
: a I_CmsReport
to print output messages to
static final int EVENT_GROUP_MODIFIED
Includes create, write and delete group.
Event data:
static final int EVENT_LOGIN_USER
Event data:
CmsObject.loginUser(String, String)
,
Constant Field Valuesstatic final int EVENT_OU_MODIFIED
Includes create OU and delete OU.
Event data:
static final int EVENT_PROJECT_MODIFIED
Event data:
static final int EVENT_PROPERTY_DEFINITION_CREATED
Event data:
static final int EVENT_PROPERTY_DEFINITION_MODIFIED
Event data:
static final int EVENT_PROPERTY_MODIFIED
Event data:
static final int EVENT_PUBLISH_PROJECT
Event data:
KEY_REPORT
: a I_CmsReport
to print output messages toKEY_PUBLISHID
: the ID of the publish task in the publish historyKEY_PROJECTID
: the ID of the project that has been publishedKEY_DBCONTEXT
: the current users database context
CmsPublishManager.publishProject(org.opencms.file.CmsObject)
,
EVENT_BEFORE_PUBLISH_PROJECT
,
Constant Field Valuesstatic final int EVENT_REBUILD_SEARCHINDEXES
Event data:
KEY_REPORT
: a I_CmsReport
to print output messages toKEY_INDEX_NAMES
: a comma separated list of names of the search indexes to rebuild, empty for all indexes
static final int EVENT_RESOURCE_AND_PROPERTIES_MODIFIED
Event data:
static final int EVENT_RESOURCE_COPIED
EVENT_RESOURCES_MODIFIED
,
Constant Field Valuesstatic final int EVENT_RESOURCE_CREATED
EVENT_RESOURCE_AND_PROPERTIES_MODIFIED
,
Constant Field Valuesstatic final int EVENT_RESOURCE_DELETED
EVENT_RESOURCES_MODIFIED
,
Constant Field Valuesstatic final int EVENT_RESOURCE_MODIFIED
Event data:
static final int EVENT_RESOURCE_MOVED
EVENT_RESOURCE_CREATED
,
EVENT_RESOURCE_COPIED
,
EVENT_RESOURCE_DELETED
,
Constant Field Valuesstatic final int EVENT_RESOURCES_AND_PROPERTIES_MODIFIED
Event data:
static final int EVENT_RESOURCES_MODIFIED
Event data:
static final int EVENT_UPDATE_EXPORTS
This event updates all export points, deletes the content of the "export" folder, purges the JSP repository, and clears all caches.
This event is for internal use.
static final int EVENT_USER_MODIFIED
Event data:
static final java.lang.String KEY_CHANGE
CHANGED_XXX
constants in CmsDriverManager
.
static final java.lang.String KEY_DBCONTEXT
static final java.lang.String KEY_GROUP_ID
static final java.lang.String KEY_GROUP_NAME
static final java.lang.String KEY_INDEX_NAMES
static final java.lang.String KEY_OU_ID
static final java.lang.String KEY_OU_NAME
static final java.lang.String KEY_PROJECTID
static final java.lang.String KEY_PUBLISHID
static final java.lang.String KEY_PUBLISHLIST
static final java.lang.String KEY_REPORT
static final java.lang.String KEY_RESOURCE
CmsResource
in the data map.
static final java.lang.String KEY_RESOURCES
CmsResource
in the data map.
static final java.lang.String KEY_USER_ACTION
static final java.lang.String KEY_USER_ID
static final java.lang.String KEY_USER_NAME
static final java.lang.Integer LISTENERS_FOR_ALL_EVENTS
static final java.lang.String VALUE_GROUP_MODIFIED_ACTION_CREATE
static final java.lang.String VALUE_GROUP_MODIFIED_ACTION_DELETE
static final java.lang.String VALUE_GROUP_MODIFIED_ACTION_WRITE
static final java.lang.String VALUE_OU_MODIFIED_ACTION_CREATE
static final java.lang.String VALUE_OU_MODIFIED_ACTION_DELETE
static final java.lang.String VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP
static final java.lang.String VALUE_USER_MODIFIED_ACTION_CREATE_USER
static final java.lang.String VALUE_USER_MODIFIED_ACTION_DELETE_USER
static final java.lang.String VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP
static final java.lang.String VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD
static final java.lang.String VALUE_USER_MODIFIED_ACTION_SET_OU
static final java.lang.String VALUE_USER_MODIFIED_ACTION_WRITE_USER
Method Detail |
---|
void cmsEvent(CmsEvent event)
event
- CmsEvent that has occurred
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |