tiles-request-api/src/main/java/org/apache/tiles/request/scope/ContextResolver.java

/*
 * $Id$
 *
 * 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.tiles.request.scope;

import java.util.Map;

import org.apache.tiles.request.Request;

/**
 * Allows to retrieve scopes managed into a request.
 *
 * @version $Rev$ $Date$
 */
public interface ContextResolver {

    /**
     * Returns a scope map (context) given the request and the scope name.
     *
     * @param request The request.
     * @param scope The name of the scope.
     * @return The context, if present.
     */
    Map<String, Object> getContext(Request request, String scope);

    /**
     * Returns the name of all available scopes.
     *
     * @param request The request.
     * @return All the available scopes.
     */
    String[] getAvailableScopes(Request request);
}