com.stormpath.sdk.servlet.application.ApplicationResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stormpath-sdk-servlet Show documentation

Servlet-specific additions allowing one to more easily deploy the Stormpath SDK in a servlet-container-based web application.

The newest version!

/*
 * Copyright 2015 Stormpath, Inc.
 *
 * 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
 *
 *     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 com.stormpath.sdk.servlet.application;

import com.stormpath.sdk.application.Application;

import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;

/**
 * Looks up and returns the Stormpath {@link Application} record that reflects the currently running web application.
 * Once obtained and saved by the {@link com.stormpath.sdk.servlet.application.ApplicationLoader ApplicationLoader},
 * developers can use the {@code Application} instance to perform any identity operations necessary for
 * the web application, such as login, password reset, etc.  For example:
 * 
 * 
 * Application app = applicationResolver.getApplication(aServletContext);
 * 
 *
 * @see DefaultApplicationResolver
 * @since 1.0.RC3
 */
public interface ApplicationResolver {

    /**
     * A thread-safe instance to use as desired.  The implementation is a
     * {@link com.stormpath.sdk.servlet.client.DefaultClientResolver DefaultClientResolver}.
     */
    ApplicationResolver INSTANCE = new DefaultApplicationResolver();

    /**
     * Returns the Stormpath {@link Application} record that reflects the currently running web application.
     *
     * @param servletContext the web application's {@code servletContext} created by the servlet container at
     *                       application startup.
     * @return the Stormpath {@link Application} instance that reflects the currently running web application.
     */
    Application getApplication(ServletContext servletContext);

    /**
     * Returns the Stormpath {@link Application record that reflects the currently running web application.
     *
     * @param servletRequest the currently executing servlet request.
     * @return the Stormpath {@link Application} instance that reflects the currently running web application.
     */
    Application getApplication(ServletRequest servletRequest);

}