1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_PackageContentProvider_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_PackageContentProvider_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_XContentProvider_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/ucb/XContentProvider.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ucb { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski/** The Package Content Provider (PCP) implements a <type>ContentProvider</type> 36*b1cdbd2cSJim Jagielski for the <type>UniversalContentBroker</type> (UCB). 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski <p>It provides access to packages ( zip / jar archive files ) containing 39*b1cdbd2cSJim Jagielski folders and streams. 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski @see com::sun::star::ucb::Content 42*b1cdbd2cSJim Jagielski*/ 43*b1cdbd2cSJim Jagielskipublished service PackageContentProvider 44*b1cdbd2cSJim Jagielski{ 45*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 46*b1cdbd2cSJim Jagielski /** provides two types of contents: Stream and Folder. 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski <p> 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski <b>PCP Contents</b> 51*b1cdbd2cSJim Jagielski <ol> 52*b1cdbd2cSJim Jagielski <li> 53*b1cdbd2cSJim Jagielski A PCP Stream (<type>PackageStreamContent</type>) is a content which 54*b1cdbd2cSJim Jagielski represents a file inside a package. It is always contained in a PCP 55*b1cdbd2cSJim Jagielski Folder. A PCP Stream has no children. 56*b1cdbd2cSJim Jagielski </li> 57*b1cdbd2cSJim Jagielski <li> 58*b1cdbd2cSJim Jagielski A PCP Folder (<type>PackageFolderContent</type>) is a container for 59*b1cdbd2cSJim Jagielski other PCP Folders and PCP Streams. 60*b1cdbd2cSJim Jagielski </li> 61*b1cdbd2cSJim Jagielski </ol> 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski <p><b>URL Scheme for PCP Contents</b> 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski <p>Each HCP content has an identifier corresponding to the following 66*b1cdbd2cSJim Jagielski scheme: 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski <ul> 69*b1cdbd2cSJim Jagielski <li> 70*b1cdbd2cSJim Jagielski package-URL = "vnd.sun.star.pkg://" orig-URL [ abs-path ] 71*b1cdbd2cSJim Jagielski </li> 72*b1cdbd2cSJim Jagielski <li> 73*b1cdbd2cSJim Jagielski abs-path = "/" path-segments 74*b1cdbd2cSJim Jagielski </li> 75*b1cdbd2cSJim Jagielski <li> 76*b1cdbd2cSJim Jagielski path-segements = segment *( "/" segment ) 77*b1cdbd2cSJim Jagielski </li> 78*b1cdbd2cSJim Jagielski <li> 79*b1cdbd2cSJim Jagielski segment = pchar 80*b1cdbd2cSJim Jagielski </li> 81*b1cdbd2cSJim Jagielski <li> 82*b1cdbd2cSJim Jagielski pchar = unreserved | escaped | ":" | "@" | "&" | "=" 83*b1cdbd2cSJim Jagielski | "+" | "$" | "," 84*b1cdbd2cSJim Jagielski </li> 85*b1cdbd2cSJim Jagielski <li> 86*b1cdbd2cSJim Jagielski unreserved = alphanum | mark 87*b1cdbd2cSJim Jagielski </li> 88*b1cdbd2cSJim Jagielski <li> 89*b1cdbd2cSJim Jagielski mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")" 90*b1cdbd2cSJim Jagielski </li> 91*b1cdbd2cSJim Jagielski <li> 92*b1cdbd2cSJim Jagielski escaped = "%" hex hex 93*b1cdbd2cSJim Jagielski </li> 94*b1cdbd2cSJim Jagielski <li> 95*b1cdbd2cSJim Jagielski orig-URL = 1 *( unreserved | escaped | "$" | "," | ";" 96*b1cdbd2cSJim Jagielski | ":" | "@" | "&" | "&" | "=" | "+" 97*b1cdbd2cSJim Jagielski </li> 98*b1cdbd2cSJim Jagielski </ul> 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski <p>Examples: 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski <ul> 103*b1cdbd2cSJim Jagielski <li> 104*b1cdbd2cSJim Jagielski vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/ 105*b1cdbd2cSJim Jagielski ( The root folder of the package located at file:///e:/my.xsw ) 106*b1cdbd2cSJim Jagielski </li> 107*b1cdbd2cSJim Jagielski <li> 108*b1cdbd2cSJim Jagielski vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content 109*b1cdbd2cSJim Jagielski ( The folder/stream named "Content" that is contained in the root 110*b1cdbd2cSJim Jagielski folder of the located at file:///e:/my.xsw ) 111*b1cdbd2cSJim Jagielski </li> 112*b1cdbd2cSJim Jagielski <li> 113*b1cdbd2cSJim Jagielski vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content%20A 114*b1cdbd2cSJim Jagielski ( The folder/stream named "Content A" that is contained in the root 115*b1cdbd2cSJim Jagielski folder of the located at file:///e:/my.xsw ) 116*b1cdbd2cSJim Jagielski </li> 117*b1cdbd2cSJim Jagielski </ul> 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski </p> 120*b1cdbd2cSJim Jagielski */ 121*b1cdbd2cSJim Jagielski interface com::sun::star::ucb::XContentProvider; 122*b1cdbd2cSJim Jagielski}; 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski//============================================================================= 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski}; }; }; }; 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski#endif 129