/*************************************************************************
 *
 *  $RCSfile: FilePermission.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2003/04/17 09:29:05 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_io_FilePermission_idl__
#define __com_sun_star_io_FilePermission_idl__

//=============================================================================
 
module com {  module sun {  module star {  module io {  
 
//=============================================================================
 
/** This permission represents access to a file or directory.
    A FilePermission consists of a file url and a set of actions valid for that url.
    <p>
    The path of the file url that ends in <code>"/*"</code> indicates all the files and
    directories contained in that directory.  A path that ends with <code>"/-"</code>
    indicates (recursively) all files and subdirectories contained in that
    directory.  A file url string consisting of the special token
    <code>"&lt;&lt;ALL FILES&gt;&gt;"</code> matches any file.
    <br>
    Note: A file url string consisting of a single <code>"*"</code> indicates all the files
    in the current directory, while a string consisting of a single <code>"-"</code> indicates
    all the files in the current directory and (recursively) all files and
    subdirectories contained in the current directory.
    <br>
    The actions to be granted is a list of one or more comma-separated keywords.
    The possible keywords are <code>"read"</code>, <code>"write"</code>,
    <code>"execute"</code>, and <code>"delete"</code>.
    Their meaning is defined as follows:
    <ul>
    <li><code>read</code> -- read permission</li>
    <li><code>write</code> -- write permission</li>
    <li><code>execute</code> -- execute permission</li>
    <li><code>delete</code> -- delete permission</li>
    </ul><br>
    The actions string is processed case-insensitive.
    </p>
    
    @attention
    Be careful when granting FilePermissions.  Think about the implications of
    granting read and especially write access to various files and directories.
    The <code>"&lt;&lt;ALL FILES&gt;&gt;"</code> permission with write action is
    especially dangerous.  This grants permission to write to the entire file system.

    @since #107627#
*/
struct FilePermission
{
	/** target file url
	*/
	string URL;
	/** comma separated actions list
	*/
	string Actions;
};

//=============================================================================

}; }; }; };

#endif
