[
https://issues.apache.org/jira/browse/OAK-221?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13427324#comment-13427324
]
angela commented on OAK-221:
----------------------------
one more example that confused me:
NamePathMapperImpl#getOakPath(String jcrPath) contains the following shortcut:
if ("/".equals(jcrPath)) {
// avoid the need to special case the root path later on
return "/";
}
IMO that doesn't match the path exposed on Tree#getPath for the root node and
the example mentioned above where "" is used as path to access the root tree.
> Clarify nature of 'path' parameter in oak-api
> ---------------------------------------------
>
> Key: OAK-221
> URL: https://issues.apache.org/jira/browse/OAK-221
> Project: Jackrabbit Oak
> Issue Type: Bug
> Components: core
> Reporter: angela
>
> imo the oak-api should be more specific about the nature of the
> path parameter that is passed to methods like Root#getTree, #move, #copy
> and that is returned by methods like Tree#getPath.
> The api documentation consistently states that those paths are "relative to
> the 'root' but when looking at the code i rather get the impression that
> they are absolute paths such as defined by the JCR API.
> for example:
> SessionDelegate#getNode(String path) just passes the path to the oak-api
> without making it 'relative to the root'.
> on the other hand SessionDelegate#getRoot() passes an ""-path to Root#getTree.
> another example:
> SessionDelegate#getNodeByIdentifier starts like follows:
> if (id.startsWith("/")) {
> Tree tree = getTree(id);
> [...]
> so, again the absolute jcr path is passed into the oak-api.
> requested action:
> - clarify oak-api
> - check all usages of oak-api and make api calls consistent
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
