Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: ucb ::

interface XContentProviderManager
Description
makes it possible to query/register/deregister content providers.
See also
XContentProvider
Developers Guide
UCB - Content Provider Proxies
UCB - Unconfigured UCBs

Methods' Summary
registerContentProvider registers a content provider for a specific URL template.  
deregisterContentProvider deregisters a content provider.  
queryContentProviders returns a list of information on all registered content providers.  
queryContentProvider returns the currently active content provider for a content identifier.  
Methods' Details
registerContentProvider
XContentProvider
registerContentProvider( [in] XContentProvider  Provider,
[in] string  Scheme,
[in] boolean  ReplaceExisting )
raises( DuplicateProviderException );

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
deregisterContentProvider
[oneway] void
deregisterContentProvider( [in] XContentProvider  Provider,
[in] string  Scheme );

Description
deregisters a content provider.
Parameter Provider
a content provider to deregister.
Parameter Scheme
the URL scheme for the provided contents. More generally, this may not only be a URL scheme, but a URL template (see registerContentProvider for a discussion of URL templates).
queryContentProviders
sequence< ContentProviderInfo >
queryContentProviders();

Description
returns a list of information on all registered content providers.
Returns
a list information on content providers.
queryContentProvider
XContentProvider
queryContentProvider( [in] string  Identifier );

Description
returns the currently active content provider for a content identifier.
Parameter Identifier
a content identifier (i.e., a URL).
Returns
a content provider.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.