Package org.opencms.jsp.util

Class CmsJspLinkWrapper

java.lang.Object

java.util.AbstractCollection<String>

org.opencms.jsp.util.CmsJspLinkWrapper

All Implemented Interfaces:

Iterable<String>, Collection<String>

public class CmsJspLinkWrapper
extends AbstractCollection<String>

Wrapper for handling links in template/formatter JSP EL.

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsObject	m_cms	Stored CMS context.
protected Boolean	m_internal	Cached internal/external state.
protected String	m_link	The link literal from which this wrapper was created.
protected Optional<CmsResource>	m_resource	Cached link target resource.
protected Map<String,String>	m_stringCache	Cached links (online, perma, server).

Constructor Summary

Constructors

Constructor	Description
CmsJspLinkWrapper(CmsObject cms, String link)	Creates a new link wrapper.
CmsJspLinkWrapper(CmsObject cms, String link, boolean allowEmpty)	Creates a new link wrapper.
CmsJspLinkWrapper(CmsObject cms, CmsResource resource)	Creates a new link wrapper for a specific resource.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	getIsExternal()	Checks if the link is 'external', which is not just the opposite of 'internal', in this case.
boolean	getIsInternal()	Returns true if the link is internal.
String	getLink()	Performs normal link substitution.
String	getLiteral()	Gets the literal from which this wrapper was constructed.
String	getOnlineLink()	Performs online link substitution.
String	getPermaLink()	Performs permalink substitution.
CmsJspResourceWrapper	getResource()	Gets the resource wrapper for the link target.
String	getServerLink()	Performs server link substitution.
String	getToString()	Returns the wrapped link as a String as in toString().
URI	getToURI()	Converts the wrapped string to an URI object and returns it.
int	hashCode()
boolean	isEmpty()	Returns true if the wrapped link has been initialized.
Iterator<String>	iterator()
int	size()
String	toString()	Returns the wrapped link as a String as in getLink().
URI	toURI()	Converts the wrapped string to an URI object and returns it.

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, contains, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Details

m_cms

protected CmsObject m_cms

Stored CMS context.

m_internal

protected Boolean m_internal

Cached internal/external state.

m_link

protected String m_link

The link literal from which this wrapper was created.

m_resource

protected Optional<CmsResource> m_resource

Cached link target resource.

m_stringCache

protected Map<String,String> m_stringCache

Cached links (online, perma, server).

Constructor Details

CmsJspLinkWrapper

public CmsJspLinkWrapper(CmsObject cms,
 CmsResource resource)

Creates a new link wrapper for a specific resource.

Parameters:

cms - the CMS context

resource - the resource to link to

CmsJspLinkWrapper

public CmsJspLinkWrapper(CmsObject cms,
 String link)

Creates a new link wrapper.

The link parameter should be in the same format that you enter in an XML content of field of type OpenCmsVarLink, i.e. either a full external URL or a site path with a query string attached.

Parameters:

cms - the CMS context

link - the link to wrap

CmsJspLinkWrapper

public CmsJspLinkWrapper(CmsObject cms,
 String link,
 boolean allowEmpty)

Creates a new link wrapper.

The link parameter should be in the same format that you enter in an XML content of field of type OpenCmsVarLink, i.e. either a full external URL or a site path with a query string attached.

Parameters:

cms - the CMS context

link - the link to wrap

allowEmpty - if true then empty links are allowed

Method Details

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<String>

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

getIsExternal

public boolean getIsExternal()

Checks if the link is 'external', which is not just the opposite of 'internal', in this case.

A link is external if it's either an internal link pointing to a different site, or a link to a location outside OpenCms, unless the domain is listed in the sitemap attribute 'template.editor.links.externalWhitelist' for the current subsite.

Returns:

the 'external' status of the link

getIsInternal

public boolean getIsInternal()

Returns true if the link is internal.

Returns:

true if the link is internal

getLink

public String getLink()

Performs normal link substitution.

Returns:

the substituted link

getLiteral

public String getLiteral()

Gets the literal from which this wrapper was constructed.

Returns:

the original link literal

getOnlineLink

public String getOnlineLink()

Performs online link substitution.

Returns:

the online link

getPermaLink

public String getPermaLink()

Performs permalink substitution.

Returns:

the permalink

getResource

public CmsJspResourceWrapper getResource()

Gets the resource wrapper for the link target.

Returns:

the resource wrapper for the target

getServerLink

public String getServerLink()

Performs server link substitution.

Returns:

the server link

getToString

public String getToString()

Returns the wrapped link as a String as in toString().

Returns:

the wrapped link as a String

getToURI

public URI getToURI()

Converts the wrapped string to an URI object and returns it.

If the wrapped string cannont be converted, returns null.

Returns:

the URI object for the wrapped string, or null if conversion fails

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<String>

Overrides:

hashCode in class Object

See Also:

• Collection.hashCode()

isEmpty

public boolean isEmpty()

Returns true if the wrapped link has been initialized.

Specified by:

isEmpty in interface Collection<String>

Overrides:

isEmpty in class AbstractCollection<String>

Returns:

true if the wrapped link has been initialized

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Collection<String>

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in class AbstractCollection<String>

See Also:

• AbstractCollection.iterator()

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in class AbstractCollection<String>

See Also:

• AbstractCollection.size()

toString

public String toString()

Returns the wrapped link as a String as in getLink().

Overrides:

toString in class AbstractCollection<String>

Returns:

the wrapped link as a String

See Also:

• getLiteral()

toURI

public URI toURI()

Converts the wrapped string to an URI object and returns it.

If the wrapped string cannont be converted, returns null.

Returns:

the URI object for the wrapped string, or null if conversion fails