001    /**
002     * Copyright (C) 2009-2011 the original author or authors.
003     * See the notice.md file distributed with this work for additional
004     * information regarding copyright ownership.
005     *
006     * Licensed under the Apache License, Version 2.0 (the "License");
007     * you may not use this file except in compliance with the License.
008     * You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package org.fusesource.restygwt.client.dispatcher;
020    
021    import org.fusesource.restygwt.client.Method;
022    
023    import com.google.gwt.http.client.RequestBuilder;
024    
025    public interface DispatcherFilter {
026    
027        /**
028         * main filter method for a dispatcherfilter.
029         *
030         * pattern is a chain of responsibility. if you want the chain to
031         * continue, return ``true``, ``false`` otherwise.
032         *
033         * if a ``DispatcherFilterDispatcherFilter`` returns ``false`` it is
034         * respnsible to trigger the onResponse() method of the callback on
035         * its own. otherwise there will never return any response to the origin
036         * caller.
037         *
038         *  this will be necessary in caching case for example. if we have a
039         *  caching dispatcherfilter, we will have
040         *  - the necessarity to break the chain
041         *  - and the necessarity to call the ``onResponse``
042         *
043         * @return continue chain or not
044         */
045        public boolean filter(Method method, RequestBuilder builder);
046    
047    }