offapi/com/sun/star/auth/XSSOAcceptorContext.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_auth_XSSOAcceptorContext_idl__
  30 #define __com_sun_star_auth_XSSOAcceptorContext_idl__
  31
  32 #include <com/sun/star/auth/XSSOContext.idl>
  33 #include <com/sun/star/auth/SSOExceptions.idl>
  34
  35 module com { module sun { module star { module auth {
  36
  37 /** represents an acceptor side security context.
  38     <P>This context may be used to authenticate a Single Sign-on initiator based
  39        on a security token sent by the initiator and to generate a token to be
  40        sent back to the initiator so that it can authenticate the acceptor.
  41
  42     @since OOo 1.1.2
  43 */
  44
  45 published interface XSSOAcceptorContext : ::com::sun::star::auth::XSSOContext
  46 {
  47     /** accepts/authenticates an SSO token sent from the context initiator side.
  48         <P>
  49         accept() should be called only once. Subsequent calls produce
  50         undefined results.
  51
  52         @param Token
  53         the SSO token sent by the initiator.
  54
  55         @returns
  56         the sequence of bytes to be sent back to the initiator to allow
  57         authentication of the acceptor side, if mutual authentication is
  58         supported by the security context. If mutual authentication is not
  59         supported a zero length sequence is returned.
  60      */
  61
  62     sequence< byte >    accept( [in] sequence< byte > Token )
  63         raises( InvalidArgumentException,
  64                 InvalidCredentialException,
  65                 InvalidContextException,
  66                 AuthenticationFailedException );
  67 };
  68
  69 }; }; }; };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */