org.directwebremoting.guice.util.ContextScope Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dwr Show documentation

DWR is easy Ajax for Java. It makes it simple to call Java code directly from Javascript. It gets rid of almost all the boiler plate code between the web browser and your Java code.

The newest version!

/*
 * Copyright 2008 Tim Peierls
 *
 * 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 org.directwebremoting.guice.util;

import com.google.inject.Key;
import com.google.inject.Provider;
import com.google.inject.Scope;

import java.util.Collection;
import java.util.List;

/**
 * A scope that looks up providers in a current context, using itself as a
 * provider for the context.
 * @author Tim Peierls [tim at peierls dot net]
 */
public interface ContextScope extends Scope, Provider
{
    /**
     * Returns a provider that finds the instance registry corresponding
     * to the current context and returns the object registered with
     * the given key, creating it if it doesn't exist in the registry.
     */
     Provider scope(final Key key, final Provider creator);

    /**
     * The context identifier used to look up an instance registry.
     * The value returned is a function of the current context.
     */
    C get();

    /**
     * The type of object used as a context identifier.
     */
    Class type();

    /**
     * The keys bound in this scope.
     */
    List> getKeysInScope();

    /**
     * The context identifiers of all open contexts that this
     * scope knows about.
     */
    Collection getOpenContexts();

    /**
     * Closes the given context.
     */
    void close(C context, ContextCloseHandler... closeHandlers);

    /**
     * Closes all open contexts.
     */
    void closeAll(ContextCloseHandler... closeHandlers);
}