Package org.hippoecm.hst.core.request
Interface ResolvedMount
-
- All Known Subinterfaces:
MutableResolvedMount
public interface ResolvedMountImplementations of this interface are a request flyweight instance of theMountobject, where possible wildcard property placeholders have been filled in, similar to theResolvedSiteMapItemandHstSiteMapItem
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetFormLoginPage()Returns FORM Login PageStringgetMatchingIgnoredPrefix()Expert: In most circumstance, thisgetMatchingIgnoredPrefix()will returnnull.MountgetMount()StringgetNamedPipeline()intgetPortNumber()StringgetResolvedMountPath()Returns the mountPath from the backingMountwhere possible wildcard values might have been replaced.Set<String>getRoles()Returns the roles that are allowed to access this Mount whenisAuthenticated()is true.Set<String>getUsers()Returns the users that are allowed to access this Mount whenisAuthenticated()is true.booleanisAuthenticated()If this method returns true, then only if the user is explicitly allowed orservletRequest.isUserInRole(role)returnstruethis Mount is accessible for the request.booleanisSessionStateful()Returns true if subject based jcr session should be statefully managed.booleanisSubjectBasedSession()Returns true if subject based jcr session should be used for this MountResolvedSiteMapItemmatchSiteMapItem(String siteMapPathInfo)matches a pathInfo to aResolvedSiteMapItemitem or throws aMatchExceptionorNotFoundExceptionwhen cannot resolve to a sitemap item
-
-
-
Method Detail
-
getPortNumber
int getPortNumber()
- Returns:
- the port number of the host that was used during matching to this
ResolvedMount
-
getMount
Mount getMount()
- Returns:
- the backing request independent
Mountitem for thisResolvedMountinstance
-
getNamedPipeline
String getNamedPipeline()
- Returns:
- the named pipeline to be used for this
Mountornullwhen the default pipeline is to be used
-
getResolvedMountPath
String getResolvedMountPath()
Returns the mountPath from the backingMountwhere possible wildcard values might have been replaced. ArootMountreturns an emptyString(""). When the mountPath is non-empty, it always starts with a"/".- Returns:
- the resolved mountPath for this
ResolvedMount - See Also:
Mount.getMountPath()
-
getMatchingIgnoredPrefix
String getMatchingIgnoredPrefix()
Expert: In most circumstance, thisgetMatchingIgnoredPrefix()will returnnull. Only when there was a pathInfo prefix after theHttpServletRequest.getContextPath()that should be ignored during matching the request to aResolvedMount, this method returns the ignored prefix. The returned String must have leading and trailing slashes all removed.- Returns:
- the prefix that was ignore during matching and
nullif there wasn't a ignored prefix
-
matchSiteMapItem
ResolvedSiteMapItem matchSiteMapItem(String siteMapPathInfo) throws MatchException
matches a pathInfo to aResolvedSiteMapItemitem or throws aMatchExceptionorNotFoundExceptionwhen cannot resolve to a sitemap item- Parameters:
siteMapPathInfo-- Returns:
- the ResolvedSiteMapItem for the current hstContainerURL
- Throws:
MatchException
-
isAuthenticated
boolean isAuthenticated()
If this method returns true, then only if the user is explicitly allowed orservletRequest.isUserInRole(role)returnstruethis Mount is accessible for the request. If a Mount does not have a configuration for authenticated, the value from the parent item is taken.- Returns:
trueif the Mount is authenticated.
-
getRoles
Set<String> getRoles()
Returns the roles that are allowed to access this Mount whenisAuthenticated()is true. If the Mount does not have any roles defined by itself, it inherits them from the parent. If it defines roles, the roles from any ancestor are ignored. An empty set of roles in combination withisAuthenticated()returntruemeans nobody has access to the item- Returns:
- The set of roles that are allowed to access this Mount. When no roles defined, the roles from the parent item are inherited. If none of the parent items have a role defined, an empty set is returned
-
getUsers
Set<String> getUsers()
Returns the users that are allowed to access this Mount whenisAuthenticated()is true. If the Mount does not have any users defined by itself, it inherits them from the parent. If it defines users, the users from any ancestor are ignored. An empty set of users in combination withisAuthenticated()returntruemeans nobody has access to the item- Returns:
- The set of users that are allowed to access this Mount. When no users defined, the users from the parent item are inherited. If none of the parent items have a user defined, an empty set is returned
-
isSubjectBasedSession
boolean isSubjectBasedSession()
Returns true if subject based jcr session should be used for this Mount- Returns:
- true if subject based jcr session should be used for this Mount
-
isSessionStateful
boolean isSessionStateful()
Returns true if subject based jcr session should be statefully managed.- Returns:
- true if subject based jcr session should be statefully managed.
-
getFormLoginPage
String getFormLoginPage()
Returns FORM Login Page- Returns:
trueif the Mount is authenticated.
-
-