001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.exception;
014
015import static org.apache.juneau.rest.exception.Unauthorized.*;
016
017import java.text.*;
018
019import org.apache.juneau.http.annotation.*;
020import org.apache.juneau.rest.*;
021
022/**
023 * Exception representing an HTTP 401 (Unauthorized).
024 *
025 * <p>
026 * Similar to <code>403 Forbidden</code>, but specifically for use when authentication is required and has failed or has not yet been provided.
027 * <br>The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
028 * <br>401 semantically means "unauthenticated",i.e. the user does not have the necessary credentials.
029 * <br>Note: Some sites issue HTTP 401 when an IP address is banned from the website (usually the website domain) and that specific address is refused permission to access a website.
030 */
031@Response(code=CODE, description=MESSAGE)
032public class Unauthorized extends RestException {
033   private static final long serialVersionUID = 1L;
034
035   /** HTTP status code */
036   public static final int CODE = 401;
037
038   /** Default message */
039   public static final String MESSAGE = "Unauthorized";
040
041   /**
042    * Constructor.
043    *
044    * @param cause The cause.  Can be <jk>null</jk>.
045    * @param msg The message.  Can be <jk>null</jk>.
046    * @param args Optional {@link MessageFormat}-style arguments in the message.
047    */
048   public Unauthorized(Throwable cause, String msg, Object...args) {
049      super(cause, CODE, msg, args);
050   }
051
052   /**
053    * Constructor.
054    *
055    * @param msg The message.  Can be <jk>null</jk>.
056    */
057   public Unauthorized(String msg) {
058      super(msg);
059      setStatus(CODE);
060   }
061
062   /**
063    * Constructor.
064    */
065   public Unauthorized() {
066      this((Throwable)null, MESSAGE);
067   }
068
069   /**
070    * Constructor.
071    *
072    * @param msg The message.  Can be <jk>null</jk>.
073    * @param args Optional {@link MessageFormat}-style arguments in the message.
074    */
075   public Unauthorized(String msg, Object...args) {
076      this(null, msg, args);
077   }
078
079   /**
080    * Constructor.
081    *
082    * @param cause The cause.  Can be <jk>null</jk>.
083    */
084   public Unauthorized(Throwable cause) {
085      this(cause, null);
086   }
087}