TaskDispatcher.java

/*
 * Copyright 2005 Joe Walker
 *
 * 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.extend;

import java.util.Collection;

import org.directwebremoting.ScriptSession;
import org.directwebremoting.ScriptSessionFilter;

/**
 * We would like to do some reverse ajax work, but need something to find the
 * ScriptSessions add act on them all.
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
public interface TaskDispatcher
{
    /**
     * Take a runnable action and run it against every {@link ScriptSession}
     * that matches a specified filter.
     */
    public void dispatchTask(ScriptSessionFilter filter, Runnable task);

    /**
     * This method discovers the sessions that are currently being targeted
     * by browser updates.
     * <p>
     * It will generally only be useful to authors of reverse ajax UI proxy
     * APIs. Using it directly may cause scaling problems
     * @return The list of current browser windows.
     */
    public Collection<ScriptSession> getTargetSessions();
}