|
OSGi™ Service Platform Compendium Specification Release 4 Version 4.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.osgi.service.dmt.Uri
public final class Uri
This class contains static utility methods to manipulate DMT URIs.
Syntax of valid DMT URIs:
'/'
\u002F) is the separator of the node names.
Slashes used in node name must therefore be escaped using a backslash slash (
"\/"
). The backslash must be escaped with a double backslash
sequence. A backslash found must be ignored when it is not followed by a
slash or backslash.
[-a-zA-Z0-9_.!~*'()]
are most efficient.
'/'
\u002F). This implies that the root node must be denoted as "."
and not "./"
.
"../"
to traverse the tree upwards.
"./"
must not be used
anywhere else but in the beginning of a URI.
Field Summary | |
---|---|
static java.lang.String |
PATH_SEPARATOR
This constant stands for a string identifying the path separator in the DmTree ("/"). |
static char |
PATH_SEPARATOR_CHAR
This constant stands for a char identifying the path separator in the DmTree ('/'). |
static java.lang.String |
ROOT_NODE
This constant stands for a string identifying the root of the DmTree ("."). |
static char |
ROOT_NODE_CHAR
This constant stands for a char identifying the root of the DmTree ('.'). |
Method Summary | |
---|---|
static java.lang.String |
decode(java.lang.String nodeName)
Decode the node name so that back slash and forward slash are un-escaped from a back slash. |
static java.lang.String |
encode(java.lang.String nodeName)
Encode the node name so that back slash and forward slash are escaped with a back slash. |
static boolean |
isAbsoluteUri(java.lang.String uri)
Checks whether the specified URI is an absolute URI. |
static boolean |
isValidUri(java.lang.String uri)
Checks whether the specified URI is valid. |
static java.lang.String |
mangle(java.lang.String nodeName)
Returns a node name that is valid for the tree operation methods, based on the given node name. |
static java.lang.String[] |
toPath(java.lang.String uri)
Split the specified URI along the path separator '/' characters and return an array of URI segments. |
static java.lang.String |
toUri(java.lang.String[] path)
Construct a URI from the specified URI segments. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ROOT_NODE
public static final char ROOT_NODE_CHAR
public static final java.lang.String PATH_SEPARATOR
public static final char PATH_SEPARATOR_CHAR
Method Detail |
---|
public static java.lang.String mangle(java.lang.String nodeName)
mangle
method call.
Node name mangling is needed in the following cases:
A node name that does not suffer from either of these problems is guaranteed to remain unchanged by this method. Therefore the client may skip the mangling if the node name is known to be valid (though it is always safe to call this method).
The method returns the normalized nodeName
as described below.
Invalid node names are normalized in different ways, depending on the
cause. If the name contains '/' or '\' characters, then these are simply
escaped by inserting an additional '\' before each occurrence. If the
length of the name does exceed the limit, the following mechanism is
used to normalize it:
nodeName
- the node name to be mangled (if necessary), must not be
null
or empty
java.lang.NullPointerException
- if nodeName
is null
java.lang.IllegalArgumentException
- if nodeName
is emptypublic static java.lang.String toUri(java.lang.String[] path)
If the specified path is an empty array then an empty URI (""
) is
returned.
path
- a possibly empty array of URI segments, must not be
null
java.lang.NullPointerException
- if the specified path or any of its segments are null
java.lang.IllegalArgumentException
- if the specified path contains too many or malformed segments
or the resulting URI is too longpublic static java.lang.String[] toPath(java.lang.String uri)
uri
- the URI to be split, must not be null
java.lang.NullPointerException
- if the specified URI is null
java.lang.IllegalArgumentException
- if the specified URI is malformedpublic static boolean isAbsoluteUri(java.lang.String uri)
uri
- the URI to be checked, must not be null
and must
contain a valid URI
java.lang.NullPointerException
- if the specified URI is null
java.lang.IllegalArgumentException
- if the specified URI is malformedpublic static java.lang.String encode(java.lang.String nodeName)
decode(String)
.
nodeName
- the node name to be encoded
public static java.lang.String decode(java.lang.String nodeName)
nodeName
- the node name to be decoded
public static boolean isValidUri(java.lang.String uri)
null
;
getMaxUriLength()
and
getMaxSegmentNameLength()
methods.
uri
- the URI to be validated
|
OSGi™ Service Platform Compendium Specification Release 4 Version 4.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |