com.sapportals.wcm.util.uri

Interface IHierarchicalUri

All Superinterfaces:

IUri

All Known Implementing Classes:

HttpUrl, ResourceUrl

public interface IHierarchicalUri
extends IUri

A RFC2396 URI interface.

    remainder   ::= '//' authority abspath query
    abspath     ::= '/' pathsegment | empty
    pathsegment ::= name | name '/' pathsegment | empty
    query       ::= '?' uri-characters | empty
 

Copyright (c) SAP AG 2001-2004

Method Summary

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)
IHierarchicalUri	mapToAbsoluteUri(RID wcmPath, URICodec codec)
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)
RID	mapToResourceID(IUriReference ref, URICodec codec)
URI	mapToWcmPath(IUriReference ref) Deprecated. As of EP5 SP6, replaced by #mapToResourceID(RID) 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(RID, 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.

Methods inherited from interface com.sapportals.wcm.util.uri.IUri

getRemainder, getScheme, resolve, toExternalForm

Method Detail

appendPath

IHierarchicalUri appendPath(String path)

Append the given path segment to the current path of this uri. Takes care of leading, trailing slashes. Note that the path must be uri encoded or the resulting uri is not valid.

Returns:

new uri with concatenated path

getAuthority

String getAuthority()

Return authority part of this hierarchical Uri.

Returns:

authority part of this hierarchical Uri

getPath

String getPath()

Return path of this Uri or, if not there, the emtpy string

Returns:

path of this uri

getPathSegments

String[] getPathSegments()

Return the segments of the uri path

Returns:

segments of uri path

getQuery

String getQuery()

Return query of this Uri in RFC 2396 encoded form or, if not there, null

Returns:

query of this uri in RFC 2396 encoded form or null

getRoot

IHierarchicalUri getRoot()

Returns the uri of the root collection (path = "/").

Returns:

uri of server root

isAncestorOf

boolean isAncestorOf(IHierarchicalUri other)

Determine if this Uri is ancestor of other uri

Returns:

if this Uri is ancestor of other uri

unresolve

IUriReference unresolve(IHierarchicalUri other,
                        String fragment)

Convert the given uri to a relative uri reference with this uri as base. If this uri is no ancestor of the other uri, an absolute uri refernce is returned.

Parameters:

other - uri to unresolve

fragment - to add to result uri reference

Returns:

uri reference relative to this uri

mapToWcmPath

URI mapToWcmPath(IUriReference ref)

Deprecated. As of EP5 SP6, replaced by #mapToResourceID(RID) 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
 

Parameters:

ref - the uri reference to map

Returns:

the mapped wcm path or null if not possible

mapToResourceID

RID mapToResourceID(IUriReference ref)

mapToWcmPath

URI mapToWcmPath(IUriReference ref,
                 URICodec codec)

Deprecated. As of EP5 SP6, replaced by #mapToResourceID(RID, 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
 

Parameters:

ref - the uri reference to map

codec - to use for uri decoding

Returns:

the mapped wcm path or null if not possible

mapToResourceID

RID mapToResourceID(IUriReference ref,
                    URICodec codec)

mapToAbsolutePath

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"
 

Parameters:

wcmPath - to map

Returns:

the mapped uri reference

mapToAbsolutePath

IUriReference mapToAbsolutePath(RID wcmPath)

mapToAbsolutePath

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"
 

Parameters:

wcmPath - to map

codec - to use for uri encoding

Returns:

the mapped uri reference

mapToAbsolutePath

IUriReference mapToAbsolutePath(RID wcmPath,
                                URICodec codec)

mapToAbsolutePath

IUriReference mapToAbsolutePath(IUriReference ref)

Given this Uri as the base, map the uri reference to a uri reference with absolute path component.

 Example: "http://host/docs" + "test%203", gives "/docs/test%203"
 Example: "http://host/docs" + "http://another/fs/test", gives "http://another/fs/test"
 

Returns:

the mapped uri reference

mapToAbsoluteUri

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"
 

Parameters:

wcmPath - to map

Returns:

the mapped uri

mapToAbsoluteUri

IHierarchicalUri mapToAbsoluteUri(RID wcmPath)

mapToAbsoluteUri

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"
 

Parameters:

wcmPath - to map

codec - to use for uri encoding

Returns:

the mapped uri

mapToAbsoluteUri

IHierarchicalUri mapToAbsoluteUri(RID wcmPath,
                                  URICodec codec)

setQuery

IHierarchicalUri setQuery(String query)

Construct a new object of same type with the given query. If query is 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.

Parameters:

query - encoded query string for returned object

Returns:

hierarchical uri of same type as this

setPath

IHierarchicalUri setPath(String path)

Construct a new object of same type with the given path. If path is 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.

Parameters:

path - encoded path string for returned object

Returns:

hierarchical uri of same type as this

Access Rights

This class can be accessed from:

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