udkapi/com/sun/star/uri/UriReferenceFactory.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_uri_UriReferenceFactory_idl__
  21 #define __com_sun_star_uri_UriReferenceFactory_idl__
  22
  23 module com { module sun { module star { module uri {
  24
  25 published interface XUriReferenceFactory;
  26
  27 /**
  28    creates URI references.
  29
  30    <p>See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a> for a
  31    description of URI references and related terms.</p>
  32
  33    <p>For parsing absolute URI references, this service tries to use a
  34    scheme-specific parser.  Such a scheme-specific parser will typically enforce
  35    additional restrictions during parsing, and will typically return objects
  36    that support extra, scheme-specific interfaces in addition to
  37    com::sun::star::uri::XUriReference.  If no such parser
  38    is found, and for relative URI references, a generic parser is used, which
  39    returns objects that only support
  40    com::sun::star::uri::XUriReference.</p>
  41
  42    <p>Locating a scheme-specific parser works as follows:  A scheme consists of
  43    Latin capital letters
  44    &ldquo;<code>A</code>&rdquo;&ndash;&ldquo;<code>Z</code>&rdquo;, Latin small
  45    letters &ldquo;<code>a</code>&rdquo;&ndash;&ldquo;<code>z</code>&rdquo;,
  46    digits &ldquo;<code>0</code>&rdquo;&ndash;&ldquo;<code>9</code>&rdquo;,
  47    &ldquo;<code>+</code>&rdquo;, &ldquo;<code>-</code>&rdquo;, and
  48    &ldquo;<code>.</code>&rdquo;.  A scheme&nbsp;<var>s</var> is transformed into
  49    a string&nbsp;<var>s</var>&prime; character-by-character, by translating
  50    Lating capital letters to their small counterparts, translating
  51    &ldquo;<code>+</code>&rdquo; to &ldquo;<code>PLUS</code>&rdquo;,
  52    &ldquo;<code>-</code>&rdquo; to &ldquo;<code>HYPHEN</code>&rdquo;,
  53    &ldquo;<code>.</code>&rdquo; to &ldquo;<code>DOT</code>&rdquo;, and copying
  54    Latin small letters and digits unchanged.  If the component context used
  55    while creating this <code>UriReferenceFactory</code> instance offers a
  56    service manager, and there is a service available at that service manager
  57    whose name is the concatenation of
  58    &ldquo;<code>com.sun.star.uri.UriSchemeParser_</code>&rdquo; and
  59    <var>s</var>&prime;, then that service is used.  It is an error if that
  60    service does not support
  61    com::sun::star::uri::XUriSchemeParser.</p>
  62
  63    @since OOo 2.0
  64  */
  65 published service UriReferenceFactory: XUriReferenceFactory;
  66
  67 }; }; }; };
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */