1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_auth_XSSOPasswordCache_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_auth_XSSOPasswordCache_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_auth_SSOExceptions_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/auth/SSOExceptions.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module auth { 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski/** supports password caching for security mechanisms which use passwords as 38*b1cdbd2cSJim Jagielski credentials or as an input to credential creation but don't have 39*b1cdbd2cSJim Jagielski an external method to cache these passwords. 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski @since OpenOffice 1.1.2 42*b1cdbd2cSJim Jagielski */ 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielskipublished interface XSSOPasswordCache : ::com::sun::star::uno::XInterface 45*b1cdbd2cSJim Jagielski{ 46*b1cdbd2cSJim Jagielski /** adds a username/password combination to the cache. 47*b1cdbd2cSJim Jagielski <P> 48*b1cdbd2cSJim Jagielski If an entry for the specified username already exists in the cache, it 49*b1cdbd2cSJim Jagielski will be overwritten. 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski @param UserName 52*b1cdbd2cSJim Jagielski the user name to add 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski @param Password 55*b1cdbd2cSJim Jagielski the associated password 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski @param Persist 58*b1cdbd2cSJim Jagielski indicates whether or not the username/password combination should be 59*b1cdbd2cSJim Jagielski persisted 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski void addPassword( [in] string UserName, 62*b1cdbd2cSJim Jagielski [in] string Password, 63*b1cdbd2cSJim Jagielski [in] boolean Persist ) 64*b1cdbd2cSJim Jagielski raises( InvalidArgumentException, 65*b1cdbd2cSJim Jagielski PersistenceFailureException ); 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski /** retrieves a password for a given user from the cache. 68*b1cdbd2cSJim Jagielski <P> 69*b1cdbd2cSJim Jagielski Non persistent cache is searched first, followed by the 70*b1cdbd2cSJim Jagielski persistent cache ( if it exists ). 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @param UserName 73*b1cdbd2cSJim Jagielski the name of the user whose password should be retrieved 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski @param Persist 76*b1cdbd2cSJim Jagielski indicates whether or not the password is persistent 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski @returns 79*b1cdbd2cSJim Jagielski the required password 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski string getPassword( [in] string UserName, [out] boolean Persist ) 82*b1cdbd2cSJim Jagielski raises( InvalidArgumentException, 83*b1cdbd2cSJim Jagielski PersistenceFailureException ); 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski /** removes a password from the cache 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski @param UserName 88*b1cdbd2cSJim Jagielski the name of the user whose password should be removed. 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski @param RemovePersist 91*b1cdbd2cSJim Jagielski indicates whether or not the password should also be removed, if 92*b1cdbd2cSJim Jagielski present, from persistent cache. 93*b1cdbd2cSJim Jagielski */ 94*b1cdbd2cSJim Jagielski void removePassword( [in] string UserName, [in] boolean RemovePersist ) 95*b1cdbd2cSJim Jagielski raises( InvalidArgumentException, 96*b1cdbd2cSJim Jagielski PersistenceFailureException ); 97*b1cdbd2cSJim Jagielski}; 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski}; }; }; }; 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski#endif 102