001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.cdi;
018
019import org.apache.wicket.Page;
020import org.apache.wicket.core.request.handler.IPageRequestHandler;
021import org.apache.wicket.request.IRequestHandler;
022
023/**
024 * A strategy that specifies how conversations should be propagated between
025 * pages/resources. {@link ConversationPropagation} provides sensible default
026 * implementations of this interface.
027 * 
028 * @author papegaaij
029 */
030@FunctionalInterface
031public interface IConversationPropagation
032{
033        /**
034         * Indicates if the conversation should be propagated via url-parameters for
035         * the given request handler and page (if any). A conversation is always
036         * propagated via the cid query parameter.
037         * 
038         * @param handler
039         *            The current request handler
040         * @param page
041         *            The page associated with the request handler, or null if the
042         *            handler is not an {@link IPageRequestHandler}.
043         * @return true if the conversation should be propagated for the given
044         *         request handler.
045         */
046        boolean propagatesVia(IRequestHandler handler, Page page);
047}