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.ecm.automation.core.operations.login;
020
021import java.security.Principal;
022
023import javax.security.auth.login.LoginException;
024
025import org.nuxeo.ecm.automation.OperationContext;
026import org.nuxeo.ecm.automation.OperationException;
027import org.nuxeo.ecm.automation.core.Constants;
028import org.nuxeo.ecm.automation.core.annotations.Context;
029import org.nuxeo.ecm.automation.core.annotations.Operation;
030import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
031import org.nuxeo.ecm.automation.core.annotations.Param;
032import org.nuxeo.ecm.core.api.DocumentModel;
033import org.nuxeo.runtime.api.Framework;
034import org.nuxeo.runtime.api.login.NuxeoLoginContext;
035
036/**
037 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
038 */
039@Operation(id = LoginAs.ID, category = Constants.CAT_USERS_GROUPS, label = "Login As", description = "Login As the given user. If no user is given a system login is performed. This is a void operations - the input will be returned back as the output.")
040public class LoginAs {
041
042    public static final String ID = "Auth.LoginAs";
043
044    @Context
045    protected OperationContext ctx;
046
047    @Param(name = "name", required = false)
048    protected String name;
049
050    @OperationMethod
051    public void run() throws LoginException, OperationException {
052        NuxeoLoginContext lc;
053        if (name == null) {
054            Principal origPrincipal = ctx.getPrincipal();
055            lc = Framework.loginSystem(origPrincipal.getName());
056        } else {
057            lc = Framework.loginUser(name);
058        }
059        ctx.getLoginStack().push(lc);
060    }
061
062    @OperationMethod
063    public DocumentModel run(DocumentModel doc) throws LoginException, OperationException {
064        run();
065        // refetch the input document if any using the new session
066        // otherwise using document methods that are delegating the call to the
067        // session that created the document will call the old session.
068        return ctx.getCoreSession().getDocument(doc.getRef());
069    }
070}