com.github.libgraviton.gdk.api.Response Maven / Gradle / Ivy

Go to download
package com.github.libgraviton.gdk.api;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.type.CollectionType;
import com.github.libgraviton.gdk.api.header.HeaderBag;
import com.github.libgraviton.gdk.exception.DeserializationException;
import com.github.libgraviton.gdk.serialization.JsonPatcher;

import java.io.IOException;
import java.util.List;

/**
 * Graviton response wrapper with additional functionality and simplified interface.
 *
 * @author List of contributors {@literal }
 * @see http://swisscom.ch
 * @version $Id: $Id
 */
public class Response {

    protected Request request;

    protected int code;

    protected String message;

    protected HeaderBag headers;

    protected byte[] body;

    protected boolean isSuccessful;

    protected ObjectMapper objectMapper;

    protected Response() {
    }

    protected Response(Response.Builder builder) {
        request = builder.request;
        code = builder.code;
        isSuccessful = builder.isSuccessful;
        message = builder.message;
        body = builder.body;
        headers = builder.headerBuilder.build();
    }

    public boolean isSuccessful() {
        return isSuccessful;
    }

    /**
     * Deserialize the response body into the requested POJO class.
     *
     * @param beanClass the requested POJO class
     * @param  requested POJO must extend from this class
     * @return serialized POJO
     * @throws DeserializationException will be thrown on a failed deserialization / POJO mapping
     */
    public  BeanClass getBodyItem(final Class beanClass) throws DeserializationException {
        if(getObjectMapper() == null) {
            throw new IllegalStateException("'objectMapper' is not allowed to be null.");
        }

        try {
            BeanClass pojoValue = getObjectMapper().readValue(getBody(), beanClass);
            JsonPatcher.add(pojoValue, getObjectMapper().valueToTree(pojoValue));
            return pojoValue;
        } catch (IOException e) {
            throw new DeserializationException(String.format(
                    "Unable to deserialize response body from '%s' to class '%s'.",
                    getRequest().getUrl(),
                    beanClass.getName()
            ), e);
        }
    }

    /**
     * Deserialize the response body into a list with elements of the requested POJO class.
     *
     * @param beanClass the requested POJO class
     * @param  requested POJO must extend from this class
     * @return serialized list with POJO elements
     * @throws DeserializationException will be thrown on a failed deserialization / POJO mapping
     */
    public  List getBodyItems(final Class beanClass) throws DeserializationException {
        if(getObjectMapper() == null) {
            throw new IllegalStateException("'objectMapper' is not allowed to be null.");
        }

        try {
            final CollectionType javaType =
                    getObjectMapper().getTypeFactory().constructCollectionType(List.class, beanClass);
            List pojoValues = getObjectMapper().readValue(getBody(), javaType);
            for (BeanClass pojoValue : pojoValues) {
                JsonPatcher.add(pojoValue, getObjectMapper().valueToTree(pojoValue));
            }
            return pojoValues;
        } catch (IOException e) {
            throw new DeserializationException(String.format(
                    "Unable to deserialize response body from '%s' to class '%s'.",
                    getRequest().getUrl(),
                    beanClass.getName()
            ), e);
        }
    }

    /**
     * Deserialize the response body. Should only be used if no binary file is expected as response.
     * @return response body as String
     */
    public String getBody() {
        return body != null ? new String(body) : null;
    }

    /**
     * Deserialize the response body. Can also be used if binary file is expected as response.
     *
     * @return response body
     */
    public byte[] getBodyBytes() {
        return body;
    }

    public HeaderBag getHeaders() {
        return headers;
    }

    public Request getRequest() {
        return request;
    }


    public ObjectMapper getObjectMapper() {
        return objectMapper;
    }
    public void setObjectMapper(ObjectMapper objectMapper) {
        this.objectMapper = objectMapper;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    public static class Builder {

        protected int code;

        protected String message;

        protected Request request;

        protected byte[] body;

        protected boolean isSuccessful;

        protected HeaderBag.Builder headerBuilder;

        public Builder(Request request) {
            this.request = request;
            headerBuilder = new HeaderBag.Builder();
        }

        public Builder code(int code) {
            this.code = code;
            return this;
        }

        public Builder successful(boolean isSuccessful) {
            this.isSuccessful = isSuccessful;
            return this;
        }

        public Builder message(String message) {
            this.message = message;
            return this;
        }

        public Builder body(byte[] body) {
            this.body = body;
            return this;
        }

        public Builder headers(HeaderBag.Builder builder) {
            this.headerBuilder = builder;
            return this;
        }

        public Response build() {
            return new Response(this);
        }

    }

}