com.github.yongchristophertang.engine.web.request.HttpMultipartRequestBuilders Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-connector Show documentation

A test client framework for RESTful HTTP and Java APIs

There is a newer version: 0.6.1

/*
 * Copyright 2014-2015 the original author or authors.
 *
 * 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.
 */

package com.github.yongchristophertang.engine.web.request;

import com.github.yongchristophertang.engine.web.http.MultipartBodyFormBuilder;
import com.github.yongchristophertang.engine.web.http.BodyForm;
import org.apache.http.HttpEntity;
import org.apache.http.HttpRequest;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpRequestBase;

/**
 * Multipart builder to build {@link org.apache.http.client.methods.HttpRequestBase}.
 *
 * @author Yong Tang
 * @since 0.4
 */
public class HttpMultipartRequestBuilders extends HttpRequestBuilders {
    private HttpEntity httpEntity;

    /**
     * Package private constructor. To get an instance, use static factory
     * methods in {@link TestRequestBuilders}.
     * 
     * Although this class cannot be extended, additional ways to initialize
     * the {@code MockHttpServletRequest} can be plugged in via
     * {@link #with(RequestPostProcessor)}.
     *
     * @param httpRequest an HttpRequest object
     * @param urlTemplate  a URL template; the resulting URL will be encoded
     * @param urlVariables zero or more URL variables
     */
    HttpMultipartRequestBuilders(HttpRequest httpRequest, String urlTemplate, String description,
            Object... urlVariables) {
        super(httpRequest, urlTemplate, description, urlVariables);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public HttpRequestBase buildRequest() throws Exception {
        HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) super.buildRequest();
        requestBase.setEntity(httpEntity);
        return requestBase;
    }

    /**
     * Set the multipart body
     *
     * @param multipartBodyFormBuilder factory builder for {@link BodyForm}
     */
    public HttpRequestBuilders body(MultipartBodyFormBuilder multipartBodyFormBuilder) {
        this.httpEntity = multipartBodyFormBuilder.buildBody().getHttpEntity();
        return this;
    }

}