001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.runtime.api.login;
020
021import javax.security.auth.login.LoginContext;
022import javax.security.auth.login.LoginException;
023
024import org.nuxeo.runtime.api.Framework;
025
026/**
027 * This service is performing a login under another identity without checking the password.
028 * <p>
029 * You must never use this service explicitly in your code since it may be removed in future. Instead you should use
030 * {@link Framework#loginAsUser(String)}
031 * <p>
032 * Implementors must implement this interface and expose the implementation as a Nuxeo service.
033 *
034 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
035 * @since 5.4.0.2
036 */
037public interface LoginAs {
038
039    /**
040     * Perform the Login As.
041     *
042     * @param username
043     * @return
044     * @throws LoginException
045     */
046    public LoginContext loginAs(String username) throws LoginException;
047
048}