KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > outerj > daisy > authentication > UserAuthenticator


1 /*
2  * Copyright 2004 Outerthought bvba and Schaubroeck nv
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.outerj.daisy.authentication;
17
18 import org.outerj.daisy.repository.commonimpl.AuthenticatedUser;
19 import org.outerj.daisy.repository.Credentials;
20 import org.outerj.daisy.repository.RepositoryException;
21 import org.outerj.daisy.repository.user.UserManager;
22 import org.outerj.daisy.repository.user.AuthenticationSchemeInfos;
23
24 /**
25  * The UserAuthenticator is responsible for the authentication of users, based
26  * on registerable {@link AuthenticationScheme}s (see also {@link AuthenticationSchemeRegistrar}).
27  */
28 public interface UserAuthenticator {
29     public void setUserManager(UserManager userManager);
30
31     /**
32      *
33      * @throws org.outerj.daisy.repository.AuthenticationFailedException if the authentication failed
34      * @throws AuthenticationException if something failed while authenticating
35      */
36     public AuthenticatedUser authenticate(Credentials credentials) throws RepositoryException;
37
38     /**
39      * Returns the list of available (= registered) authentication schemes.
40      */
41     public AuthenticationSchemeInfos getAuthenticationSchemes();
42 }
43
Popular Tags