javax.mvc.MvcContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.mvc-api Show documentation
MVC ${project.version} API
There is a newer version: 1.0-pr
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2015 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
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/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 packager/legal/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 javax.mvc;

import javax.mvc.security.Csrf;
import javax.mvc.security.Encoders;
import javax.ws.rs.core.Configuration;

/**
 * This class provides contextual information such as context and application
 * paths as well as access to the JAX-RS application configuration object.
 * In addition, it provides access to the security-related beans {@link
 * javax.mvc.security.Csrf} and {@link javax.mvc.security.Encoders}.
 *
 * Implementations of this class are injectable and accessible from EL using
 * the name {@code mvc}. For example, the CSRF token name and value can be
 * accessed in EL using the expressions {@code mvc.csrf.name} and {@code
 * mvc.csrf.token}, respectively.
 *
 * @author Santiago Pericas-Geertsen
 * @see javax.ws.rs.core.Configuration
 * @since 1.0
 */
public interface MvcContext {

    /**
     * Get the JAX-RS application configuration object. All application-defined properties
     * are accessible via this object.
     *
     * @return the configuration object.
     */
    Configuration getConfig();

    /**
     * Get the application's context path. The value returned must be normalized
     * to start with a slash ({@code '/'}) but not end with one. Thus, the path returned by
     * this method can be prepended to that returned by {@link #getApplicationPath()}.
     *
     * For example, given the URI {@code http://host:port/myapp/resources/hello},
     * this method returns {@code /myapp}.
     *
     * @see javax.servlet.ServletContext#getContextPath()
     * @return the application's context path.
     */
    String getContextPath();

    /**
     * Get the application's path which was set using the {@link javax.ws.rs.ApplicationPath}
     * annotation. The value returned must be normalized to start with a slash ({@code '/'}) but
     * not end with one. Thus, the path returned by this method can be appended to that
     * returned by {@link #getContextPath()}.
     *
     * If the application path is empty or was set to {@code /*}, then an empty string is
     * returned to ensure concatenation with {@link #getContextPath()} results in a well-formed
     * path. If a JAX-RS application subclass is not found, {@code null} may be returned.
     *
     * For example, given the URI {@code http://host:port/myapp/resources/hello},
     * this method returns {@code /resources}.
     *
     * @return the application's path or {@code null} if not found.
     */
    String getApplicationPath();

    /**
     * Get the application's base path which is defined as the concatenation of context
     * and application paths. It follows that the value returned by this method always
     * starts with a slash but never ends with one.
     *
     * If a JAX-RS application subclass is not found, causing {@link #getApplicationPath()}
     * to return {@code null}, then the value returned is the same as {@link #getContextPath}.
     *
     * @return the application's base path.
     */
    String getBasePath();

    /**
     * Get the CSRF object.
     *
     * @return the CSRF object.
     */
    Csrf getCsrf();

    /**
     * Get the built-in encoders.
     *
     * @return instance of encoders.
     */
    Encoders getEncoders();
}