xref: /aoo4110/main/offapi/com/sun/star/auth/XSSOInitiatorContext.idl (revision b1cdbd2c)

/**************************************************************
 *
 * 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_auth_XSSOInitiatorContext_idl__
#define __com_sun_star_auth_XSSOInitiatorContext_idl__

#ifndef __com_sun_star_auth_XSSOContext_idl__
#include <com/sun/star/auth/XSSOContext.idl>
#endif

#ifndef __com_sun_star_auth_SSOExceptions_idl__
#include <com/sun/star/auth/SSOExceptions.idl>
#endif

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

/** represents an initiator side security context.
	<P>This context may be used to initialise authetication tokens to send to
	an acceptor and to authenticate any token sent back in response.

    @since OpenOffice 1.1.2
 */
published interface XSSOInitiatorContext : ::com::sun::star::auth::XSSOContext
{
	/** initialises an SSO Token to send to the acceptor side and
	    authenticates an SSO Token returned by the acceptor if the
		context supports mutual authentication.
		<P>
		init should be called only once for contexts which don't support
		mutual authentication and at most twice for contexts which do
		support mutual authentication. Additional calls produce undefined
		results.

		@param Token
		the SSO token received from the acceptor side in response to an
		authentication request. This token is ignored on the first call
		to init and should only be specified for the second call on a
		context supporting mutual authentication.

		@returns
		the sequence of bytes to be sent to the acceptor side as part of
		an authentication request. This sequence will be non zero length
		for the first call to init, zero length for the second call to init
		on a context supporting mutual authentication and undefined in all
		other cases.
	 */
	sequence< byte > init(	[in] sequence< byte > Token )
		raises( InvalidArgumentException,
				InvalidCredentialException,
				InvalidContextException,
				AuthenticationFailedException );
};

}; }; }; };

#endif