offapi/com/sun/star/ucb/PackageContentProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PackageContentProvider.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_PackageContentProvider_idl__
  31 #define __com_sun_star_ucb_PackageContentProvider_idl__
  32
  33 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  34 #include <com/sun/star/ucb/XContentProvider.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41 //=============================================================================
  42 /** The Package Content Provider (PCP) implements a <type>ContentProvider</type>
  43     for the <type>UniversalContentBroker</type> (UCB).
  44
  45     <p>It provides access to packages ( zip / jar archive files ) containing
  46     folders and streams.
  47
  48     @see com::sun::star::ucb::Content
  49 */
  50 published service PackageContentProvider
  51 {
  52     //-------------------------------------------------------------------------
  53     /** provides two types of contents: Stream and Folder.
  54
  55         <p>
  56
  57         <b>PCP Contents</b>
  58         <ol>
  59         <li>
  60         A PCP Stream (<type>PackageStreamContent</type>) is a content which
  61         represents a file inside a package.     It is always contained in a PCP
  62         Folder. A PCP Stream has no children.
  63         </li>
  64         <li>
  65         A PCP Folder (<type>PackageFolderContent</type>) is a container for
  66         other PCP Folders and PCP Streams.
  67         </li>
  68         </ol>
  69
  70         <p><b>URL Scheme for PCP Contents</b>
  71
  72         <p>Each HCP content has an identifier corresponding to the following
  73         scheme:
  74
  75         <ul>
  76         <li>
  77         package-URL    = "vnd.sun.star.pkg://" orig-URL [ abs-path ]
  78         </li>
  79         <li>
  80         abs-path       = "/" path-segments
  81         </li>
  82         <li>
  83         path-segements = segment *( "/" segment )
  84         </li>
  85         <li>
  86         segment        = pchar
  87         </li>
  88         <li>
  89         pchar          = unreserved | escaped | ":" | "@" | "&" | "="
  90                          | "+" | "$" | ","
  91         </li>
  92         <li>
  93         unreserved     = alphanum | mark
  94         </li>
  95         <li>
  96         mark           = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")"
  97         </li>
  98         <li>
  99         escaped        = "%" hex hex
 100         </li>
 101         <li>
 102         orig-URL       = 1 *( unreserved | escaped | "$" | "," | ";"
 103                          | ":" | "@" | "&" | "&" | "=" | "+"
 104         </li>
 105         </ul>
 106
 107         <p>Examples:
 108
 109         <ul>
 110         <li>
 111         vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/
 112         ( The root folder of the package located at file:///e:/my.xsw )
 113         </li>
 114         <li>
 115         vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content
 116         ( The folder/stream named "Content" that is contained in the root
 117         folder of the located at file:///e:/my.xsw )
 118         </li>
 119         <li>
 120         vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content%20A
 121         ( The folder/stream named "Content A" that is contained in the root
 122         folder of the located at file:///e:/my.xsw )
 123         </li>
 124         </ul>
 125
 126         </p>
 127      */
 128     interface com::sun::star::ucb::XContentProvider;
 129 };
 130
 131 //=============================================================================
 132
 133 }; }; }; };
 134
 135 #endif