org.sonar.ce.user.CeUserSession Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-ce Show documentation
There is a newer version: 7.0
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.ce.user;

import java.util.Collection;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import org.sonar.server.user.UserSession;

/**
 * Implementation of {@link UserSession} which provide not implementation of any method.
 * 
 * Any use of {@link UserSession} in the Compute Engine will raise an error.
 * 
 */
public class CeUserSession implements UserSession {

  public static final String UOE_MESSAGE = "UserSession must not be used from within the Compute Engine";

  @Override
  public String getLogin() {
    return notImplemented();
  }

  @Override
  public String getName() {
    return notImplemented();
  }

  @Override
  public Integer getUserId() {
    return notImplemented();
  }

  @Override
  public Set getUserGroups() {
    return notImplemented();
  }

  @Override
  public boolean isLoggedIn() {
    return notImplementedBooleanMethod();
  }

  @Override
  public Locale locale() {
    return notImplemented();
  }

  @Override
  public UserSession checkLoggedIn() {
    return notImplemented();
  }

  @Override
  public UserSession checkPermission(String globalPermission) {
    return notImplemented();
  }

  @Override
  public UserSession checkGlobalPermission(String globalPermission) {
    return notImplemented();
  }

  @Override
  public UserSession checkAnyPermissions(Collection globalPermissions) {
    return notImplemented();
  }

  @Override
  public boolean hasPermission(String globalPermission) {
    return notImplementedBooleanMethod();
  }

  @Override
  public boolean hasGlobalPermission(String globalPermission) {
    return notImplementedBooleanMethod();
  }

  @Override
  public List globalPermissions() {
    return notImplemented();
  }

  @Override
  public UserSession checkComponentPermission(String projectPermission, String componentKey) {
    return notImplemented();
  }

  @Override
  public UserSession checkComponentUuidPermission(String permission, String componentUuid) {
    return notImplemented();
  }

  @Override
  public boolean hasComponentPermission(String permission, String componentKey) {
    return notImplementedBooleanMethod();
  }

  @Override
  public boolean hasComponentUuidPermission(String permission, String componentUuid) {
    return notImplementedBooleanMethod();
  }

  private static  T notImplemented() {
    throw new UnsupportedOperationException(UOE_MESSAGE);
  }

  private static boolean notImplementedBooleanMethod() {
    throw new UnsupportedOperationException(UOE_MESSAGE);
  }
}