org.grails.web.servlet.GrailsRequestContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grace-web-common Show documentation

Grace Framework : Grace Web Common

There is a newer version: 2023.2.0-M1

/*
 * Copyright 2004-2023 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.grails.web.servlet;

import java.io.Writer;
import java.util.Map;

import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpSession;

import org.springframework.context.ApplicationContext;

/**
 * Defines the methods and objects available during a Grails request context.
 *
 * @author Graeme Rocher
 * @since 0.6
 */
public interface GrailsRequestContext {

    /**
     * The request object.
     * @return The request object
     */
    HttpServletRequest getRequest();

    /**
     * The response object.
     * @return The response object
     */
    HttpServletResponse getResponse();

    /**
     * The session object.
     * @return The session object
     */
    HttpSession getSession();

    /**
     * The servletContext object.
     * @return The servletContext Object
     */
    ServletContext getServletContext();

    /**
     * The params object.
     * @return The params object
     */
    @SuppressWarnings("rawtypes")
    Map getParams();

    /**
     * The ApplicationContext instance.
     *
     * @return The ApplicationCOntext
     */
    ApplicationContext getApplicationContext();

    /**
     * The response writer.
     * @return The response writer
     */
    Writer getOut();

    /**
     * @return The Action name
     */
    String getActionName();

    /**
     * @return The Controller Name
     */
    String getControllerName();

    /**
     * @return The Request URI
     */
    String getRequestURI();

}