xref: /aoo41x/main/offapi/com/sun/star/ucb/AuthenticationRequest.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_AuthenticationRequest_idl__
#define __com_sun_star_ucb_AuthenticationRequest_idl__

#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
#include <com/sun/star/task/ClassifiedInteractionRequest.idl>
#endif


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

module com { module sun { module star { module ucb {

//=============================================================================
/** An error specifing lack of correct authentication data (e.g., to log into
	an account).
*/
published exception AuthenticationRequest: com::sun::star::task::ClassifiedInteractionRequest
{
	//-------------------------------------------------------------------------
	/** The name of the server (if applicable).
	 */
	string ServerName;

	//-------------------------------------------------------------------------
	/** Any diagnostic message about the failure to log in (if applicable; it
		will typically be an english phrase or sentence).
	 */
	string Diagnostic;

	//-------------------------------------------------------------------------
	/** Specifies if the authentication involves a 'realm' (as can be the case
		for HTTP).
	 */
	boolean HasRealm;

	//-------------------------------------------------------------------------
	/** Any already specified realm.

		If HasRealm is false, this member should be ignored.
	 */
	string Realm;

	//-------------------------------------------------------------------------
	/** Specifies if the authentication involves a 'user name' (as is almost
		always the case).
	*/
	boolean HasUserName;

	//-------------------------------------------------------------------------
	/** Any already specified user name.

		If HasUserName is false, this member should be ignored.
	 */
	string UserName;

	//-------------------------------------------------------------------------
	/** Specifies if the authentication involves a 'password' (as is almost
		always the case).
	*/
	boolean HasPassword;

	//-------------------------------------------------------------------------
	/** Any already specified password.

		If HasPassword is false, this member should be ignored.
	 */
	string Password;

	//-------------------------------------------------------------------------
	/** Specifies if the authentication involves an 'account' (as can be the
		case for FTP).
	*/
	boolean HasAccount;

	//-------------------------------------------------------------------------
	/** Any already specified account.

		If HasAccount is false, this member should be ignored.
	 */
	string Account;

};

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

}; }; }; };

#endif