Package org.opencms.jsp.userdata
Interface I_CmsUserDataDomain
-
- All Superinterfaces:
I_CmsConfigurationParameterHandler
- All Known Implementing Classes:
CmsDefaultUserDataDomain
,CmsUserDataHeader
public interface I_CmsUserDataDomain extends I_CmsConfigurationParameterHandler
Interface for user data domains.A user data domain can provide information about users which have requested their user data. Several user data domains can be configured in opencms-system.xml. When requesting information, there are two types of scenarios:
- The user requests data with his email address.
- The user requests data with his user name and password.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
I_CmsUserDataDomain.Mode
Describes the different places from which the user data domain plugins can be used.
-
Field Summary
-
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
appendInfoHtml(CmsObject cms, CmsUserDataRequestType reqType, java.util.List<CmsUser> user, org.jsoup.nodes.Element element)
Appends the user data to the given HTML element.default void
appendlInfoForEmail(CmsObject cms, java.lang.String email, java.util.List<java.lang.String> searchStrings, org.jsoup.nodes.Element element)
Writes additional information related to an email address which is not directly associated with a specific OpenCms user.void
initialize(CmsObject cms)
Initializes the domain with an admin CmsObject.default boolean
isAvailableForMode(I_CmsUserDataDomain.Mode mode)
Checks if the plugin is available in the given mode.boolean
matchesUser(CmsObject cms, CmsUserDataRequestType reqType, CmsUser user)
Checks if the user matches the domain for the given user data request type.-
Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
addConfigurationParameter, getConfiguration, initConfiguration
-
-
-
-
Method Detail
-
appendInfoHtml
void appendInfoHtml(CmsObject cms, CmsUserDataRequestType reqType, java.util.List<CmsUser> user, org.jsoup.nodes.Element element)
Appends the user data to the given HTML element.- Parameters:
cms
- the CMS contextreqType
- the request type (email or single user)user
- the list of users (if the request type is singleUser, this has only one element)element
- the HTML element to append the data to
-
appendlInfoForEmail
default void appendlInfoForEmail(CmsObject cms, java.lang.String email, java.util.List<java.lang.String> searchStrings, org.jsoup.nodes.Element element)
Writes additional information related to an email address which is not directly associated with a specific OpenCms user.- Parameters:
cms
- the CMS contextemail
- the email address to checksearchStrings
- additional search strings entered by the userelement
- the element which the additional information should be appended to
-
initialize
void initialize(CmsObject cms)
Initializes the domain with an admin CmsObject.- Parameters:
cms
- a CmsObject
-
isAvailableForMode
default boolean isAvailableForMode(I_CmsUserDataDomain.Mode mode)
Checks if the plugin is available in the given mode.- Parameters:
mode
- the mode- Returns:
- true if the plugin is available
-
matchesUser
boolean matchesUser(CmsObject cms, CmsUserDataRequestType reqType, CmsUser user)
Checks if the user matches the domain for the given user data request type.- Parameters:
cms
- the CMS contextreqType
- the user data request type (email or single user)user
- the user- Returns:
- true if the domain matches the user
-
-