LoginProvider.java

/*
 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) 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:
 *     Florent Guillaume
 */
package org.eclipse.ecr.opencmis.bindings;

import javax.security.auth.login.LoginContext;
import javax.security.auth.login.LoginException;

/**
 * Interface defining a login method, used during SOAP authentication.
 * <p>
 * The provider can be redefined by a Nuxeo Framework property named with the
 * full name of this interface.
 */
public interface LoginProvider {

    /**
     * Log in the user given the username and password, and returns a login
     * context.
     *
     * @param username the username
     * @param password the password
     * @return the login context
     * @throws LoginException if the user cannot be logged in
     */
    LoginContext login(String username, String password) throws LoginException;

}