org.eclipse.jetty.rewrite.handler.Rule Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.rewrite.handler;
import java.io.IOException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.jetty.server.Request;
/**
* An abstract rule for creating rewrite rules.
*/
public abstract class Rule
{
/**
* Interface used to apply a changed target if {@link RuleContainer#setRewriteRequestURI(boolean)} is true.
*/
public interface ApplyURI
{
void applyURI(Request request, String oldURI, String newURI) throws IOException;
}
protected boolean _terminating;
protected boolean _handling;
/**
* This method calls tests the rule against the request/response pair and if the Rule
* applies, then the rule's action is triggered.
*
* @param target The target of the request
* @param request the request
* @param response the response
* @return The new target if the rule has matched, else null
* @throws IOException if unable to match the rule
*/
public abstract String matchAndApply(String target, HttpServletRequest request, HttpServletResponse response) throws IOException;
/**
* Sets terminating to true or false.
*
* @param terminating If true, this rule will terminate the loop if this rule has been applied.
*/
public void setTerminating(boolean terminating)
{
_terminating = terminating;
}
/**
* Returns the terminating flag value.
*
* @return true if the rule needs to terminate; false otherwise.
*/
public boolean isTerminating()
{
return _terminating;
}
/**
* Returns the handling flag value.
*
* @return true if the rule handles the request and nested handlers should not be called.
*/
public boolean isHandling()
{
return _handling;
}
/**
* Set the handling flag value.
*
* @param handling true if the rule handles the request and nested handlers should not be called.
*/
public void setHandling(boolean handling)
{
_handling = handling;
}
/**
* Returns the handling and terminating flag values.
*/
@Override
public String toString()
{
return this.getClass().getName() + (_handling ? "[H" : "[h") + (_terminating ? "T]" : "t]");
}
}