Class CmsConfigParserUtils
- java.lang.Object
-
- org.opencms.jsp.search.config.parser.simplesearch.CmsConfigParserUtils
-
public final class CmsConfigParserUtils extends java.lang.Object
Utils to read and update the list configuration.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
N_BLACKLIST
List configuration node name and field key.static java.lang.String
N_CATEGORY
List configuration node name and field key.static java.lang.String
N_CATEGORY_MODE
List configuration node name for the category mode.static java.lang.String
N_DATE_RESTRICTION
XML content node name.static java.lang.String
N_DISPLAY_TYPE
List configuration node name and field key.static java.lang.String
N_FILTER_MULTI_DAY
List configuration node name and field key.static java.lang.String
N_FILTER_QUERY
List configuration node name and field key.static java.lang.String
N_GEO_FILTER
List configuration node name and field key.static java.lang.String
N_KEY
List configuration node name and field key.static java.lang.String
N_MAX_RESULTS
List configuration node name and field key.static java.lang.String
N_PARAMETER
List configuration node name and field key.static java.lang.String
N_PRECONFIGURED_FILTER_QUERY
List configuration node name and field key.static java.lang.String
N_RADIUS
List configuration node name and field key.static java.lang.String
N_RULE
List configuration node name and field key.static java.lang.String
N_SEARCH_FOLDER
List configuration node name and field key.static java.lang.String
N_SHOW_EXPIRED
List configuration node name and field key.static java.lang.String
N_SORT_ORDER
List configuration node name and field key.static java.lang.String
N_TITLE
List configuration node name and field key.static java.lang.String
N_VALUE
List configuration node name and field key.static java.lang.String[]
PARAMETER_FIELDS
The parameter fields.
-
Constructor Summary
Constructors Constructor Description CmsConfigParserUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CmsConfigurationBean
parseListConfiguration(CmsObject cms, CmsResource res)
Parses the list configuration resource.static CmsXmlContent
updateBlackList(CmsObject cms, CmsXmlContent content, CmsConfigurationBean configBean)
Updates the black list entries in the provided xml content.
-
-
-
Field Detail
-
N_BLACKLIST
public static final java.lang.String N_BLACKLIST
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_CATEGORY
public static final java.lang.String N_CATEGORY
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_CATEGORY_MODE
public static final java.lang.String N_CATEGORY_MODE
List configuration node name for the category mode.- See Also:
- Constant Field Values
-
N_DATE_RESTRICTION
public static final java.lang.String N_DATE_RESTRICTION
XML content node name.- See Also:
- Constant Field Values
-
N_DISPLAY_TYPE
public static final java.lang.String N_DISPLAY_TYPE
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_FILTER_MULTI_DAY
public static final java.lang.String N_FILTER_MULTI_DAY
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_FILTER_QUERY
public static final java.lang.String N_FILTER_QUERY
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_GEO_FILTER
public static final java.lang.String N_GEO_FILTER
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_KEY
public static final java.lang.String N_KEY
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_PARAMETER
public static final java.lang.String N_PARAMETER
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_RADIUS
public static final java.lang.String N_RADIUS
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_SEARCH_FOLDER
public static final java.lang.String N_SEARCH_FOLDER
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_SHOW_EXPIRED
public static final java.lang.String N_SHOW_EXPIRED
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_SORT_ORDER
public static final java.lang.String N_SORT_ORDER
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_TITLE
public static final java.lang.String N_TITLE
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_VALUE
public static final java.lang.String N_VALUE
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_MAX_RESULTS
public static final java.lang.String N_MAX_RESULTS
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_PRECONFIGURED_FILTER_QUERY
public static final java.lang.String N_PRECONFIGURED_FILTER_QUERY
List configuration node name and field key.- See Also:
- Constant Field Values
-
N_RULE
public static final java.lang.String N_RULE
List configuration node name and field key.- See Also:
- Constant Field Values
-
PARAMETER_FIELDS
public static final java.lang.String[] PARAMETER_FIELDS
The parameter fields.
-
-
Constructor Detail
-
CmsConfigParserUtils
public CmsConfigParserUtils()
-
-
Method Detail
-
parseListConfiguration
public static CmsConfigurationBean parseListConfiguration(CmsObject cms, CmsResource res)
Parses the list configuration resource.- Parameters:
cms
- the CMS context to useres
- the list configuration resource- Returns:
- the configuration data bean
-
updateBlackList
public static CmsXmlContent updateBlackList(CmsObject cms, CmsXmlContent content, CmsConfigurationBean configBean)
Updates the black list entries in the provided xml content.- Parameters:
cms
- the cms context.content
- the xml content to update (must be of type list_config)configBean
- the config bean to get the blacklist entries from.- Returns:
- the updated content (update is in-place).
-
-