Verified Owner
Top Fields Constructors Methods
org.jabref.model.http

public final Record SimpleHttpResponse

extends Record
Class Inheritance
Record Components
statusCode:int 
responseMessage:String 
responseBody:String 
Imports
java.io.BufferedReader, .IOException, .InputStream, .InputStreamReader, java.net.HttpURLConnection, java.nio.charset.StandardCharsets, org.jsoup.HttpStatusException

Field Summary

Modifier and TypeField and Description
private static final int
private final String
responseBody

Record Component accessed by responseBody().

private final String
responseMessage

Record Component accessed by responseMessage().

private final int
statusCode

Record Component accessed by statusCode().

Constructor Summary

AccessConstructor and Description
public
SimpleHttpResponse(int statusCode, String responseMessage, String responseBody)

public
public

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

private static String

Returns:

the response body as a string
getResponseBody
(HttpURLConnection
the HttpURLConnection to read the response body from
connection
)

Reads the response body from the HttpURLConnection and returns it as a string.

private static String
private static String
private static int
public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public String
responseBody()

Record Component getter of responseBody.

public String
responseMessage()

Record Component getter of responseMessage.

public int
statusCode()

Record Component getter of statusCode.

public String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

private static String

Returns:

the truncated response body
truncateResponseBody
(String
the original response body
responseBody
)

Truncates the response body to 1 KB if it exceeds that size.

Field Detail

MAX_RESPONSE_LENGTHback to summary
private static final int MAX_RESPONSE_LENGTH
responseBodyback to summary
private final String responseBody

Record Component accessed by responseBody().

responseMessageback to summary
private final String responseMessage

Record Component accessed by responseMessage().

statusCodeback to summary
private final int statusCode

Record Component accessed by statusCode().

Constructor Detail

SimpleHttpResponseback to summary
public SimpleHttpResponse(int statusCode, String responseMessage, String responseBody)
SimpleHttpResponseback to summary
public SimpleHttpResponse(HttpURLConnection connection)
SimpleHttpResponseback to summary
public SimpleHttpResponse(HttpStatusException e)

Method Detail

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
getResponseBodyback to summary
private static String getResponseBody(HttpURLConnection connection) throws IOException

Reads the response body from the HttpURLConnection and returns it as a string. This method is used to retrieve the response body from the connection, which may contain error messages or other information from the server.

Parameters
connection:HttpURLConnection

the HttpURLConnection to read the response body from

Returns:String

the response body as a string

Exceptions
IOException:
if an I/O error occurs while reading the response body
getResponseBodyDefaultEmptyback to summary
private static String getResponseBodyDefaultEmpty(HttpURLConnection connection)
getResponseMessageback to summary
private static String getResponseMessage(HttpURLConnection connection)
getStatusCodeback to summary
private static int getStatusCode(HttpURLConnection connection)
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

responseBodyback to summary
public String responseBody()

Record Component getter of responseBody.

responseMessageback to summary
public String responseMessage()

Record Component getter of responseMessage.

statusCodeback to summary
public int statusCode()

Record Component getter of statusCode.

toStringback to summary
public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Annotations
@Override
truncateResponseBodyback to summary
private static String truncateResponseBody(String responseBody)

Truncates the response body to 1 KB if it exceeds that size. Appends "... (truncated)" to indicate truncation.

Parameters
responseBody:String

the original response body

Returns:String

the truncated response body