ClientResponse.java

/**
 *    Copyright 2014 Opower, Inc.
 *    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.opower.rest.client.generator.core;

import com.opower.rest.client.generator.util.GenericType;

import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

/**
 * Response extension for the RESTEasy client framework. Use this, or Response
 * in your client rest interface method return type declarations if you want
 * access to the response entity as well as status and header information.
 *
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 *
 */
public abstract class ClientResponse extends Response {
    /**
     * This method returns the same exact map as Response.getMetadata() except as a map of strings rather than objects
     *
     * @return
     */
    public abstract MultivaluedMap<String, String> getHeaders();

    public abstract Status getResponseStatus();

    /**
     * Unmarshal the target entity from the response OutputStream.  You must have type information set via <T>
     * otherwise, this will not work.
     * <p/>
     * This method actually does the reading on the OutputStream.  It will only do the read once.  Afterwards, it will
     * cache the result and return the cached result.
     *
     * @return
     */
    public abstract Object getEntity();

    /**
     * Extract the response body with the provided type information
     * <p/>
     * This method actually does the reading on the OutputStream.  It will only do the read once.  Afterwards, it will
     * cache the result and return the cached result.
     *
     * @param type
     * @param <T2>
     * @return
     */
    public abstract <T2> T2 getEntity(Class<T2> type);

    /**
     * Extract the response body with the provided type information
     * <p/>
     * This method actually does the reading on the OutputStream.  It will only do the read once.  Afterwards, it will
     * cache the result and return the cached result.
     *
     * @param type
     * @param genericType
     * @param <T2>
     * @return
     */
    public abstract <T2> T2 getEntity(Class<T2> type, Type genericType);

    /**
     * @param type
     * @param genericType
     * @param annotations
     * @param <T2>
     * @return
     */
    public abstract <T2> T2 getEntity(Class<T2> type, Type genericType, Annotation[] annotations);

    /**
     * Extract the response body with the provided type information.  GenericType is a trick used to
     * pass in generic type information to the resteasy runtime.
     * <p/>
     * For example:
     * <pre>
     * List<String> list = response.getEntity(new GenericType<List<String>() {});
     *
     *
     * This method actually does the reading on the OutputStream.  It will only do the read once.  Afterwards, it will
     * cache the result and return the cached result.
     *
     * @param type
     * @param <T2>
     * @return
     */
    public abstract <T2> T2 getEntity(GenericType<T2> type);

    /**
     * @param type
     * @param annotations
     * @param <T2>
     * @return
     */
    public abstract <T2> T2 getEntity(GenericType<T2> type, Annotation[] annotations);

    /**
     * Attempts to reset the InputStream of the response.  Useful for refetching an entity after a marshalling failure
     * @return
     */
    public abstract boolean resetStream();

    public abstract void releaseConnection();

}