com.huawei.openstack4j.core.transport.HttpResponse Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2016 ContainX and OpenStack4j
*
* 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.huawei.openstack4j.core.transport;
import java.io.Closeable;
import java.io.InputStream;
import java.util.Map;
/**
* Wraps a Response from the Jersey Client
*
* @author Jeremy Unruh
*/
public interface HttpResponse extends Closeable {
/**
* Gets the entity and Maps any errors which will result in a ResponseException
*
* @param the generic type
* @param returnType the return type
* @return the entity
*/
T getEntity(Class returnType);
/**
* Gets the entity and Maps any errors which will result in a ResponseException
*
* @param the generic type
* @param returnType the return type
* @param options execution options
* @return the entity
*/
T getEntity(Class returnType, ExecutionOptions options);
/**
* Reads the entity as is into the specified type without any exception mapping
*
* @param typeToReadAs the type to read the desired entity in as
* @return the entity
*/
T readEntity(Class typeToReadAs);
/**
* Gets the status from the previous Request
*
* @return the status code
*/
int getStatus();
/**
* The current content-type within the response
*
* @return the response content-type
*/
String getContentType();
/**
* The status message which is associated with the current {@link #getStatus()}
* @return the status message or null
*/
String getStatusMessage();
/**
* @return the input stream
*/
InputStream getInputStream();
/**
* Returns a Header value from the specified name key
*
* @param name the name of the header to query for
* @return the header as a String or null if not found
*/
String header(String name);
/**
* @return the a Map of Header Name to Header Value
*/
Map headers();
}