|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContentPageResolutionResponse
The ContentPageResolutionResponse
is passed to the resolve method of the
ContentPageResolutionFilter
. It
enables filters to read and write information used to control the resolution, for example:
This interface is designed to be implemented by clients. |
Method Summary | |
---|---|
java.util.List<ObjectID> |
getCandidatePageIds()
Returns an unmodifiable List of candidate Portal pages that should be used to resolve a Portal page. |
java.lang.String |
getContentPath()
Returns the path of the content to be rendered after the resolution process. |
ObjectID |
getPageID()
Returns the ObjectID of the currently resolved Portal page that is to be displayed
when rendering the content identified by getContentPath() . |
java.lang.String |
getPresentationTemplatePath()
Returns the path of the presentation template previously set via setPresentationTemplatePath(String) . |
java.util.Map<java.lang.String,java.lang.String[]> |
getResolutionResponseParameters()
Returns any additional context parameters that are required to perform the resolution. |
boolean |
isAuthenticationRequired()
Returns true if and only if the following conditions are met:
The user is not authenticated yet.
The filter chain has not determined a Portal page to show, that is, getPageID() returns null .
The filter chain might return a Portal page for an authenticated user, that is, there are matching Portal pages but the anonymous user
is not authorised to access them.
|
void |
setAuthenticationRequired(boolean requiresAuthentication)
Indicates that no Portal pages were found to handle the content for the anonymous user, but protected Portal pages were found that might be available to an authenticated user to render the addressed content. |
void |
setCandidatePageIds(java.util.List<ObjectID> pages)
Sets the list of candidate Portal pages that must be used to determine the resolved Portal page from. |
void |
setContentPath(java.lang.String contentPath)
Sets the path of the content to be rendered after the resolution process. |
void |
setPageID(ObjectID pageId)
Sets the ObjectID of the Portal page that should be invoked to render the given content after the resolution process. |
void |
setPresentationTemplatePath(java.lang.String templatePath)
Sets the path of the presentation template to be used when rendering the addressed content after the resolution process. |
Method Detail |
---|
java.lang.String getContentPath()
void setContentPath(java.lang.String contentPath)
contentPath
- the path of the content to renderjava.lang.String getPresentationTemplatePath()
setPresentationTemplatePath(String)
.
null
void setPresentationTemplatePath(java.lang.String templatePath)
ContentPageResolutionFilter
to modify or override the presentation template.
templatePath
- the path of the presentation template in the form <libraryName>/<presentationTemplateName>
ObjectID getPageID()
ObjectID
of the currently resolved Portal page that is to be displayed
when rendering the content identified by getContentPath()
.
ObjectID
of the Portal page to be used to render the content or null
if none has been determined yetvoid setPageID(ObjectID pageId)
ObjectID
of the Portal page that should be invoked to render the given content after the resolution process.
pageId
- the ID of the Portal page to be used to render the contentjava.util.List<ObjectID> getCandidatePageIds()
List
of candidate Portal pages that should be used to resolve a Portal page.
If this method returns a non-empty List
it must be guaranteed that in case a resolved Portal page was
determined as defined by getPageID()
that the ID of this Portal page is contained in this List
.
List
of IDs of candidate Portal pages or null
void setCandidatePageIds(java.util.List<ObjectID> pages)
pages
- the List
of IDs of candidate pages pages or null
java.util.Map<java.lang.String,java.lang.String[]> getResolutionResponseParameters()
ContentPageResolutionRequest.getResolutionParameters()
this Map
is modifiable.
The parameters from this Map
can be used in the final dispatching of the request.
Map
containing additional resolution parametersboolean isAuthenticationRequired()
true
if and only if the following conditions are met:
getPageID()
returns null
.
true
if at least one protected Portal page but no unprotected Portal page is available to render the contentvoid setAuthenticationRequired(boolean requiresAuthentication)
requiresAuthentication
- true
if there are protected Portal pages available to render the addressed content
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |