- Description
- registers a content provider for a specific URL template.
- Parameter Provider
- the content provider to register.
This may be NULL, in which case a later
XContentProvider::queryContent with an
XContentIdentifier that matches the Scheme
will simply return NULL. These "dummy" content providers are useful
in combination with other content providers that are registered on a
wildcard URL template: For example, imagine that you want to route all
http URLs to a HTTP content provider, but want to block all URLs for
the server www.dont.go . One solution would be to register
the HTTP content provider on the Scheme http ,
and to register a "dummy" (i.e., NULL) content provider on the
Scheme "http://www.dont.go"([/?#].*)? .
- Parameter Scheme
- the URL scheme for the provided contents. More generally, this may not
only be a URL scheme, but a URL template.
A URL template is a regular expression (represented as a string) that
specifies a subset of the set of all possible URLs (this subset
consists of exactly those URLs that match the regular expression). The
language to denote the regular expressions is initially quite limited,
but it may be extended in the future:
regexp = scheme / simple / translation
scheme = ALPHA *(ALPHA / DIGIT / "+" / "-" / ".")
simple = simple-prefix / simple-authority / simple-domain
translation = trans-prefix / trans-authority / trans-domain
simple-prefix = [string] ".*"
trans-prefix = [string] "(.*)->" [string] "\1"
simple-authority = [string] "([/?#].*)?"
trans-authority = [string] "(([/?#].*)?)->" string "\1"
simple-domain = [string] "[^/?#]*" string "([/?#].*)?"
trans-domain = [string] "([^/?#]*" string "([/?#].*)?)->" string "\1"
string = DQUOTE 1*(schar / sescape) DQUOTE ; DQUOTE is "
schar = < any UTF-16 character except " or \>
sescape = "\" (DQUOTE / "\")
A <scheme>: matches any URL of exactly the given
scheme (ignoring case), keeping the extension from URL schemes to URL
templates backwards compatible. The <simple>:
regexps match any URL starting with a given string literal, followed
by arbitrary characters (<simple-prefix>: ), or
by arbitrary characters that start with one of '/', '?', or '#', if any
(<simple-authority>: ), or by arbitrary characters not
including any of '/', '?', or '#', followed by a given string literal,
followed by arbitrary characters that start with one of '/', '?', or
'#', if any. The comparision of string literals is done ignoring the
case of ASCII letters. The <translation>: regexps
match the same URLs as their <simple>: counterparts,
but they also describe how a (local) URL is mapped to another (remote)
URL. This mapping is only relevant for methods of the
RemoteAccessContentProvider's
XParameterizedContentProvider interface; in all other
cases, <translation>: regexps have the same semantics
as their <simple>: counterparts.
- Parameter ReplaceExisting
- true: replace the provider possibly registered for the given URL
template. The replaced provider will not be deregistered automatically!
If the superseding provider gets deregistered, the superseded one will
become active again.
false: do not register, if another provider is already registered
for the given URL template.
- Returns
- the replaced content provider, if there was one.
- See also
- XContentIdentifier
|