org.opencms.jsp.util

Class CmsJspElFunctions

java.lang.Object

org.opencms.jsp.util.CmsJspElFunctions

public final class CmsJspElFunctions
extends java.lang.Object

Provides utility methods to be used as functions from a JSP with the EL.

Since:

7.0.2

See Also:

CmsJspContentAccessBean

Method Summary

Methods

Modifier and Type	Method and Description
static CmsObject	convertCmsObject(java.lang.Object input) Returns an OpenCms user context created from an Object.
static java.util.Date	convertDate(java.lang.Object input) Returns a Date created from an Object.
static java.util.List<java.lang.Object>	convertList(java.util.List<java.lang.Object> input, java.lang.String attributeName) Returns a list of attribute values specified by the attribute name of the items of the given list.
static java.util.Locale	convertLocale(java.lang.Object input) Returns a Locale created from an Object.
static javax.servlet.ServletRequest	convertRequest(java.lang.Object input) Tries to convert the given input object into a request.
static CmsResource	convertResource(CmsObject cms, java.lang.Object input) Returns a resource created from an Object.
static CmsUUID	convertUUID(java.lang.Object input) Returns a CmsUUID created from an Object.
static java.lang.String	escape(java.lang.String source, java.lang.String encoding) Encodes a String in a way that is compatible with the JavaScript escape function.
static CmsObject	getCmsObject(java.lang.Object input) Returns the current OpenCms user context from the given page context.
static java.lang.Integer	getListSize(java.util.List<java.lang.Object> input) Returns the size of the given list.
static java.lang.String	getNavigationUri(java.lang.Object input) Returns the current navigation URI.
static java.lang.String	getRequestLink(java.lang.String url) Returns the link without parameters from a String that is formatted for a GET request.
static java.lang.String	getRequestParam(java.lang.String url, java.lang.String paramName) Returns the value of a parameter from a String that is formatted for a GET request.
static CmsJspVfsAccessBean	getVfsAccessBean(java.lang.Object input) Returns a JSP / EL VFS access bean.
static java.lang.String	lookup(java.lang.String key, java.lang.String map) Looks up the given key from the map that is passed as a String, and returns either the element found or the empty String.
static java.lang.String	lookup(java.lang.String key, java.lang.String map, java.lang.String defaultValue) Looks up the given key from the map that is passed as a String, and returns either the element found or the default value.
static java.lang.String	stripHtml(java.lang.Object input) Strips all HTML markup from the given input.
static java.lang.String	trimToSize(java.lang.String input, int length) Returns a substring of the source, which is at most length characters long.
static java.lang.String	unescape(java.lang.String source, java.lang.String encoding) Decodes a String in a way that is compatible with the JavaScript unescape function.

Methods inherited from class java.lang.Object

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

Method Detail

convertCmsObject

public static CmsObject convertCmsObject(java.lang.Object input)

Returns an OpenCms user context created from an Object.

• If the input is already a CmsObject, it is casted and returned unchanged.
• If the input is a ServletRequest, the OpenCms user context is read from the request context.
• If the input is a PageContext, the OpenCms user context is read from the request of the page context.
• Otherwise the input is converted to a String which should be a user name, and creation of a OpenCms user context with this name is attempted. Please note that this will only work if the user name is either the "Guest" user or the "Export" user.
• If no valid OpenCms user context could be created with all of the above, then a new user context for the "Guest" user is created.

Parameters:

input - the input to create an OpenCms user context from

Returns:

an OpenCms user context created from an Object

convertDate

public static java.util.Date convertDate(java.lang.Object input)

Returns a Date created from an Object.

• The Object is first checked if it is a Date already, if so it is casted and returned unchanged.
• If not, the input is checked if it is a Long, and if so the Date is created from the Long value.
• If it's not a Date and not a Long, the Object is transformed to a String and then it's tried to parse a Long out of the String.
• If this fails, it is tried to parse as a Date using the default date formatting.
• If this also fails, a new Date is returned that has been initialized with 0.

Parameters:

input - the Object to create a Date from

Returns:

a Date created from the given Object

convertList

public static java.util.List<java.lang.Object> convertList(java.util.List<java.lang.Object> input,
                                           java.lang.String attributeName)

Returns a list of attribute values specified by the attribute name of the items of the given list.

Parameters:

input - the list of objects to obtain the attribute values from

attributeName - the name of the attribute to obtain

Returns:

a list of attributes specified by the attribute name of the items of the given list

convertLocale

public static java.util.Locale convertLocale(java.lang.Object input)

Returns a Locale created from an Object.

• The Object is first checked if it is a Locale already, if so it is casted and returned.
• If not, the input is transformed to a String and then a Locale lookup with this String is done.
• If the locale lookup fails, the OpenCms default locale is returned.

Parameters:

input - the Object to create a Locale from

Returns:

a Locale created from the given Object

convertRequest

public static javax.servlet.ServletRequest convertRequest(java.lang.Object input)

Tries to convert the given input object into a request.

This is only possible if the input object is already a request or if it is a page context.

If everything else, this method returns null.

Parameters:

input - the input object to convert to a request

Returns:

a request object, or null

convertResource

public static CmsResource convertResource(CmsObject cms,
                          java.lang.Object input)
                                   throws CmsException

Returns a resource created from an Object.

• If the input is already a CmsResource, it is casted to the resource and returned unchanged.
• If the input is a String, the given OpenCms context is used to read a resource with this name from the VFS.
• If the input is a CmsUUID, the given OpenCms context is used to read a resource with this UUID from the VFS.
• Otherwise the input is converted to a String, and then the given OpenCms context is used to read a resource with this name from the VFS.

Parameters:

cms - the current OpenCms user context

input - the input to create a resource from

Returns:

a resource created from the given Object

Throws:

CmsException - in case of errors accessing the OpenCms VFS for reading the resource

convertUUID

public static CmsUUID convertUUID(java.lang.Object input)

Returns a CmsUUID created from an Object.

• The Object is first checked if it is a CmsUUID already, if so it is casted and returned.
• If not, the input is transformed to a byte[] and a new CmsUUID is created with this byte[].
• Otherwise the input is casted to a String and a new CmsUUID is created with this String.

Parameters:

input - the Object to create a CmsUUID from

Returns:

a CmsUUID created from the given Object

escape

public static java.lang.String escape(java.lang.String source,
                      java.lang.String encoding)

Encodes a String in a way that is compatible with the JavaScript escape function.

Parameters:

source - The text to be encoded

encoding - the encoding type

Returns:

The JavaScript escaped string

getCmsObject

public static CmsObject getCmsObject(java.lang.Object input)

Returns the current OpenCms user context from the given page context.

Parameters:

input - the input to create a CmsObject from

Returns:

the current OpenCms user context from the given page context

getListSize

public static java.lang.Integer getListSize(java.util.List<java.lang.Object> input)

Returns the size of the given list.

Parameters:

input - the list of objects to obtain the size from

Returns:

the size of the given list

getNavigationUri

public static java.lang.String getNavigationUri(java.lang.Object input)

Returns the current navigation URI.

Which can be the request URI or the VFS resource URI.

In case a sitemap is used, the navigation URI will be the request URI, if not the VFS resource URI is returned.

Parameters:

input - the request convertible object to get the navigation URI from

Returns:

the current navigation URI

getRequestLink

public static java.lang.String getRequestLink(java.lang.String url)

Returns the link without parameters from a String that is formatted for a GET request.

Parameters:

url - the URL to remove the parameters from

Returns:

the link without parameters

getRequestParam

public static java.lang.String getRequestParam(java.lang.String url,
                               java.lang.String paramName)

Returns the value of a parameter from a String that is formatted for a GET request.

Parameters:

url - the URL to get the parameter value from

paramName - the request parameter name

Returns:

the value of the parameter

getVfsAccessBean

public static CmsJspVfsAccessBean getVfsAccessBean(java.lang.Object input)

Returns a JSP / EL VFS access bean.

Parameters:

input - the Object to create a CmsObject from

Returns:

a JSP / EL VFS access bean

lookup

public static java.lang.String lookup(java.lang.String key,
                      java.lang.String map)

Looks up the given key from the map that is passed as a String, and returns either the element found or the empty String.

The map String must have the form "key1:value1|key2:value2" etc.

Parameters:

key - the key to look up

map - the map represented as a String

Returns:

the element found in the map with the given key, or the empty String

lookup

public static java.lang.String lookup(java.lang.String key,
                      java.lang.String map,
                      java.lang.String defaultValue)

Looks up the given key from the map that is passed as a String, and returns either the element found or the default value.

The map String must have the form "key1:value1|key2:value2" etc.

Parameters:

key - the key to look up

map - the map represented as a String

defaultValue - the default value

Returns:

the element found in the map with the given key, or the default value

stripHtml

public static java.lang.String stripHtml(java.lang.Object input)

Strips all HTML markup from the given input.

• In case the input is an instance of CmsJspContentAccessValueWrapper, an optimized method is used for the HTML stripping.
• Otherwise the input is converted to a String and this String is stripped.

Parameters:

input - the input to Strip from HTML

Returns:

the given input with all HTML stripped.

trimToSize

public static java.lang.String trimToSize(java.lang.String input,
                          int length)

Returns a substring of the source, which is at most length characters long.

If a char is cut, " ..." is appended to the result.

Parameters:

input - the string to trim

length - the maximum length of the string to be returned

Returns:

a substring of the source, which is at most length characters long

See Also:

CmsStringUtil.trimToSize(String, int, String)

unescape

public static java.lang.String unescape(java.lang.String source,
                        java.lang.String encoding)

Decodes a String in a way that is compatible with the JavaScript unescape function.

Parameters:

source - The String to be decoded

encoding - the encoding type

Returns:

The JavaScript unescaped String