path: root/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/security/IAuthenticator.java

/*
 * Copyright (c) 2004 - 2012 Eike Stepper (Berlin, Germany) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Eike Stepper - initial API and implementation
 */
package org.eclipse.net4j.util.security;

/**
 * Authenticates users.
 *
 * @author Eike Stepper
 * @since 3.3
 */
public interface IAuthenticator
{
  /**
   * Authenticates the user with the passed <code>userID</code> by checking whether the supplied <code>password</code>
   * matches the password <i>stored</i> for this user.
   * <p>
   * The implementation is required to throw a {@link SecurityException} if the passwords do <b>not</b> match.
   */
  public void authenticate(String userID, char[] password) throws SecurityException;
}