xref: /aoo41x/main/offapi/com/sun/star/auth/XSSOContext.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_auth_XSSOContext_idl__
#define __com_sun_star_auth_XSSOContext_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com { module sun { module star { module auth {

/** Base SSO security context representation

    @since OOo 1.1.2
 */
published interface XSSOContext : ::com::sun::star::uno::XInterface
{
	/** retrieves the principal name of the source/initiator of the context.
		<P>
		In the case of an acceptor side security context, the source principal
        name is available only after the initiator has been authenticated.

		@returns
        the source principal name
	 */
	string getSource();

	/** retrieves the principal name of the target/acceptor of the context.

        @returns
        the target principal name
	 */
	string getTarget();

	/** retrieves the mechanism associated with the context.

        @returns
        the mechanism name
	 */
	string getMechanism();

	/** retrieves whether or not the context supports mutual authentication

		@returns
        <TRUE/> if mutual authentication is supported, <FALSE/> otherwise.
	 */
	boolean	getMutual();
};

}; }; }; };

#endif