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 * <div class='warn'>
026 *    <b>Deprecated</b> - Use {@link org.apache.juneau.http.exception.Unauthorized}
027 * </div>
028 *
029 * <p>
030 * Similar to <c>403 Forbidden</c>, but specifically for use when authentication is required and has failed or has not yet been provided.
031 * <br>The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
032 * <br>401 semantically means "unauthenticated",i.e. the user does not have the necessary credentials.
033 * <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.
034 */
035@Response(code=CODE, description=MESSAGE)
036@Deprecated
037public class Unauthorized extends RestException {
038   private static final long serialVersionUID = 1L;
039
040   /** HTTP status code */
041   public static final int CODE = 401;
042
043   /** Default message */
044   public static final String MESSAGE = "Unauthorized";
045
046   /**
047    * Constructor.
048    *
049    * @param cause The cause.  Can be <jk>null</jk>.
050    * @param msg The message.  Can be <jk>null</jk>.
051    * @param args Optional {@link MessageFormat}-style arguments in the message.
052    */
053   public Unauthorized(Throwable cause, String msg, Object...args) {
054      super(cause, CODE, msg, args);
055   }
056
057   /**
058    * Constructor.
059    *
060    * @param msg The message.  Can be <jk>null</jk>.
061    */
062   public Unauthorized(String msg) {
063      super(msg);
064      setStatus(CODE);
065   }
066
067   /**
068    * Constructor.
069    */
070   public Unauthorized() {
071      this((Throwable)null, MESSAGE);
072   }
073
074   /**
075    * Constructor.
076    *
077    * @param msg The message.  Can be <jk>null</jk>.
078    * @param args Optional {@link MessageFormat}-style arguments in the message.
079    */
080   public Unauthorized(String msg, Object...args) {
081      this(null, msg, args);
082   }
083
084   /**
085    * Constructor.
086    *
087    * @param cause The cause.  Can be <jk>null</jk>.
088    */
089   public Unauthorized(Throwable cause) {
090      this(cause, null);
091   }
092}