Index (kirara-core 1.0.0 API)

A B C D E G H K M O P R S U W
All Classes and Interfaces|All Packages

A

ApiRequest<T> - Class in enterprises.iwakura.kirara.core: Represents an API request in Kirara.
ApiRequest(Kirara, String, String, String, Class<T>) - Constructor for class enterprises.iwakura.kirara.core.ApiRequest: Constructs an ApiRequest with the specified parameters.
apiUrl - Variable in class enterprises.iwakura.kirara.core.Kirara: The base URL of the API to which requests will be sent.

B

body - Variable in class enterprises.iwakura.kirara.core.ApiRequest: The body of this API request.

C

close() - Method in class enterprises.iwakura.kirara.core.HttpCore: Closes the HTTP core, releasing any resources it holds.
close() - Method in class enterprises.iwakura.kirara.core.impl.HttpUrlConnectionHttpCore
close() - Method in class enterprises.iwakura.kirara.core.Kirara: Closes the HTTP core.
computeRequestUrl() - Method in class enterprises.iwakura.kirara.core.ApiRequest: Computes the request URL for this API request.
convertBodyToBytes(Kirara, Object) - Method in class enterprises.iwakura.kirara.core.HttpCore: Converts the body of an API request to a byte array.
convertBytesToResponse(Kirara, byte[], Class<T>, Map<String, List<String>>) - Method in class enterprises.iwakura.kirara.core.HttpCore: Converts a byte array response to an object of the specified class using the Kirara serializer.
convertToMap(List<RequestHeader>) - Static method in class enterprises.iwakura.kirara.core.RequestHeader: Handy method converting a list of RequestHeader objects to a Map.
createConnection(String, String, List<RequestHeader>) - Method in class enterprises.iwakura.kirara.core.impl.HttpUrlConnectionHttpCore: Creates a new HttpURLConnection for the given URL and method, applying the specified headers.
createRequest(String, String, Class<T>) - Method in class enterprises.iwakura.kirara.core.Kirara: Constructs a ApiRequest class with the specified method, endpoint, and response class.

D

defaultRequestHeaders - Variable in class enterprises.iwakura.kirara.core.Kirara: Default request headers that will be included in every API request.
deserialize(byte[], Class<T>, Map<String, List<String>>) - Method in interface enterprises.iwakura.kirara.core.Serializer: Deserializes a byte array to an object of the specified class.

E

endpoint - Variable in class enterprises.iwakura.kirara.core.ApiRequest: The API endpoint to which the request will be sent.
enterprises.iwakura.kirara.core - package enterprises.iwakura.kirara.core
enterprises.iwakura.kirara.core.impl - package enterprises.iwakura.kirara.core.impl
executor - Variable in class enterprises.iwakura.kirara.core.HttpCore: The executor to schedule API requests on.

G

getExecutor() - Method in class enterprises.iwakura.kirara.core.HttpCore: Returns an executor that can be used to schedule API requests.
getKirara() - Method in interface enterprises.iwakura.kirara.core.SupportsKiraraResponse: Gets the Kirara instance associated with this response.
getNumberOfBytesToReadAtOnce() - Method in class enterprises.iwakura.kirara.core.impl.HttpUrlConnectionHttpCore: Returns the number of bytes to read at once from the input stream.

H

handleKiraraSupportedResponse(Kirara, T) - Method in class enterprises.iwakura.kirara.core.HttpCore: Handles the response for Kirara-supported responses by setting the Kirara instance on the response.
headers - Variable in class enterprises.iwakura.kirara.core.ApiRequest: The headers to be included in this API request.
httpCore - Variable in class enterprises.iwakura.kirara.core.Kirara: The HTTP core used to send requests and receive responses.
HttpCore - Class in enterprises.iwakura.kirara.core: Abstract class representing the core of Kirara's HTTP backend.
HttpCore() - Constructor for class enterprises.iwakura.kirara.core.HttpCore: Default constructor for HttpCore.
HttpUrlConnectionHttpCore - Class in enterprises.iwakura.kirara.core.impl: Implementation of HttpCore using Java's built-in HttpURLConnection.
HttpUrlConnectionHttpCore() - Constructor for class enterprises.iwakura.kirara.core.impl.HttpUrlConnectionHttpCore: Constructs a new HttpUrlConnectionHttpCore instance.

K

kirara - Variable in class enterprises.iwakura.kirara.core.ApiRequest: Kirara instance associated with this request.
kirara - Variable in class enterprises.iwakura.kirara.core.KiraraResponse: The Kirara instance associated with this response.
Kirara - Class in enterprises.iwakura.kirara.core: The base class for Kirara library.
Kirara(HttpCore, Serializer) - Constructor for class enterprises.iwakura.kirara.core.Kirara: Constructs a new Kirara instance with the specified HTTP core and serializer.
Kirara(HttpCore, Serializer, String) - Constructor for class enterprises.iwakura.kirara.core.Kirara: Constructs a new Kirara instance with the specified HTTP core, serializer, and API URL.
KiraraResponse - Class in enterprises.iwakura.kirara.core: Handy implementation of SupportsKiraraResponse that provides a Kirara instance.
KiraraResponse() - Constructor for class enterprises.iwakura.kirara.core.KiraraResponse: Constructor

