ReplayDispatcher.java

/*
 *  This file is part of the Wayback archival access software
 *   (http://archive-access.sourceforge.net/projects/wayback/).
 *
 *  Licensed to the Internet Archive (IA) by one or more individual 
 *  contributors. 
 *
 *  The IA 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.archive.wayback;

import org.archive.wayback.core.CaptureSearchResults;
import org.archive.wayback.core.Resource;
import org.archive.wayback.core.CaptureSearchResult;
import org.archive.wayback.core.WaybackRequest;
import org.archive.wayback.exception.BetterRequestException;

/**
 * Locate and return a ReplayRenderer appropriate for the users request 
 * (accept header, for example) and the resulting Resource.
 *
 * @author brad
 * @version $Date$, $Revision$
 */
public interface ReplayDispatcher {
	/**
	 * 
	 * Return a ReplayRenderer appropriate for the Resource.
	 * 
	 * @param wbRequest WaybackRequest being handled.
	 * @param result CapturSearchResult from the ResourceIndex which is
	 * 				 being returned.
	 * @param resource Resource as returned by ResourceStore which should
	 *               be returned to the user.
	 * @return an appropriate ReplayRenderer for the Resource, given the request
	 *         context
	 */
	public ReplayRenderer getRenderer(WaybackRequest wbRequest,
			CaptureSearchResult result, Resource resource);
	

	/**
	 * Return a ReplayRenderer appropriate for the replaying the http headers
	 * from {@code httpHeadersResource} and the payload from
	 * {@code payloadResource}.
	 * 
	 * @param wbRequest WaybackRequest being handled.
	 * @param result CapturSearchResult from the ResourceIndex which is
	 * 				 being returned.
	 * @param httpHeadersResource
	 * @param payloadResource
	 * @return an appropriate ReplayRenderer, given the request
	 *         context
	 */
	public ReplayRenderer getRenderer(WaybackRequest wbRequest,
			CaptureSearchResult result, Resource httpHeadersResource,
			Resource payloadResource);

	/**
	 * @param wbRequest the Request being handled
	 * @param results the CaptureSearchResults from the ResourceIndex
	 * @return the CaptureSearchResult to be rendered (best for the wbRequest)
	 * @throws BetterRequestException if the user should be directed to a
	 * 	different URL, with the exact timestamp, for example.
	 */
	public CaptureSearchResult getClosest(WaybackRequest wbRequest, 
			CaptureSearchResults results);
}