org.apache.sling.api.servlets.OptingServlet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.sling.api Show documentation

The Apache Sling API defines an extension to the Servlet API 2.4 to provide access to content and unified access to request parameters hiding the differences between the different methods of transferring parameters from client to server. Note that the Apache Sling API bundle does not include the Servlet API but instead requires the API to be provided by the Servlet container in which the Apache Sling framework is running or by another bundle.

There is a newer version: 2.27.6

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.sling.api.servlets;

import javax.annotation.Nonnull;
import javax.servlet.Servlet;

import org.apache.sling.api.SlingHttpServletRequest;

import aQute.bnd.annotation.ConsumerType;

/**
 * The OptingServlet interface may be implemented by
 * Servlets used by Sling which may choose to not handle all
 * requests for which they would be selected based on their registration
 * properties.
 *
 * Note that servlets implementing this interface can have an impact
 * on system performance, as their resolution cannot be cached: the 
 * resolver has no insight into which parts of the request cause
 * {@link #accepts} to return true.
 */
@ConsumerType
public interface OptingServlet extends Servlet {

    /**
     * Examines the request, and return true if this servlet is
     * willing to handle the request. If false is returned, the
     * request will be ignored by this servlet, and may be handled by other
     * servlets.
     *
     * @param request The request to examine
     * @return true if this servlet will handle the request,
     *         false otherwise
     */
    boolean accepts(@Nonnull SlingHttpServletRequest request);

}