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