diff options
Diffstat (limited to 'offapi/com/sun/star/auth/SSOManagerFactory.idl')
-rw-r--r-- | offapi/com/sun/star/auth/SSOManagerFactory.idl | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/offapi/com/sun/star/auth/SSOManagerFactory.idl b/offapi/com/sun/star/auth/SSOManagerFactory.idl new file mode 100644 index 000000000000..e172649bcac9 --- /dev/null +++ b/offapi/com/sun/star/auth/SSOManagerFactory.idl @@ -0,0 +1,75 @@ +/************************************************************************* + * + * 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_SSOManagerFactory_idl__ +#define __com_sun_star_auth_SSOManagerFactory_idl__ + +#ifndef __com_sun_star_auth_XSSOManagerFactory_idl_ +#include <com/sun/star/auth/XSSOManagerFactory.idl> +#endif + +module com { module sun { module star { module auth { + +/** represents a starting point for Single Sign-on interactions. + <P>The Single Sign-on ( SSO ) APIs provide UNO based access to underlying + SSO implementations ( e.g. Kerberos ). The aim of the SSO APIs is to + enable authentication ( possibly mutual ) between a client ( source or + initiator ) and a network service ( target or acceptor ). This is + achieved via. the creation and processing of security tokens sent + between the two parties. The steps which should be followed to + successfully use the SSO APIs are as follows: + <UL> + <LI>Create an <type>XSSOManagerFactory</type> instance</LI> + <LI>Use this factory to create/retrieve an <type>XSSOManager</type> + instance.</LI> + <LI>Depending on whether your code is acting as SSO source or target, + you should use the <type>XSSOManager</type> instance to create an + initiator security context, <type>XSSOInitiatorContext</type> or an + acceptor security context, <type>XSSOAcceptorContext</type> + respectively.</LI> + <LI>On the initiator side, use the previously created context to process + security tokens received from the acceptor side and to create + security tokens to send to the acceptor side. On the acceptor side, + use the previously created context to process security tokens + received from the initiator side and to create security tokens to + send to the initiator side.</LI> + </UL> + + @since OOo 1.1.2 + */ + +published service SSOManagerFactory +{ + /** supports the creation of <type>XSSOManager</type> instances which can + subsequently be used to create security contexts. + */ + interface XSSOManagerFactory; +}; + +}; }; }; }; + +#endif |