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

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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