public interface IHierarchicalUri extends IUri
remainder ::= '//' authority abspath query abspath ::= '/' pathsegment | empty pathsegment ::= name | name '/' pathsegment | empty query ::= '?' uri-characters | emptyCopyright (c) SAP AG 2001-2004
Modifier and Type | Method and Description |
---|---|
IHierarchicalUri |
appendPath(String path)
Append the given path segment to the current path of this uri.
|
String |
getAuthority()
Return authority part of this hierarchical Uri.
|
String |
getPath()
Return path of this Uri or, if not there, the emtpy string
|
String[] |
getPathSegments()
Return the segments of the uri path
|
String |
getQuery()
Return query of this Uri in RFC 2396 encoded form or, if not there, null
|
IHierarchicalUri |
getRoot()
Returns the uri of the root collection (path = "/").
|
boolean |
isAncestorOf(IHierarchicalUri other)
Determine if this Uri is ancestor of other uri
|
IUriReference |
mapToAbsolutePath(IUriReference ref)
Given this Uri as the base, map the uri reference to a uri reference with
absolute path component.
|
IUriReference |
mapToAbsolutePath(RID wcmPath) |
IUriReference |
mapToAbsolutePath(RID wcmPath,
URICodec codec) |
IUriReference |
mapToAbsolutePath(URI wcmPath)
Deprecated.
As of EP5 SP6, replaced by
mapToAbsolutePath(RID)
Given this Uri as the base of the WCM repository, map the WCM Path to a uri
reference with absolute path component. Example: "http://host/docs" + "test 3", gives "/docs/test%203" Example: "http://host/docs" + "/fs/test", gives "/docs/fs/test" |
IUriReference |
mapToAbsolutePath(URI wcmPath,
URICodec codec)
Deprecated.
As of EP5 SP6, replaced by
mapToAbsolutePath(RID, URICodec)
Given this Uri as the base of the WCM repository, map the WCM Path to a uri
reference with absolute path component. Example: "http://host/docs" + "test 3", gives "/docs/test%203" Example: "http://host/docs" + "/fs/test", gives "/docs/fs/test" |
IHierarchicalUri |
mapToAbsoluteUri(RID wcmPath)
Given this RID as the base of the WCM repository, map the WCM Path to a
absolute RID.
|
IHierarchicalUri |
mapToAbsoluteUri(RID wcmPath,
URICodec codec)
Given this RID as the base of the WCM repository, map the WCM Path to a
absolute uri
|
IHierarchicalUri |
mapToAbsoluteUri(URI wcmPath)
Deprecated.
As of EP5 SP6, replaced by
mapToAbsoluteUri(RID)
Given this Uri as the base of the WCM repository, map the WCM Path to a
absolute uri. Example: "http://host/docs" + "test 3", gives "http://host/docs/test%203" Example: "http://host/docs" + "/fs/test", gives "http://host/docs/fs/test" |
IHierarchicalUri |
mapToAbsoluteUri(URI wcmPath,
URICodec codec)
Deprecated.
As of EP5 SP6, replaced by
mapToAbsoluteUri(RID, URICodec)
Given this Uri as the base of the WCM repository, map the WCM Path to a
absolute uri. Example: "http://host/docs" + "test 3", gives "http://host/docs/test%203" Example: "http://host/docs" + "/fs/test", gives "http://host/docs/fs/test" |
RID |
mapToResourceID(IUriReference ref)
Given this Uri as the base of the WCM repository, map the Uri Reference to
the corresponding RID in the framework.
|
RID |
mapToResourceID(IUriReference ref,
URICodec codec)
Given this Uri as the base of the WCM repository, map the Uri Reference to
the corresponding RID in the framework.
|
URI |
mapToWcmPath(IUriReference ref)
Deprecated.
As of EP5 SP6, replaced by
mapToResourceID(IUriReference)
Given this Uri as the base of the WCM repository, map the Uri Reference to
the corresponding WCM Path in the framework. Example: "http://host/docs" + "/docs/test%203", gives "/test 3" Example: "http://host/docs" + "/xxx/test%203", gives null |
URI |
mapToWcmPath(IUriReference ref,
URICodec codec)
Deprecated.
As of EP5 SP6, replaced by
mapToResourceID(IUriReference, URICodec)
Given this Uri as the base of the WCM repository, map the Uri Reference to
the corresponding WCM Path in the framework. Example: "http://host/docs" + "/docs/test%203", gives "/test 3" Example: "http://host/docs" + "/xxx/test%203", gives null |
IHierarchicalUri |
setPath(String path)
Construct a new object of same type with the given path.
|
IHierarchicalUri |
setQuery(String query)
Construct a new object of same type with the given query.
|
IUriReference |
unresolve(IHierarchicalUri other,
String fragment)
Convert the given uri to a relative uri reference with this uri as base.
|
getRemainder, getScheme, resolve, toExternalForm
IHierarchicalUri appendPath(String path)
String getAuthority()
String getPath()
String[] getPathSegments()
String getQuery()
IHierarchicalUri getRoot()
boolean isAncestorOf(IHierarchicalUri other)
IUriReference unresolve(IHierarchicalUri other, String fragment)
other
- uri to unresolvefragment
- to add to result uri referenceURI mapToWcmPath(IUriReference ref)
mapToResourceID(IUriReference)
Given this Uri as the base of the WCM repository, map the Uri Reference to
the corresponding WCM Path in the framework. Example: "http://host/docs" + "/docs/test%203", gives "/test 3" Example: "http://host/docs" + "/xxx/test%203", gives null
ref
- the uri reference to mapnull
if not possibleRID mapToResourceID(IUriReference ref)
ref
- the uri reference to mapnull
if not possibleURI mapToWcmPath(IUriReference ref, URICodec codec)
mapToResourceID(IUriReference, URICodec)
Given this Uri as the base of the WCM repository, map the Uri Reference to
the corresponding WCM Path in the framework. Example: "http://host/docs" + "/docs/test%203", gives "/test 3" Example: "http://host/docs" + "/xxx/test%203", gives null
ref
- the uri reference to mapcodec
- to use for uri decodingnull
if not possibleRID mapToResourceID(IUriReference ref, URICodec codec)
ref
- the uri reference to mapcodec
- to use for uri decodingnull
if not possibleIUriReference mapToAbsolutePath(URI wcmPath)
mapToAbsolutePath(RID)
Given this Uri as the base of the WCM repository, map the WCM Path to a uri
reference with absolute path component. Example: "http://host/docs" + "test 3", gives "/docs/test%203" Example: "http://host/docs" + "/fs/test", gives "/docs/fs/test"
wcmPath
- to mapIUriReference mapToAbsolutePath(RID wcmPath)
IUriReference mapToAbsolutePath(URI wcmPath, URICodec codec)
mapToAbsolutePath(RID, URICodec)
Given this Uri as the base of the WCM repository, map the WCM Path to a uri
reference with absolute path component. Example: "http://host/docs" + "test 3", gives "/docs/test%203" Example: "http://host/docs" + "/fs/test", gives "/docs/fs/test"
wcmPath
- to mapcodec
- to use for uri encodingIUriReference mapToAbsolutePath(RID wcmPath, URICodec codec)
IUriReference mapToAbsolutePath(IUriReference ref)
Example: "http://host/docs" + "test%203", gives "/docs/test%203" Example: "http://host/docs" + "http://another/fs/test", gives "http://another/fs/test"
IHierarchicalUri mapToAbsoluteUri(URI wcmPath)
mapToAbsoluteUri(RID)
Given this Uri as the base of the WCM repository, map the WCM Path to a
absolute uri. Example: "http://host/docs" + "test 3", gives "http://host/docs/test%203" Example: "http://host/docs" + "/fs/test", gives "http://host/docs/fs/test"
wcmPath
- to mapIHierarchicalUri mapToAbsoluteUri(RID wcmPath)
wcmPath
- to mapIHierarchicalUri mapToAbsoluteUri(URI wcmPath, URICodec codec)
mapToAbsoluteUri(RID, URICodec)
Given this Uri as the base of the WCM repository, map the WCM Path to a
absolute uri. Example: "http://host/docs" + "test 3", gives "http://host/docs/test%203" Example: "http://host/docs" + "/fs/test", gives "http://host/docs/fs/test"
wcmPath
- to mapcodec
- to use for uri encodingIHierarchicalUri mapToAbsoluteUri(RID wcmPath, URICodec codec)
wcmPath
- to mapcodec
- to use for uri encodingIHierarchicalUri setQuery(String query)
null
, the new uri will be without query. The query string
must be in RFC 2396 encoded form. See UriQuery
for manipulation of
query strings.query
- encoded query string for returned objectIHierarchicalUri setPath(String path)
null
, the new uri will have the root path /. The path string must
be in RFC 2396 encoded form. See URICodec
. The query of the
resulting uri will always be empty.path
- encoded path string for returned objectAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice