View Javadoc

1   // ========================================================================
2   // Copyright (c) 2008-2009 Mort Bay Consulting Pty. Ltd.
3   // ------------------------------------------------------------------------
4   // All rights reserved. This program and the accompanying materials
5   // are made available under the terms of the Eclipse Public License v1.0
6   // and Apache License v2.0 which accompanies this distribution.
7   // The Eclipse Public License is available at 
8   // http://www.eclipse.org/legal/epl-v10.html
9   // The Apache License v2.0 is available at
10  // http://www.opensource.org/licenses/apache2.0.php
11  // You may elect to redistribute this code under either of these licenses. 
12  // ========================================================================
13  
14  package org.eclipse.jetty.security;
15  
16  import org.eclipse.jetty.server.UserIdentity;
17  
18  
19  /* ------------------------------------------------------------ */
20  /**
21   * Login Service Interface.
22   * <p>
23   * The Login service provides an abstract mechanism for an {@link Authenticator}
24   * to check credentials and to create a {@link UserIdentity} using the 
25   * set {@link IdentityService}.
26   */
27  public interface LoginService
28  {
29      String getName();
30      UserIdentity login(String username,Object credentials);
31      void logout(UserIdentity user);
32      
33      IdentityService getIdentityService();
34      void setIdentityService(IdentityService service);
35  }