org.apache.sling.api.SlingHttpServletRequest Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* 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;
import java.util.Enumeration;
import java.util.List;
import java.util.Locale;
import java.util.ResourceBundle;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.NotNull;
import javax.servlet.RequestDispatcher;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import org.apache.sling.api.adapter.Adaptable;
import org.apache.sling.api.request.RequestDispatcherOptions;
import org.apache.sling.api.request.RequestParameter;
import org.apache.sling.api.request.RequestParameterMap;
import org.apache.sling.api.request.RequestPathInfo;
import org.apache.sling.api.request.RequestProgressTracker;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.osgi.annotation.versioning.ProviderType;
/**
* The SlingHttpServletRequest defines the interface to provide
* client request information to a servlet.
*
* Request Parameters Generally request parameters are transmitted as
* part of the URL string such as GET /some/path?param=value
* or as request data of content type application/x-www-form-urlencoded
* or multipart/form-data. The Sling Framework must decode parameters
* transferred as request data and make them available through the various
* parameter accessor methods. Generally parameters transferred as
* multipart/form-data will be accessed by one of the methods returning
* {@link RequestParameter} instances.
*
* In any case, the {@link #getReader()} and {@link #getInputStream()} methods
* will throw an IllegalStateException if called after any methods
* returning request parameters if the request content type is either
* application/x-www-form-urlencoded or multipart/form-data
* because the request data has already been processed.
*
* Starting with Sling API 2.0.6, this interface als extends the
* {@link Adaptable} interface.
*/
@ProviderType
public interface SlingHttpServletRequest extends HttpServletRequest, Adaptable {
/**
* Returns the {@link Resource} object on whose behalf the servlet acts.
*
* @return The Resource object of this request.
*/
@NotNull Resource getResource();
/**
* Returns the {@link ResourceResolver} which resolved the
* {@link #getResource() resource} of this request.
*
* @return The resource resolver
*/
@NotNull ResourceResolver getResourceResolver();
/**
* Returns the {@link RequestPathInfo} pertaining to this request.
*
* @return the request path info.
*/
@NotNull RequestPathInfo getRequestPathInfo();
/**
* Returns the value of a request parameter as a {@link RequestParameter},
* or null if the parameter does not exist.
*
* This method should only be used if the parameter has only one value. If
* the parameter might have more than one value, use
* {@link #getRequestParameters(String)}.
*
* If this method is used with a multivalued parameter, the value returned
* is equal to the first value in the array returned by
* getRequestParameters.
*
* This method is a shortcut for
* getRequestParameterMap().getValue(String).
*
* @param name a String specifying the name of the parameter
* @return a {@link RequestParameter} representing the single value of the
* parameter
* @see #getRequestParameters(String)
* @see RequestParameterMap#getValue(String)
* @throws IllegalArgumentException if name is null.
*/
@Nullable RequestParameter getRequestParameter(@NotNull String name);
/**
* Returns an array of {@link RequestParameter} objects containing all of
* the values the given request parameter has, or null if the
* parameter does not exist.
*
* If the parameter has a single value, the array has a length of 1.
*
* This method is a shortcut for
* getRequestParameterMap().getValues(String).
*
* @param name a String containing the name of the parameter
* the value of which is requested
* @return an array of {@link RequestParameter} objects containing the
* parameter values.
* @see #getRequestParameter(String)
* @see RequestParameterMap#getValues(String)
* @throws IllegalArgumentException if name is null.
*/
@Nullable RequestParameter[] getRequestParameters(@NotNull String name);
/**
* Returns a Map of the parameters of this request.
*
* The values in the returned Map are from type
* {@link RequestParameter} array (RequestParameter[]).
*
* If no parameters exist this method returns an empty Map.
*
* @return an immutable Map containing parameter names as
* keys and parameter values as map values, or an empty
* Map if no parameters exist. The keys in the
* parameter map are of type String. The values in the parameter map
* are of type {@link RequestParameter} array (RequestParameter[]).
*/
@NotNull RequestParameterMap getRequestParameterMap();
/**
* Returns the request parameters as instances of the
* {@link RequestParameter} interface in the order or the request where the
* query string parameters are first and the POST request parameters are
* second.
*
* @return The list of {@link RequestParameter} in request declaration
* order.
* @since 2.3 (Sling API Bundle 2.6.0)
*/
@NotNull List getRequestParameterList();
/**
* Returns a RequestDispatcher object that acts as a wrapper
* for the resource located at the given path. A
* RequestDispatcher object can be used to include the
* resource in a response.
*
* Returns null if a RequestDispatcher cannot
* be returned for any reason.
*
* @param path a String specifying the pathname to the
* resource. If it is relative, it must be relative against the
* current servlet.
* @param options influence the rendering of the included Resource
* @return a RequestDispatcher object that acts as a wrapper
* for the resource or null if an
* error occurs preparing the dispatcher.
*/
@Nullable RequestDispatcher getRequestDispatcher(@NotNull String path,
RequestDispatcherOptions options);
/**
* Returns a RequestDispatcher object that acts as a wrapper
* for the resource located at the given resource. A
* RequestDispatcher object can be used to include the
* resource in a response.
*
* Returns null if a RequestDispatcher cannot
* be returned for any reason.
*
* @param resource The {@link Resource} instance whose response content may
* be included by the returned dispatcher.
* @param options influence the rendering of the included Resource
* @return a RequestDispatcher object that acts as a wrapper
* for the resource or null if an
* error occurs preparing the dispatcher.
*/
@Nullable RequestDispatcher getRequestDispatcher(@NotNull Resource resource,
RequestDispatcherOptions options);
/**
* Same as {@link #getRequestDispatcher(Resource,RequestDispatcherOptions)}
* but using empty options.
* @param resource The {@link Resource} instance whose response content may
* be included by the returned dispatcher.
* @return a RequestDispatcher object that acts as a wrapper
* for the resource or null if an
* error occurs preparing the dispatcher.
*/
@Nullable RequestDispatcher getRequestDispatcher(@NotNull Resource resource);
/**
* Returns the named cookie from the HTTP request or null if
* no such cookie exists in the request.
*
* @param name The name of the cookie to return.
* @return The named cookie or null if no such cookie exists.
*/
@Nullable Cookie getCookie(String name);
/**
* Returns the framework preferred content type for the response. The
* content type only includes the MIME type, not the character set.
*
* For included resources this method will returned the same string as
* returned by the ServletResponse.getContentType() without
* the character set.
*
* @return preferred MIME type of the response
*/
@Nullable String getResponseContentType();
/**
* Gets a list of content types which the framework accepts for the
* response. This list is ordered with the most preferable types listed
* first. The content type only includes the MIME type, not the character
* set.
*
* For included resources this method will returned an enumeration
* containing a single entry which is the same string as returned by the
* ServletResponse.getContentType() without the character
* set.
*
* @return ordered list of MIME types for the response
*/
@NotNull Enumeration getResponseContentTypes();
/**
* Returns the resource bundle for the given locale.
*
* @param locale the locale for which to retrieve the resource bundle. If
* this is null, the locale returned by
* {@link #getLocale()} is used to select the resource bundle.
* @return the resource bundle for the given locale
*/
@Nullable ResourceBundle getResourceBundle(Locale locale);
/**
* Returns the resource bundle of the given base name for the given locale.
*
* @param baseName The base name of the resource bundle to returned. If this
* parameter is null, the same resource bundle
* must be returned as if the {@link #getResourceBundle(Locale)}
* method is called.
* @param locale the locale for which to retrieve the resource bundle. If
* this is null, the locale returned by
* {@link #getLocale()} is used to select the resource bundle.
* @return the resource bundle for the given locale
*/
@Nullable ResourceBundle getResourceBundle(String baseName, Locale locale);
/**
* Returns the {@link RequestProgressTracker} of this request.
* @return The request progress tracker.
*/
@NotNull RequestProgressTracker getRequestProgressTracker();
/**
* Returns a {@code java.security.Principal} object containing
* the name of the current authenticated user.
*
* Note: This method deviates from the parent
* interface and might return a prinicpal even for anonymous users.
* Therefore it cannot be used to determine whether the user is
* authenticated.
*
* @return a {@code java.security.Principal} or {@code null}.
* @see #getAuthType()
* @see #getRemoteUser()
*/
@Nullable java.security.Principal getUserPrincipal();
/**
* Returns the name of the authentication scheme used to protect
* the servlet. All servlet containers support basic, form and client
* certificate authentication, and may additionally support digest
* authentication.
* If the request is not authenticated {@code null} is returned.
*
* @return the authentication scheme or {code null}
* @see getRemoteUser()
* @see HttpServletRequest#getAuthType()
*/
@Nullable String getAuthType();
/**
* Returns the login of the user making this request, if the
* user has been authenticated, or {@code null} if the user
* has not been authenticated.
*
* @return a {@code String} specifying the login of the user making
* this request, or {@code null}
* @see getAuthType()
* @see HttpServletRequest#getRemoteUser()
*/
@Nullable String getRemoteUser();
}