001/* 002 * SonarQube 003 * Copyright (C) 2009-2016 SonarSource SA 004 * mailto:contact AT sonarsource DOT com 005 * 006 * This program is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * This program is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020package org.sonar.api.server.authentication; 021 022import com.google.common.base.Charsets; 023import java.io.UnsupportedEncodingException; 024 025import static java.lang.String.format; 026import static java.net.URLEncoder.encode; 027 028/** 029 * This exception should be used when a functional error is generated by an Identity Provider plugin. 030 * The user will be redirected to an unauthorized page and the exception's message will be displayed in the UI. 031 * 032 * @since 5.5 033 */ 034public class UnauthorizedException extends RuntimeException { 035 036 public static final String UNAUTHORIZED_PATH = "/sessions/unauthorized"; 037 private static final String UNAUTHORIZED_PATH_WITH_MESSAGE = UNAUTHORIZED_PATH + "?message=%s"; 038 039 public UnauthorizedException(String message) { 040 super(message); 041 } 042 043 public UnauthorizedException(String message, Throwable cause) { 044 super(message, cause); 045 } 046 047 public String getPath() { 048 return format(UNAUTHORIZED_PATH_WITH_MESSAGE, encodeMessage(getMessage())); 049 } 050 051 private static String encodeMessage(String message) { 052 try { 053 return encode(message, Charsets.UTF_8.name()); 054 } catch (UnsupportedEncodingException unsupportedException) { 055 throw new IllegalStateException(format("Fail to encode %s", message), unsupportedException); 056 } 057 } 058}