ResponseHandler.java

/*******************************************************************************
 * Copyright (c) 2010 Philipp Kursawe.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *   Philipp Kursawe (phil.kursawe@gmail.com) - initial API and implementation
 ******************************************************************************/
package copyto.target.http.core;

import java.net.URL;

import org.apache.commons.httpclient.HttpMethod;

import copyto.core.Persistable;

/**
 * 
 * <p>
 * Response handlers can also implement {@link Persistable} to load/save
 * settings. To provide a user interface for changing the response handlers
 * settings you can provide a <code>BuilderAdapter</code>.
 * 
 * @author <a href="mailto:kursawe@topsystem.de">Philipp Kursawe</a>
 * 
 */
public interface ResponseHandler {
	/**
	 * Retrieves a location URL from a HTTP method response.
	 * 
	 * @param method
	 *            to use for extracting the location URL.
	 * @return a valid URL object
	 * @throws Exception
	 *             if there was an error creating a location URL from the given
	 *             <code>method</code>.
	 */
	URL getLocation(HttpMethod method) throws Exception;
}