01: /*
02: * JOSSO: Java Open Single Sign-On
03: *
04: * Copyright 2004-2008, Atricore, Inc.
05: *
06: * This is free software; you can redistribute it and/or modify it
07: * under the terms of the GNU Lesser General Public License as
08: * published by the Free Software Foundation; either version 2.1 of
09: * the License, or (at your option) any later version.
10: *
11: * This software is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this software; if not, write to the Free
18: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
20: */
21: package org.josso.auth;
22:
23: import org.josso.auth.exceptions.SSOAuthenticationException;
24: import org.josso.auth.scheme.AuthenticationScheme;
25:
26: import javax.security.auth.Subject;
27: import java.security.Principal;
28:
29: /**
30: * The authenticator validates if credentials are valid proof of user identity.
31: *
32: * @author <a href="mailto:sgonzalez@josso.org">Sebastian Gonzalez Oyuela</a>
33: * @version $Id: Authenticator.java 508 2008-02-18 13:32:29Z sgonzalez $
34: */
35:
36: public interface Authenticator {
37:
38: /**
39: * The is valid method is used to see if credentials are a valid proof of the user identity.
40: * The process populates the received subject with all Principals and Credentials.
41: *
42: * @param credentials that should proof user identity.
43: * the state of the authenticated Subject.
44: *
45: * @return the authenticated subject.
46: */
47: Subject check(Credential[] credentials, String schemeName)
48: throws SSOAuthenticationException;
49:
50: /**
51: * Builds the supplied user credentials for the
52: * supplied Authentication Scheme.
53: */
54: Credential newCredential(String schemeName, String name,
55: Object value) throws SSOAuthenticationException;
56:
57: /**
58: * Retunrs the Principal derived from the given credentials.
59: */
60: Principal getPrincipal(String schemeName, Credential[] credentials);
61:
62: /**
63: * Sets the configured authentication schemes available to the authenticator.
64: *
65: * @param as the authentication schemes.
66: */
67: void setAuthenticationSchemes(AuthenticationScheme[] as);
68:
69: AuthenticationScheme[] getAuthenticationSchemes();
70:
71: }
|