com.github.kristofa.test.http.client.ApacheHttpClientResponseImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mock-http-server Show documentation

Mock and Proxy HTTP Server for testing purposes. Forked from https://github.com/jharlap/mock-http-server

There is a newer version: 4.1

package com.github.kristofa.test.http.client;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

/**
 * Response as being returned by {@link ApacheHttpClientImpl}. Provides the user with the HTTP response code, a response
 * entity and optional error message.
 * 
 * IMPORTANT: Call {@link ApacheHttpClientResponseImpl#close()} method when done with process response. This will clean-up
 * resources.
 * 
 * @author kristof
 * @param  Type for response entity.
 */
public class ApacheHttpClientResponseImpl implements HttpClientResponse {

    private final int httpCode;
    private final org.apache.http.client.HttpClient httpClient;
    private String errorMessage;
    private T responseEntity;
    private String contentType;

    /**
     * Create a new response instance.
     * 
     * @param httpCode Http code.
     * @param httpClient The Http client that was used to generate this response.
     */
    public ApacheHttpClientResponseImpl(final int httpCode, final org.apache.http.client.HttpClient httpClient) {
        Validate.notNull(httpClient);
        this.httpCode = httpCode;
        this.httpClient = httpClient;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean success() {
        return StringUtils.isBlank(errorMessage);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getHttpCode() {
        return httpCode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getErrorMessage() {
        return errorMessage;
    }

    /**
     * Sets the error message.
     * 
     * @param errorMessage Error message.
     */
    public void setErrorMessage(final String errorMessage) {
        this.errorMessage = errorMessage;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public T getResponseEntity() {
        return responseEntity;
    }

    /**
     * Sets the response object.
     * 
     * @param responseEntity Response object.
     */
    public void setResponseEntity(final T responseEntity) {
        this.responseEntity = responseEntity;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getContentType() {
        return contentType;
    }

    /**
     * Sets the content type.
     * 
     * @param contentType Content type.
     */
    public void setContentType(final String contentType) {
        this.contentType = contentType;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void close() {
        httpClient.getConnectionManager().shutdown();
    }

    /*
     * (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return HashCodeBuilder.reflectionHashCode(this, false);
    }

    /*
     * (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(final Object obj) {
        return EqualsBuilder.reflectionEquals(this, obj, false);
    }

}