com.hpe.adm.nga.sdk.network.OctaneHttpResponse Maven / Gradle / Ivy
/*
* © Copyright 2016-2020 Micro Focus or one of its affiliates.
* 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.hpe.adm.nga.sdk.network;
import com.google.api.client.util.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
/**
* HTTP response.
* Callers should call disconnect() when the HTTP response object is no longer needed. However, disconnect() does not have to be called if the response stream is properly closed.
*
* Created by leufl on 2/11/2016.
*/
public class OctaneHttpResponse {
private final int statusCode;
private final byte[] content;
private static final Logger logger = LoggerFactory.getLogger(OctaneHttpResponse.class.getName());
private final Charset responseCharset;
public OctaneHttpResponse(int statusCode, InputStream inputStream, Charset responseCharset) {
this.statusCode = statusCode;
this.responseCharset = responseCharset;
final ByteArrayOutputStream out = new ByteArrayOutputStream();
try {
IOUtils.copy(inputStream, out);
} catch (IOException e) {
logger.error("Cannot create output stream", e);
}
content = out.toByteArray();
}
/**
* @return - Returns whether received a successful HTTP status code
*/
public boolean isSuccessStatusCode() {
return statusCode >= 200 && statusCode < 300;
}
/**
* Parses the content of the HTTP response from getContent() and reads it into a string.
* Since this method returns "" for no content, a simpler check for no content is to check if getContent() is null.
* All content is read from the input content stream rather than being limited by the Content-Length. For the character set, it follows the specification by parsing the "charset" parameter of the Content-Type header or by default "ISO-8859-1" if the parameter is missing.
*
* @return - parsed string or "" for no content
*/
public String getContent() {
return new String(content, responseCharset);
}
/**
* Returns the content of the HTTP response.
* The result is cached, so subsequent calls will be fast.
* Callers should call InputStream.close() after the returned InputStream is no longer needed.
* disconnect() does not have to be called if the content is closed.
*
* @return - input stream content of the HTTP response or null for none
*/
public InputStream getInputStream() {
return new ByteArrayInputStream(content);
}
}