|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContentUrlGenerationRequest
Request object of the content URL generation filter chain that contains various parameters that might be required to generate a URL for a given content. The request also contains methods to share attributes between content URL generation filters.
ContentUrlGenerationFilter
,
ContentUrlGenerationFilterChain
This interface is designed to be implemented by clients. |
Method Summary | |
---|---|
boolean |
escapeXml()
Should characters reserved in XML be escaped in the URL generated. |
java.lang.Object |
getAttribute(java.lang.String name)
Returns the value of the named attribute as an Object , or
null if no attribute of the given name exists. |
java.util.Iterator<java.lang.String> |
getAttributeNames()
Returns an Iterator containing the names of the attributes
available to this request. |
java.lang.String |
getContentPath(boolean encode)
Get the name path of the content the URL should be generated for |
TargetPageConfig |
getDynamicTargetPageOverride()
Get the target page override that defines what should page be used to render the content the URL is generated for. |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters()
Get additional parameters. |
PortletContextSharingConfig |
getPortletContextSharingConfig()
The portlet context sharing configuration that determines how the rendering portlez receives and broadcast links with other portlets. |
javax.portlet.RenderRequest |
getPortletRenderRequest()
Get the portlet render request |
javax.portlet.RenderResponse |
getPortletRenderResponse()
Get the portlet render response |
java.lang.String |
getPresentationTemplateOverride()
Get the name path of the presentation template that should be used to render the content the URL is generated for. |
RenderingContext |
getRenderingContext()
Get the rendering context of the rendered content. |
void |
removeAttribute(java.lang.String name)
Removes an attribute from this request. |
void |
setAttribute(java.lang.String name,
java.lang.Object o)
Stores an attribute in this request. |
Method Detail |
---|
java.lang.String getContentPath(boolean encode)
encode
- Specify if the returned path should be URL encoded
null
e.g. for URLs that
only contain a prefixjava.lang.String getPresentationTemplateOverride()
null
if the
default presentation should be usedTargetPageConfig getDynamicTargetPageOverride()
getPortletContextSharingConfig()
.
null
javax.portlet.RenderRequest getPortletRenderRequest()
null
javax.portlet.RenderResponse getPortletRenderResponse()
null
PortletContextSharingConfig getPortletContextSharingConfig()
null
RenderingContext getRenderingContext()
null
java.util.Map<java.lang.String,java.lang.String[]> getParameters()
null
boolean escapeXml()
true
if characters reserved in XML should be escaped
in the URL generated.void setAttribute(java.lang.String name, java.lang.Object o)
null
, the effect is
the same as calling removeAttribute(java.lang.String)
.
name
- a String
specifying the name of the attributeo
- the Object
to be stored
java.lang.IllegalArgumentException
- if name is null
.java.lang.Object getAttribute(java.lang.String name)
Object
, or
null
if no attribute of the given name exists.
name
- a String
specifying the name of the attribute
Object
containing the value of the attribute, or
null
if the attribute does not exist.
java.lang.IllegalArgumentException
- if name is null
.void removeAttribute(java.lang.String name)
name
- a String
specifying the name of the attribute to
be removed
java.lang.IllegalArgumentException
- if name is null
.java.util.Iterator<java.lang.String> getAttributeNames()
Iterator
containing the names of the attributes
available to this request. This method returns an empty
Iterator
if the request has no attributes available to it.
Iterator
of strings containing the names of the
request attributes, or an empty Iterator
if the
request has no attributes available to it.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |