com.meschbach.psi.util.rest.RequestBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of psi-util Show documentation

Reusable utility classes for interacting with PSI components. This includes a series of components which are utilized in testing the system.

The newest version!

/*
 *  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.
 * 
 * $HeadURL: https://phunctional-system-integration.googlecode.com/svn/tags/psi-reactor-2.4/trunk/psi-util/src/main/java/com/meschbach/psi/util/rest/RequestBuilder.java $
 * $Id: RequestBuilder.java 242 2011-03-07 02:48:48Z [email protected] $
 */
package com.meschbach.psi.util.rest;

import java.net.URI;
import org.apache.http.client.methods.HttpUriRequest;

/**
 * A RequestBuilder represents a factory to construct an HTTP
 * Client specific request method.  This class is utilized by the
 * RESTClient to vary the method to access remote resources.
 * 
 * @author "Mark Eschbach" [email protected]
 * @since 1.2.0 (PSI 2.3.0)
 * @version 1.0.0
 */
public interface RequestBuilder {

    /**
     * Asks the builder to construct an HTTPClient's URI request.
     * 
     * @param resource is the remote resource to be requested
     * @return an HTTP Client request method
     */
    public HttpUriRequest buildRequest(URI resource);
}