KickJava   Java API By Example, From Geeks To Geeks.

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


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.Credentials;
19 import org.outerj.daisy.repository.user.User;
20 import org.outerj.daisy.repository.user.UserManager;
21
22 /**
23  * A means to do password-based authentication.
24  */
25 public interface AuthenticationScheme {
26     /**
27      * A unique name for this authentication scheme (max. 50 chars).
28      */
29     String JavaDoc getName();
30
31     String JavaDoc getDescription();
32
33     /**
34      * @return true if authentication successful, false otherwise
35      * @throws AuthenticationException if an error occured while authenticating
36      */
37     boolean check(Credentials credentials) throws AuthenticationException;
38
39     /**
40      * Clear caches maintained by this authentication scheme, if any.
41      */
42     void clearCaches();
43
44     /**
45      * If a user does not exist, the authentication scheme can be offered the
46      * possibility to create the user (this is defined in the configuration of the
47      * UserAuthenticator). It is up to the implementation of this method to
48      * check the credentials are ok.
49      */
50     public User createUser(Credentials crendentials, UserManager userManager) throws AuthenticationException;
51 }
52
Popular Tags