/*************************************************************************
 *
 *  $RCSfile: URL.idl,v $
 *
 *  $Revision: 1.5.4.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:52:29 $
 *
 *  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_util_URL_idl__ 
#define __com_sun_star_util_URL_idl__ 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module util {  
 
//============================================================================= 
 
/** represents the structure of an Uniform Resource Locator.
	
	<p>
	If the structure represents a valid URL or not depends on prior usage of 
	the functions of <type>XURLTransformer</type>. Only after one of the functions
	returned </TRUE> this can be assumed.</br>
	It is not necessary to set all of the fields; either <member>URL::Complete</member> 
	or (some of) the others are set. Additionally, most of the other
	fields, like <member>URL::Host</member>, <member>URL::Port</member>, 
	<member>URL::User</member>, <member>URL::Password</member>,
	or <member>URL::Mark</member>, are optional.

	@see XURLTransformer
	
	</p>
 */
struct URL
{
	/** contains the string representation of the complete URL, for example,
		http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz
		
		<p>
		It is used as a central input/output or input parameter for the interfaces of
		<type>XURLTransformer</type>. The usage of one of the <type>XURLTransformer</type> 
		function is mandatory to validate the URL. It cannot be assumed that 
		<member>URL::Complete</member> represents always a valid URL!
		</p>
	 */
	string Complete; 
 
	//------------------------------------------------------------------------- 
	/** contains the URL without a mark and without arguments, for example,
		http://www.sun.de:8080/pub/test/foo.txt
	 */
	string Main; 
 
	//------------------------------------------------------------------------- 
	/** contains the protocol (scheme) of the URL, for example, "http"
	 */
	string Protocol; 
 
	//------------------------------------------------------------------------- 
	/** contains the user-identifier of the URL, for example, "me"
	 */
	string User; 
 
	//------------------------------------------------------------------------- 
	/** contains the users password of the URL, for example, "pass"
	 */
	string Password; 
 
	//------------------------------------------------------------------------- 
	/** contains the server part of the URL, for example, "www.sun.de"
	 */
	string Server; 
 
	//------------------------------------------------------------------------- 
	/** contains the port at the server of the URL, for example, "8080"
	 */
	short Port; 
 
	//------------------------------------------------------------------------- 
	/** contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/"
	 */
	string Path;
 
	//------------------------------------------------------------------------- 
	/** contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt"
		<p>
		<strong>Attention:</strong>A service implementing the <type>XURLTransformer</type> interface 
		will normally not detect if the last segment is a folder or a file. So it is possible that
		the last segment describes a folder. If you want to be sure that a file URL that references
		a folder will be correctly put into the URL fields you should append a '/' at the end of the
		hierarchical path.
		</p>
	 */
	string Name; 
 
	//------------------------------------------------------------------------- 
	/** contains the arguments part of the URL, for example, "a=b"
	 */
	string Arguments; 
 
	//------------------------------------------------------------------------- 
	/** contains the mark part of the URL, for example, "xyz"
	 */
	string Mark; 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif 
