org.jahia.utils.security

Interface PathWrapper

All Known Implementing Classes:

JahiaJCRPathWrapperImpl

public interface PathWrapper

This interface is used to manage paths in AccessManagerUtils, since it have to deal with both JCR and external API JCR Access controls use Path internally External API Access controls use String internally The Wrapper is here to provide functions on top of both representations

Author:

jkevan

Method Summary

Modifier and Type	Method and Description
PathWrapper	getAncestor() Get the direct parent path wrapped
Object	getInnerObject() get the original object behind the wrapper
javax.jcr.Item	getItem() Get the item for the current path in the wrapper
int	getLength() get the length of the current path in the wrapper
PathWrapper	getNewPathWrapper(String path) Get a new wrapped path
String	getNodeName() Get the node name for the current path in the wrapper
String	getPathStr() Get the string representation of the current path in the wrapper
boolean	isRoot() Check if the current path in the wrapper is the root path
boolean	itemExist() Check if the item exist for the current path in the wrapper

Method Detail

getInnerObject

Object getInnerObject()

get the original object behind the wrapper

Returns:

The original path object

getLength

int getLength()

get the length of the current path in the wrapper

Returns:

the length of the path

isRoot

boolean isRoot()

Check if the current path in the wrapper is the root path

Returns:

true if the current path is root

getPathStr

String getPathStr()

Get the string representation of the current path in the wrapper

Returns:

the string representation of the path

getNodeName

String getNodeName()
            throws javax.jcr.NamespaceException

Get the node name for the current path in the wrapper

Returns:

the node name

Throws:

javax.jcr.NamespaceException

itemExist

boolean itemExist()
           throws javax.jcr.RepositoryException

Check if the item exist for the current path in the wrapper

Returns:

true if the item exist

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

getItem

javax.jcr.Item getItem()
                throws javax.jcr.RepositoryException

Get the item for the current path in the wrapper

Returns:

the item

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

getAncestor

PathWrapper getAncestor()
                 throws javax.jcr.RepositoryException

Get the direct parent path wrapped

Returns:

the parent path wrapper

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

getNewPathWrapper

PathWrapper getNewPathWrapper(String path)
                       throws javax.jcr.RepositoryException

Get a new wrapped path

Parameters:

path - the path to be wrapped

Returns:

the wrapped path

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors