All Classes

Class	Description
AbstractApiClient	Abstract base class for API clients providing common HTTP request handling.
AbstractOAuth2Strategy	Abstract base class for OAuth 2.0 authentication strategies.
AdpApiExample	Example demonstrating how to call the ADP API using: 1.
ApiError	Represents an API error in the Result pattern.
ApiError.ErrorType	Enum representing different types of errors that can occur.
ApiException	Exception thrown when an API request fails with rich error details.
AsyncApiClient	Asynchronous API client that returns CompletableFuture for non-blocking operations.
AsyncHttpClient	Asynchronous HTTP client that executes requests on a dedicated thread pool.
AuthStrategy	Interface for authentication strategies used by RocketRest.
AuthStrategy.AuthType	Enum representing different authentication types.
AuthStrategyFactory	Factory for creating AuthStrategy instances.
BasicAuthStrategy	Authentication strategy that uses HTTP Basic authentication.
BearerTokenStrategy	Authentication strategy that uses Bearer token authentication.
CircuitBreakerClient	Decorator that adds circuit breaker resilience pattern to any RocketClient.
CircuitBreakerClient.FailurePolicy	Strategy for differentiating between failures
CircuitBreakerClient.State	Circuit breaker state
CircuitBreakerOpenException	Exception thrown when a request is rejected due to an open circuit breaker.
DefaultApiClient	Default synchronous API client implementation.
DefaultHttpClient	Default implementation of RocketClient using Java's built-in HttpURLConnection.
Example	Interface for all RocketRest examples
FakeJsonApiExample	Example that demonstrates fetching data from multiple endpoints of a Fake-JSON API
FluentApiClient	A fluent API client that uses the Result pattern instead of exceptions.
FluentApiExample	Example demonstrating the Result-based API for developers who prefer a more declarative approach without exceptions.
FluentHttpClient	HTTP client using the Result pattern for exception-free error handling.
HelloWorld	Main example runner that presents a menu of examples to run
HttpConstants	Centralized constants for HTTP operations used throughout RocketRest.
HttpConstants.CircuitBreaker	CircuitBreaker-related constants
HttpConstants.Encoding	Encoding constants
HttpConstants.Errors	Common error messages
HttpConstants.Methods	HTTP methods
HttpConstants.StatusCodes	HTTP status codes
HttpConstants.Timeouts	Connection timeouts in milliseconds
HttpConstants.Url	URL and encoding constants
InterceptingClient	Decorator that adds interceptor chain support to any RocketClient.
InterceptorChain	Represents the interceptor chain during request execution.
JsonObjectMapper	Pre-configured Jackson ObjectMapper with utility methods for JSON operations.
JsonTodoExample	Example that demonstrates fetching a Todo from JSONPlaceholder API
MockRocketClient	Mock implementation of RocketClient for unit testing without network requests.
NasaApodExample	Example demonstrating how to fetch NASA's Astronomy Picture of the Day (APOD) using RocketRest's fluent API.
NasaApodExample.ApodResponse	POJO class representing the NASA APOD API response
NoAuthStrategy	Authentication strategy that performs no authentication.
OAuth2AssertionStrategy	Authentication strategy that implements OAuth 2.0 assertion flow.
OAuth2ClientCredentialsStrategy	Authentication strategy that implements OAuth 2.0 client credentials flow.
OAuth2PasswordStrategy	Authentication strategy that implements OAuth 2.0 password flow.
PokeApiExample	Example demonstrating how to use the PokéAPI with RocketRest's fluent API, including pagination support.
PokeApiExample.AbilityInfo	Ability information for a Pokémon
PokeApiExample.AbilityListResponse	Response for the Abilities list endpoint
PokeApiExample.DamageRelations	Damage relations information for a type
PokeApiExample.MoveInfo	Move information for a Pokémon
PokeApiExample.NamedResource	Named resource (name and URL) used throughout the API
PokeApiExample.PaginatedResponse<T>	Base response for paginated results
PokeApiExample.PokemonDetailResponse	Detailed Pokémon response
PokeApiExample.PokemonListResponse	Response for the Pokémon list endpoint
PokeApiExample.StatInfo	Stat information for a Pokémon
PokeApiExample.TypeDetailResponse	Response for the Type details endpoint
PokeApiExample.TypeInfo	Type information for a Pokémon
PokeApiExample.TypeListResponse	Response for the Types list endpoint
RequestBuilder<Req,Res>	Fluent builder for constructing RequestSpec instances.
RequestInterceptor	Interceptor for adding cross-cutting behavior to HTTP request execution.
RequestSpec<Req,Res>	Immutable specification of an HTTP request containing all parameters needed for execution.
ResponseLogger	Utility class for configurable HTTP response logging.
Result<T,E>	A container object representing either a successful result or an error.
RetryInterceptor	Interceptor that retries failed requests with configurable backoff.
RetryInterceptor.Builder	Builder for creating customized RetryInterceptor instances.
RocketClient	Core interface for HTTP request execution in RocketRest.
RocketClientFactory	Factory for creating and configuring HTTP clients with decorators and settings.
RocketClientFactory.Builder	Builder class for constructing RocketClient instances with various decorators.
RocketHeaders	Fluent builder for HTTP request headers with convenience methods for common headers.
RocketHeaders.ContentTypes	Common content types as constants.
RocketHeaders.Names	Standard HTTP header names as constants.
RocketRest	Main entry point for interacting with REST APIs using RocketRest.
RocketRest.AsyncApi	Interface for asynchronous API operations.
RocketRest.FluentApi	Interface for fluent API operations with a Result pattern.
RocketRest.SyncApi	Interface for synchronous API operations.
RocketRestCircuitBreakerExample	Example demonstrating the Circuit Breaker pattern using RocketRest with https://httpstat.us/ as a test service.
RocketRestConfig	Configuration container for RocketRest clients.
RocketRestConfig.Builder	Builder for creating RocketRestConfig instances.
RocketRestException	Base runtime exception for all HTTP-related errors in RocketRest.
RocketRestFluentExample	Example demonstrating the Fluent API interface with Result pattern using the main RocketRest class.
RocketRestMock	Mock implementation of RocketRest for unit testing without actual HTTP requests.
RocketRestOptions	Configuration options for RocketRest API clients.
RocketRestSecureConfig	Extended configuration for RocketRest clients requiring custom SSL/TLS certificates.
RocketRestSecureConfig.SecureBuilder	Builder for creating RocketRestSecureConfig instances.
RocketSSL	Utility class for handling SSL (TLS 1.2 and 1.3) certificates and contexts.
RocketSSL.SSLAware	Interface for authentication strategies that can be configured with an SSL context.
RocketSSL.SSLCertificate	Class representing certificate information.
RocketSSL.SSLConfig	Interface for objects that can provide certificate information.
SapIdpExample	Example demonstrating SAP IDP authentication and API usage.
StreamUtils	Utility class for safe input stream operations with proper resource management.
Todo	Model class for JSON response from JSONPlaceholder Todo API
TokenExpiredException	Exception thrown when an API request fails due to token expiration.
TokenRefreshException	Exception thrown when token refresh fails.
WeatherExample	Example demonstrating how to use RocketRest's async API to fetch weather data from wttr.in service.
WeatherExample.Astronomy	Astronomy information
WeatherExample.CurrentCondition	Current weather conditions
WeatherExample.NearestArea	Nearest area information
WeatherExample.Value	Generic value class for nested structures
WeatherExample.Weather	Weather forecast information
WeatherExample.WeatherDesc	Weather description
WeatherExample.WeatherResponse	Main weather response class