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.response;
014
015import static org.apache.juneau.rest.response.MovedPermanently.*;
016
017import java.net.*;
018
019import org.apache.juneau.annotation.BeanIgnore;
020import org.apache.juneau.http.annotation.*;
021
022/**
023 * Represents an <code>HTTP 301 Moved Permanently</code> response.
024 *
025 * <p>
026 * This and all future requests should be directed to the given URI.
027 */
028@Response(code=CODE, description=MESSAGE)
029@BeanIgnore
030public class MovedPermanently extends HttpResponse {
031
032   /** HTTP status code */
033   public static final int CODE = 301;
034
035   /** Default message */
036   public static final String MESSAGE = "Moved Permanently";
037
038   /** Reusable instance. */
039   public static final MovedPermanently INSTANCE = new MovedPermanently();
040
041   private final URI location;
042
043   /**
044    * Constructor using HTTP-standard message.
045    */
046   public MovedPermanently() {
047      this(MESSAGE, null);
048   }
049
050   /**
051    * Constructor using custom message.
052    * @param message Message to send as the response.
053    * @param location <code>Location</code> header value.
054    */
055   public MovedPermanently(String message, URI location) {
056      super(message);
057      this.location = location;
058   }
059
060   /**
061    * Constructor.
062    * @param location <code>Location</code> header value.
063    */
064   public MovedPermanently(URI location) {
065      this(MESSAGE, location);
066   }
067
068   /**
069    * @return <code>Location</code> header value.
070    */
071   @ResponseHeader(name="Location", description="New location of resource.")
072   public URI getLocation() {
073      return location;
074   }
075}