Skip to content

Commit

Permalink
add ResponseException#status (#756)
Browse files Browse the repository at this point in the history
this allows accessing the HTTP status code of the response when an API
returns a `ResponseException`. this was not possible through
`getResponse` since `Response` itself is package-private and thus its
members (even though they are marked as `public`) are not accessible to
external consumers.

solves #749

Signed-off-by: Ralph Ursprung <[email protected]>
  • Loading branch information
rursprung authored Dec 4, 2023
1 parent 9213138 commit 863518c
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This section is for maintaining a changelog for all breaking changes for the cli

### Added
- Document HTTP/2 support ([#330](https://github.com/opensearch-project/opensearch-java/pull/330))
- Expose HTTP status code through `ResponseException#status` ([#756](https://github.com/opensearch-project/opensearch-java/pull/756))

### Dependencies

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ static String buildMessage(Response response) throws IOException {
response.getRequestLine().getMethod(),
response.getHost(),
response.getRequestLine().getUri(),
response.getStatusLine().toString()
response.getStatusLine()
);

if (response.hasWarnings()) {
Expand Down Expand Up @@ -92,4 +92,11 @@ static String buildMessage(Response response) throws IOException {
public Response getResponse() {
return response;
}

/**
* HTTP status code returned by OpenSearch.
*/
public int status() {
return this.response.getStatusLine().getStatusCode();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package org.opensearch.client.transport.httpclient5;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;

import java.io.IOException;
import org.apache.hc.core5.http.HttpHost;
import org.apache.hc.core5.http.HttpStatus;
import org.apache.hc.core5.http.HttpVersion;
import org.apache.hc.core5.http.message.BasicClassicHttpResponse;
import org.apache.hc.core5.http.message.RequestLine;
import org.junit.Test;

public class ResponseExceptionTest {

@Test
public void testStatus() throws IOException {
final var response = this.buildResponseException(HttpStatus.SC_BAD_REQUEST);
assertThat(response.status(), equalTo(HttpStatus.SC_BAD_REQUEST));
}

private ResponseException buildResponseException(final int statusCode) throws IOException {
return new ResponseException(this.buildTestResponse(statusCode));
}

private Response buildTestResponse(final int statusCode) {
return new Response(
new RequestLine("GET", "/", HttpVersion.HTTP_1_1),
new HttpHost("localhost"),
new BasicClassicHttpResponse(statusCode)
);
}

}

0 comments on commit 863518c

Please sign in to comment.