AuthenticationProvider.java

package fi.otavanopisto.muikku.auth;

import java.util.Map;

import fi.otavanopisto.muikku.model.security.AuthSource;

/**
* Defines a base interface for all authentication interfaces
*/
public interface AuthenticationProvider {
  
  /**
   * Returns the name of this authentication provider.
   *
   * @return The name of this authentication provider
   */
  public String getName();
  
  /**
   * Returns the human readable descriptions of this authentication provider
   * 
   * @return The human readable description of this authentication provider
   */
  public String getDescription();
  
  /**
   * Returns whether this provider requires credentials, i.e. username and password
   *
   * @return <code>true</code> if the provider requires credentials, otherwise <code>false</code>
   */
  public boolean requiresCredentials();
  
  /**
   * Processes the login request.
   *
   * @param requestContext
   * @throws AuthenticationException
   */
  public AuthenticationResult processLogin(AuthSource authSource, Map<String, String[]> requestParameters);
  
}