/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.grizzly.config.dom;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.types.PropertyBag;
/**
* <p>
* A {@link Protocol} which redirects an HTTP(S) request to a different location
* using HTTP 302 redirection semantics.
* </p>
*/
@Configured
public interface HttpRedirect extends ConfigBeanProxy, PropertyBag {
int PORT = -1;
boolean SECURE = false;
/**
* @return the network port the request should be redirected to. If no
* value was specified, the default of <code>-1</code> will be returned
* which signifies a redirection to the same port the current request
* was made on
*/
@Attribute(defaultValue = "" + PORT, dataType = Integer.class)
@Range(min=-1, max=65535)
String getPort();
@SuppressWarnings({"UnusedDeclaration"})
void setPort(String port);
/**
* @return <code>true</code> will redirect the request using <code>HTTPS</code>
* where as a value of <code>false</code> will use <code>HTTP</code>
*/
@Attribute(defaultValue = "" + SECURE, dataType = Boolean.class)
String getSecure();
@SuppressWarnings({"UnusedDeclaration"})
void setSecure(String value);
}