M

method - Variable in class enterprises.iwakura.kirara.core.ApiRequest: The HTTP method for this request (e.g., "GET", "POST").

O

of(String, String) - Static method in class enterprises.iwakura.kirara.core.PathParameter: Creates a new PathParameter instance.
of(String, String) - Static method in class enterprises.iwakura.kirara.core.RequestHeader: Creates a new RequestHeader instance.
of(String, String) - Static method in class enterprises.iwakura.kirara.core.RequestQuery: Creates a new RequestQuery instance.
onException(ApiRequest<T>, Throwable) - Method in class enterprises.iwakura.kirara.core.Kirara: Invoked when an exception occurs during the request processing or response handling.
onRequest(ApiRequest<T>) - Method in class enterprises.iwakura.kirara.core.Kirara: Invoked just before sending a request.
onResponse(ApiRequest<T>, T) - Method in class enterprises.iwakura.kirara.core.Kirara: Invoked when a response is received.

P

PathParameter - Class in enterprises.iwakura.kirara.core: Represents a path parameter in a request.
PathParameter(String, String) - Constructor for class enterprises.iwakura.kirara.core.PathParameter: Constructor to create a PathParameter instance.
pathParameters - Variable in class enterprises.iwakura.kirara.core.ApiRequest: The path parameters to be included in this API request.

R

readResponse(Kirara, HttpURLConnection, Class<T>) - Method in class enterprises.iwakura.kirara.core.impl.HttpUrlConnectionHttpCore: Reads the response from the connection and converts it to the specified response class.
RequestHeader - Class in enterprises.iwakura.kirara.core: Represents a request header with a key and value.
RequestHeader(String, String) - Constructor for class enterprises.iwakura.kirara.core.RequestHeader: Constructs a new RequestHeader instance with the specified key and value.
requestQueries - Variable in class enterprises.iwakura.kirara.core.ApiRequest: The request queries to be included in this API request.
RequestQuery - Class in enterprises.iwakura.kirara.core: Represents a request query with a key and value.
RequestQuery(String, String) - Constructor for class enterprises.iwakura.kirara.core.RequestQuery: Constructs a new RequestQuery instance with the specified key and value.
responseClass - Variable in class enterprises.iwakura.kirara.core.ApiRequest: The class of the expected response type.

S

send() - Method in class enterprises.iwakura.kirara.core.ApiRequest: Invokes HttpCore.send(ApiRequest) on the current Kirara instance.
send(ApiRequest<T>) - Method in class enterprises.iwakura.kirara.core.HttpCore: Sends an API request and returns a CompletableFuture that will be completed with the response.
send(ApiRequest<T>) - Method in class enterprises.iwakura.kirara.core.impl.HttpUrlConnectionHttpCore
serialize(Object) - Method in interface enterprises.iwakura.kirara.core.Serializer: Serializes an object to a byte array.
serializer - Variable in class enterprises.iwakura.kirara.core.Kirara: The serializer used to convert objects to and from JSON or other formats.
Serializer - Interface in enterprises.iwakura.kirara.core: Kirara's serializer interface used to (de)serialize objects to and from byte arrays.
setKirara(Kirara) - Method in interface enterprises.iwakura.kirara.core.SupportsKiraraResponse: Sets the Kirara instance for this response.
SupportsKiraraResponse - Interface in enterprises.iwakura.kirara.core: Interface for classes that support a Kirara instance.

U

url - Variable in class enterprises.iwakura.kirara.core.ApiRequest: The base URL for the API.

W

withBody(Object) - Method in class enterprises.iwakura.kirara.core.ApiRequest: Sets the body of this API request.
withExplicitHeaders(List<RequestHeader>) - Method in class enterprises.iwakura.kirara.core.ApiRequest: Sets headers for this API requests, discarding any previously set headers.
withExplicitPathParameters(Set<PathParameter>) - Method in class enterprises.iwakura.kirara.core.ApiRequest: Sets path parameters for this API request, discarding any previously set path parameters.
withExplicitRequestQueries(Set<RequestQuery>) - Method in class enterprises.iwakura.kirara.core.ApiRequest: Sets request queries for this API request, discarding any previously set request queries.
withHeader(RequestHeader) - Method in class enterprises.iwakura.kirara.core.ApiRequest: Adds a request header to this API request.
withPathParameter(PathParameter) - Method in class enterprises.iwakura.kirara.core.ApiRequest: Adds a path parameter to this API request.
withRequestQuery(RequestQuery) - Method in class enterprises.iwakura.kirara.core.ApiRequest: Adds a request query to this API request.
withUrl(String) - Method in class enterprises.iwakura.kirara.core.ApiRequest: Sets the URL for this API request.
writeBody(Kirara, HttpURLConnection, Object) - Method in class enterprises.iwakura.kirara.core.impl.HttpUrlConnectionHttpCore: Writes the body of the request to the connection's output stream.

A B C D E G H K M O P R S U W
All Classes and Interfaces|All Packages