SwitchUserService.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

package org.apache.isis.applib.fixtures.switchuser;

import java.util.List;

import org.apache.isis.applib.annotation.Programmatic;
import org.apache.isis.applib.fixtures.AbstractFixture;
import org.apache.isis.applib.services.sudo.SudoService;

/**
 * Not intended to be used directly; decouples the {@link AbstractFixture},
 * which needs to be able to switch users dynamically, from the rest of the
 * framework's runtime.
 * 
 * <p>
 * A suitable implementation is injected into {@link AbstractFixture} when
 * installed.
 *
 * @deprecated - use instead {@link SudoService}.
 */
@Deprecated
public interface SwitchUserService {

    /**
     * Switches the current user with the list of specified roles.
     *
     * @deprecated
     */
    @Deprecated
    @Programmatic
    void switchUser(String username, String... roles);

    /**
     * Switches the current user with the list of specified roles.
     * @deprecated
     */
    @Deprecated
    @Programmatic
    void switchUser(String username, List<String> roles);

}