Index (Rhyme - Core Framework 1.2.0-SNAPSHOT API)

A B C E F G H I L O R S V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

asEmbeddedResource(T) - Static method in class io.wcm.caravan.rhyme.api.server.ResourceConversions: Create a proxy of a resource that also implements EmbeddableResource.
asEmbeddedResourceWithoutLink(T) - Static method in class io.wcm.caravan.rhyme.api.server.ResourceConversions: Create a proxy of a resource that also implements EmbeddableResource, with EmbeddableResource.isLinkedWhenEmbedded() returning false.
asLinkableResource(Link, Class<T>) - Static method in class io.wcm.caravan.rhyme.api.server.ResourceConversions: Create a proxy for the given interface that can only be used to create links to that resource.
AsyncHalResponseRenderer - Interface in io.wcm.caravan.rhyme.api.server: Asynchronously creates a HalResponse from a server-side HalApiInterface implementation instance, using AsyncHalResourceRenderer to render a HalResource, and VndErrorResponseRenderer to handle any errors that might happen during resource rendering.

B

build() - Method in interface io.wcm.caravan.rhyme.api.client.HalApiClientBuilder
build() - Method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder: Create the HalResourceLoader with the HTTP and caching configuration defined by the previous methods calls
build() - Method in interface io.wcm.caravan.rhyme.api.server.HalResponseRendererBuilder
buildForRequestTo(String) - Method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Create the Rhyme instance to be used to throughout the lifecycle of an incoming request

C

CachingConfiguration - Interface in io.wcm.caravan.rhyme.api.client: A configuration instance for the caching HalResourceLoader implementations created with HalResourceLoaderBuilder.
close() - Method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsStopwatch: Stops the execution time measurement, and forward the result to the RequestMetricsCollector instance from which this stopwatch was created.
CONTENT_TYPE - Static variable in interface io.wcm.caravan.rhyme.api.server.VndErrorResponseRenderer: the ContentType header used for error responses
convertFromObservable(Class<T>) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiReturnTypeSupport
convertToObservable(Class<?>) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiReturnTypeSupport
create() - Static method in interface io.wcm.caravan.rhyme.api.client.HalApiClient: Create a stand-alone HalApiClient (i.e. not to be used in the lifecycle of a Rhyme instance) that is using a default, blocking HTTP client.
create() - Static method in interface io.wcm.caravan.rhyme.api.client.HalApiClientBuilder
create() - Static method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder
create() - Static method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: Create a new instance to collect the full data on upstream requests and measure performance for the current incoming request.
create() - Static method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Create a RhymeBuilder to build Rhyme instances that use a simple default HTTP client to load upstream resources.
create() - Static method in interface io.wcm.caravan.rhyme.api.server.HalResponseRendererBuilder
create() - Static method in interface io.wcm.caravan.rhyme.api.spi.HalResourceLoader: Create a HalResourceLoader that uses a HttpURLConnection with default configuration to load the upstream resources.
create(RequestMetricsCollector, ExceptionStatusAndLoggingStrategy) - Static method in interface io.wcm.caravan.rhyme.api.server.AsyncHalResponseRenderer: Deprecated.
Use HalResponseRendererBuilder instead
create(RequestMetricsCollector, ExceptionStatusAndLoggingStrategy, HalApiAnnotationSupport, HalApiReturnTypeSupport) - Static method in interface io.wcm.caravan.rhyme.api.server.AsyncHalResponseRenderer: Deprecated.
Use HalResponseRendererBuilder instead
create(ExceptionStatusAndLoggingStrategy) - Static method in interface io.wcm.caravan.rhyme.api.server.VndErrorResponseRenderer
create(HalResourceLoader) - Static method in interface io.wcm.caravan.rhyme.api.client.HalApiClient: Create a stand-alone HalApiClient (i.e. not to be used in the lifecycle of a Rhyme instance) that executes the HTTP request with the given HalResourceLoader.
create(HalResourceLoader, RequestMetricsCollector) - Static method in interface io.wcm.caravan.rhyme.api.client.HalApiClient: Deprecated.
use HalApiClientBuilder instead
create(HalResourceLoader, RequestMetricsCollector, HalApiAnnotationSupport, HalApiReturnTypeSupport) - Static method in interface io.wcm.caravan.rhyme.api.client.HalApiClient: Deprecated.
use HalApiClientBuilder instead
create(HttpClientSupport) - Static method in interface io.wcm.caravan.rhyme.api.spi.HalResourceLoader: Create a HalResourceLoader that uses a custom HTTP client, but does not implement any caching.
createEssentialCollector() - Static method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: Create a minimal implementation that only captures the max-age value of upstream responses, but does not perform any other measurements and will not allow to render any embedded metadata into the response
createMetadataResource(LinkableResource) - Method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: Create a resource with performance analysis data that can be embedded in the response

E

EMBED_RHYME_METADATA - Static variable in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: The name of the query parameter that toggles whether the "rhyme:metadata" resource is embedded when rendering resources.
ExceptionStatusAndLoggingStrategy - Interface in io.wcm.caravan.rhyme.api.spi: Allows users of this framework to specify how VndErrorResponseRenderer handles specific exceptions that the framework doesn't know about
executeGetRequest(URI, HttpClientCallback) - Method in interface io.wcm.caravan.rhyme.api.spi.HttpClientSupport: Starts executing a HTTP GET request for the given URL (either synchronously or asynchronously) and calls the call the following methods *once* in this order: HttpClientCallback.onUrlModified(URI) (optional) HttpClientCallback.onHeadersAvailable(int, java.util.Map) (required) HttpClientCallback.onBodyAvailable(java.io.InputStream) (required) If any exception is thrown that prevents starting or completing the request, you must call HttpClientCallback.onExceptionCaught(Throwable) once (and do not call any further methods).
extractStatusCode(Throwable) - Method in interface io.wcm.caravan.rhyme.api.spi.ExceptionStatusAndLoggingStrategy

F

FOLDER - Static variable in interface io.wcm.caravan.rhyme.api.spi.RhymeDocsSupport: the folder in the classpath where the generated HTML files are located

G

getBody() - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
getContentType() - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
getContentType(Class<?>) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport
getDefaultMaxAge(Optional<Integer>) - Method in interface io.wcm.caravan.rhyme.api.client.CachingConfiguration: Determines for how long a cached response that doesn't have a "cache-control: max-age" directive will be used (before it is considered stale and retrieved again)
getErrorMessageWithoutRedundantInformation(Throwable) - Method in interface io.wcm.caravan.rhyme.api.spi.ExceptionStatusAndLoggingStrategy
getErrorResponse() - Method in exception io.wcm.caravan.rhyme.api.exceptions.HalApiClientException
getHalResource(String) - Method in interface io.wcm.caravan.rhyme.api.spi.HalResourceLoader: Provides the response to a GET request for the given URL.
getMaxAge() - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
getPropertyName(Method) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport
getRelation(Method) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport
getRemoteResource(String, Class<T>) - Method in interface io.wcm.caravan.rhyme.api.client.HalApiClient: Create a dynamic client proxy to load and navigate through HAL+JSON resources
getRemoteResource(String, Class<T>) - Method in interface io.wcm.caravan.rhyme.api.Rhyme: Create a dynamic client proxy to load and navigate through HAL+JSON resources from an upstream service.
getRequestUrl() - Method in exception io.wcm.caravan.rhyme.api.exceptions.HalApiClientException
getResponseMaxAge() - Method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: Calculates the "max-age" Cache-Control header value to be used when rendering the response.
getRhymeDocsBaseUrl() - Method in interface io.wcm.caravan.rhyme.api.spi.RhymeDocsSupport: This method allows the framework to construct the full URL from which the documentation will be served, which is important for the curie links to be constructed correctly
getStatus() - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
getStatusCode() - Method in exception io.wcm.caravan.rhyme.api.exceptions.HalApiClientException
getStatusCode() - Method in exception io.wcm.caravan.rhyme.api.exceptions.HalApiServerException
getTimestamp() - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
getUri() - Method in class io.wcm.caravan.rhyme.api.common.HalResponse

H

HalApiAnnotationSupport - Interface in io.wcm.caravan.rhyme.api.spi: An SPI interface that allows the core framework to support additional annotations in your HAL-API interfaces.
HalApiClient - Interface in io.wcm.caravan.rhyme.api.client: A type-safe HAL client that will create a dynamic proxy implementation for a given URI and HalApiInterface.
HalApiClientBuilder - Interface in io.wcm.caravan.rhyme.api.client: A fluent builder to create and customize HalApiClient instances for advanced integration or test scenarios.
HalApiClientException - Exception in io.wcm.caravan.rhyme.api.exceptions: Thrown whenever the HalApiClient implementation fails to load a HAL resource, and provides access to the status code and URL of the failed HTTP request.
HalApiClientException(HalResponse, String, Throwable) - Constructor for exception io.wcm.caravan.rhyme.api.exceptions.HalApiClientException: Deprecated.
use HalApiClientException(HalResponse, Throwable) instead, and make sure that HalResponse.withUri(String) was called
HalApiClientException(HalResponse, Throwable) - Constructor for exception io.wcm.caravan.rhyme.api.exceptions.HalApiClientException: Constructor to use if the request failed with a non-successful HTTP status code
HalApiClientException(String, HalApiClientException) - Constructor for exception io.wcm.caravan.rhyme.api.exceptions.HalApiClientException: Constructor used to re-throw a HalApiClientException and add additional context information
HalApiClientException(String, Integer, String, Throwable) - Constructor for exception io.wcm.caravan.rhyme.api.exceptions.HalApiClientException: Constructor to use if no response body was received from the upstream service.
HalApiDeveloperException - Exception in io.wcm.caravan.rhyme.api.exceptions: Thrown by the framework whenever an error condition is likely to be caused by invalid code (rather than network or data issues)
HalApiDeveloperException(String) - Constructor for exception io.wcm.caravan.rhyme.api.exceptions.HalApiDeveloperException
HalApiDeveloperException(String, Throwable) - Constructor for exception io.wcm.caravan.rhyme.api.exceptions.HalApiDeveloperException
HalApiReturnTypeSupport - Interface in io.wcm.caravan.rhyme.api.spi: An SPI interface that allows to use additional return types (e.g.
HalApiServerException - Exception in io.wcm.caravan.rhyme.api.exceptions: A server-side exception that you can throw in your resource implementations if you want to send a response with a specific status code
HalApiServerException(int, String) - Constructor for exception io.wcm.caravan.rhyme.api.exceptions.HalApiServerException
HalApiServerException(int, String, Throwable) - Constructor for exception io.wcm.caravan.rhyme.api.exceptions.HalApiServerException
HalResourceLoader - Interface in io.wcm.caravan.rhyme.api.spi: An interface to delegate (or mock) the actual loading (and caching) of all JSON+HAL resources loaded via HalApiClient and Rhyme to any other HTTP client client implementation.
HalResourceLoaderBuilder - Interface in io.wcm.caravan.rhyme.api.client: A builder to create and configure a HalResourceLoader instance that is using a custom HTTP client implementation and/or uses a HalResponseCache to cache HTTP responses.
HalResponse - Class in io.wcm.caravan.rhyme.api.common: A response to a successful or failed HTTP request to retrieve a HalResource
HalResponse() - Constructor for class io.wcm.caravan.rhyme.api.common.HalResponse: Creates an instance with all fields set to null, you have to use the #withXyz method to actually populate the fields
HalResponseCache - Interface in io.wcm.caravan.rhyme.api.spi: An SPI interface for a cache implementation that can be given to HalResourceLoaderBuilder.withCustomCache(HalResponseCache) if you want to store HAL+JSON responses in a custom cache (e.g. in an external, persistent data store).
HalResponseRendererBuilder - Interface in io.wcm.caravan.rhyme.api.server: A fluent builder for AsyncHalResponseRenderer instances which is only used in advanced integration scenarios.
HttpClientCallback - Interface in io.wcm.caravan.rhyme.api.spi: Callback interface used by HttpClientSupport.executeGetRequest(URI, HttpClientCallback) to process a response that has been retrieved, and handle any errors according to the contract of the HalResourceLoader.getHalResource(String) method
HttpClientSupport - Interface in io.wcm.caravan.rhyme.api.spi: A simpler callback-style SPI interface that you can implement instead of HalResourceLoader if you want to enable Rhyme or HalApiClient instances to fetch HTTP resources with a custom client library.

I

io.wcm.caravan.rhyme.api - package io.wcm.caravan.rhyme.api: Facade interfaces for the core framework
io.wcm.caravan.rhyme.api.client - package io.wcm.caravan.rhyme.api.client: Interfaces for client-side functionality
io.wcm.caravan.rhyme.api.common - package io.wcm.caravan.rhyme.api.common: Interfaces and data structures that are shared for client- and server-side
io.wcm.caravan.rhyme.api.exceptions - package io.wcm.caravan.rhyme.api.exceptions: Exception classes
io.wcm.caravan.rhyme.api.server - package io.wcm.caravan.rhyme.api.server: Interfaces for server-side resource rendering
io.wcm.caravan.rhyme.api.spi - package io.wcm.caravan.rhyme.api.spi: SPI interfaces for HTTP transfer, exception handling and extension the annotation support for HAL API interfaces
isCachingOfHalApiClientExceptionsEnabled() - Method in interface io.wcm.caravan.rhyme.api.client.CachingConfiguration: Determines whether the cache should also cover non-successful responses, where a HalApiClientException was caught.
isFragmentAppendedToCuriesLink() - Method in interface io.wcm.caravan.rhyme.api.spi.RhymeDocsSupport: Determines whether a fragment should be included in the documentation link (e.g.
isHalApiInterface(Class<?>) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport
isMetadataGenerationEnabled() - Method in interface io.wcm.caravan.rhyme.api.server.RhymeMetadataConfiguration: Determines whether an "rhyme:metadata" resource is automatically embedded into the response rendered with Rhyme.renderResponse(LinkableResource)
isProviderOfMultiplerValues(Class<?>) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiReturnTypeSupport
isProviderOfOptionalValue(Class<?>) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiReturnTypeSupport
isRelatedResourceMethod(Method) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport
isResourceLinkMethod(Method) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport
isResourcePropertyMethod(Method) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport
isResourceRepresentationMethod(Method) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport
isResourceStateMethod(Method) - Method in interface io.wcm.caravan.rhyme.api.spi.HalApiAnnotationSupport

L

load(String) - Method in interface io.wcm.caravan.rhyme.api.spi.HalResponseCache: Tries to retrieve a cached response for the given URI from the cache
loadGeneratedHtml(RhymeDocsSupport, String) - Static method in interface io.wcm.caravan.rhyme.api.spi.RhymeDocsSupport: Extract the HTML documentation that was generated with the rhyme-docs-maven-plugin from the classpath.
logAsCompactWarning(Throwable) - Method in interface io.wcm.caravan.rhyme.api.spi.ExceptionStatusAndLoggingStrategy

O

onBodyAvailable(InputStream) - Method in interface io.wcm.caravan.rhyme.api.spi.HttpClientCallback: This *must* be called after HttpClientCallback.onHeadersAvailable(int, Map) and as soon as the response body is ready to be read.
onExceptionCaught(Throwable) - Method in interface io.wcm.caravan.rhyme.api.spi.HttpClientCallback: This *must* be called when any exception was caught that prevented you from calling HttpClientCallback.onHeadersAvailable(int, Map) and HttpClientCallback.onBodyAvailable(InputStream).
onHeadersAvailable(int, Map<String, ? extends Collection<String>>) - Method in interface io.wcm.caravan.rhyme.api.spi.HttpClientCallback: This *must* be called as soon as the HTTP response headers are available.
onMethodInvocationFinished(Class, String, long) - Method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: Deprecated.
use RequestMetricsCollector.startStopwatch(Class, Supplier) instead
onResponseRetrieved(String, String, Integer, long) - Method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: Internal method called by the framework whenever an upstream resource has been retrieved
onUrlModified(URI) - Method in interface io.wcm.caravan.rhyme.api.spi.HttpClientCallback: This should be called if your client had to modify the URL (e.g. add or replace the host name) in order to execute the request.
openResourceStream(String) - Method in interface io.wcm.caravan.rhyme.api.spi.RhymeDocsSupport: Loads the HTML documentation file from the given path in the class path

R

renderError(String, LinkableResource, Throwable, RequestMetricsCollector) - Method in interface io.wcm.caravan.rhyme.api.server.VndErrorResponseRenderer
renderResponse(LinkableResource) - Method in interface io.wcm.caravan.rhyme.api.Rhyme: Asynchronously render the given resource as a HalResponse instance.
renderResponse(String, LinkableResource) - Method in interface io.wcm.caravan.rhyme.api.server.AsyncHalResponseRenderer: Asynchronously render the given resource as a HalResponse instance.
renderVndErrorResponse(Throwable) - Method in interface io.wcm.caravan.rhyme.api.Rhyme: Render a vnd.error response for an error that happened before the LinkableResource instance was created (using the status code obtained from the ExceptionStatusAndLoggingStrategy).
RequestMetricsCollector - Interface in io.wcm.caravan.rhyme.api.common: Keeps track of all upstream resource that have been fetched while handling the current request, and collects additional data for performance analyze and caching.
RequestMetricsStopwatch - Interface in io.wcm.caravan.rhyme.api.common: Represents an ongoing measurement of execution time that was started with Rhyme.startStopwatch(Class, Supplier) or RequestMetricsCollector.startStopwatch(Class, Supplier), and needs to be closed to finish the measurement.
ResourceConversions - Class in io.wcm.caravan.rhyme.api.server: Contains utility methods to perform conversions between resources that are semantically identical, but need some tweaks for the framework to properly handle them
Rhyme - Interface in io.wcm.caravan.rhyme.api: A facade interface that simplifies all interaction with the core framework to handle an incoming request for a HAL+JSON resource.
RhymeBuilder - Interface in io.wcm.caravan.rhyme.api: A fluent builder to configure and create a single Rhyme instance, which then should be used throughout the lifecycle of the current incoming request.
RhymeDocsSupport - Interface in io.wcm.caravan.rhyme.api.spi: SPI interface to customize the integration of HTML documentation generated with the rhyme-docs-maven-plugin.
RhymeMetadataConfiguration - Interface in io.wcm.caravan.rhyme.api.server: Defines configuration methods to influence if and how Rhyme.renderResponse(LinkableResource) adds additional metadata to the response

S

setResponseMaxAge(Duration) - Method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: Set the upper limit for the max-age header of the response to the current incoming request.
setResponseMaxAge(Duration) - Method in interface io.wcm.caravan.rhyme.api.Rhyme: Limit the maximum time for which the response should be cached by clients and downstream services.
startStopwatch(Class, Supplier<String>) - Method in interface io.wcm.caravan.rhyme.api.common.RequestMetricsCollector: Start measuring the execution time of a specific (possibly repeated) task within your own code.
startStopwatch(Class, Supplier<String>) - Method in interface io.wcm.caravan.rhyme.api.Rhyme: Start measuring the execution time of a specific (possibly repeated) task within your own code.
store(HalResponse) - Method in interface io.wcm.caravan.rhyme.api.spi.HalResponseCache: Store a HAL response in the cache.

V

VndErrorResponseRenderer - Interface in io.wcm.caravan.rhyme.api.server: Creates an error response according to the "application/vnd.error+json" media type for any exception thrown and caught during request processing.

W

withAnnotationTypeSupport(HalApiAnnotationSupport) - Method in interface io.wcm.caravan.rhyme.api.client.HalApiClientBuilder: Extend the core framework to support additional annotation types in your annotated HAL API interfaces.
withAnnotationTypeSupport(HalApiAnnotationSupport) - Method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Extend the core framework to support additional annotation types in your annotated HAL API interfaces.
withAnnotationTypeSupport(HalApiAnnotationSupport) - Method in interface io.wcm.caravan.rhyme.api.server.HalResponseRendererBuilder: Extend the core framework to support additional annotation types in your annotated HAL API interfaces.
withBody(JsonNode) - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
withBody(HalResource) - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
withCachingConfiguration(CachingConfiguration) - Method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder: Replace the default caching configuration that determines which responses are being cached and for how long responses without a cache-control/max-age header will be used.
withClock(Clock) - Method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder: Replace the clock that the caching logic uses to determine the age of cached responses.
withContentType(String) - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
withCustomCache(HalResponseCache) - Method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder: Enable caching of responses using a custom caching implementation.
withCustomHttpClient(HttpClientSupport) - Method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder: Replace the default HTTP client with the given implementation.
withExceptionStrategy(ExceptionStatusAndLoggingStrategy) - Method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Allow the exception handling of the core framework to support additional platform / framework specific exceptions.
withExceptionStrategy(ExceptionStatusAndLoggingStrategy) - Method in interface io.wcm.caravan.rhyme.api.server.HalResponseRendererBuilder: Allow the exception handling of the core framework to support additional platform / framework specific exceptions.
withExistingLoader(HalResourceLoader) - Method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder: Use a custom HalResourceLoader implementation instead of the default HTTP client.
withMaxAge(Integer) - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
withMemoryCache() - Method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder: Enable in-memory caching of responses with default settings.
withMemoryCache(int, Duration) - Method in interface io.wcm.caravan.rhyme.api.client.HalResourceLoaderBuilder: Enable in-memory caching of responses with custom settings
withMetadataConfiguration(RhymeMetadataConfiguration) - Method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Configures the capturing of extensive performance and upstream response metadata for this request, which can be included as an embedded resource in the response.
withMetrics(RequestMetricsCollector) - Method in interface io.wcm.caravan.rhyme.api.client.HalApiClientBuilder: A RequestMetricsCollector instance can be used to track all upstream resources that have been retrieved, and collect metrics and response metadata from the interaction with the proxy objects.
withMetrics(RequestMetricsCollector) - Method in interface io.wcm.caravan.rhyme.api.server.HalResponseRendererBuilder: Provide the RequestMetricsCollector instance that was used to capture and measure all interaction with the HalApiClient for the current incoming request.
withObjectMapper(ObjectMapper) - Method in interface io.wcm.caravan.rhyme.api.client.HalApiClientBuilder: Replace the default Jackson ObjectMapper used for JSON deserialization with a customized instance.
withObjectMapper(ObjectMapper) - Method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Replace the default Jackson ObjectMapper used for JSON (de)serialization with a customized instance.
withObjectMapper(ObjectMapper) - Method in interface io.wcm.caravan.rhyme.api.server.HalResponseRendererBuilder: Replace the default Jackson ObjectMapper used for JSON serialization with a customized instance
withoutResourceLoader() - Static method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Deprecated.
no longer required because there is now a default HalResourceLoader implementation available, use RhymeBuilder.create() instead
withRemoteResourceOverride(String, Class<T>, Function<RequestMetricsCollector, T>) - Method in interface io.wcm.caravan.rhyme.api.client.HalApiClientBuilder: Defines an override that will make HalApiClient.getRemoteResource(String, Class) return a custom implementation for a specific combination of entry point URI and interface class (rather than the default dynamic proxy).
withRemoteResourceOverride(String, Class<T>, Function<RequestMetricsCollector, T>) - Method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Defines an override that will make Rhyme.getRemoteResource(String, Class) return a custom implementation for a specific combination of entry point URI and interface class (rather then the default dynamic proxy).
withResourceLoader(HalResourceLoader) - Method in interface io.wcm.caravan.rhyme.api.client.HalApiClientBuilder
withResourceLoader(HalResourceLoader) - Static method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Create a RhymeBuilder to build Rhyme instances that use the given HalResourceLoader
withReturnTypeSupport(HalApiReturnTypeSupport) - Method in interface io.wcm.caravan.rhyme.api.client.HalApiClientBuilder: Extend the core framework to support additional return types in your annotated HAL API interfaces.
withReturnTypeSupport(HalApiReturnTypeSupport) - Method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Extend the core framework to support additional return types in your annotated HAL API interfaces.
withReturnTypeSupport(HalApiReturnTypeSupport) - Method in interface io.wcm.caravan.rhyme.api.server.HalResponseRendererBuilder: Extend the core framework to support additional return types in your annotated HAL API interfaces.
withRhymeDocsSupport(RhymeDocsSupport) - Method in interface io.wcm.caravan.rhyme.api.RhymeBuilder: Enable generation of "curies" links (to HTML documentation generated with the rhyme-docs-maven-plugin) when rendering HalResponses with Rhyme.renderResponse(LinkableResource).
withRhymeDocsSupport(RhymeDocsSupport) - Method in interface io.wcm.caravan.rhyme.api.server.HalResponseRendererBuilder: Enable generation of "curies" links (to HTML documentation generated with the rhyme-docs-maven-plugin) when rendering HalResponses with Rhyme.renderResponse(LinkableResource).
withStatus(Integer) - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
withTimestamp(Instant) - Method in class io.wcm.caravan.rhyme.api.common.HalResponse
withUri(String) - Method in class io.wcm.caravan.rhyme.api.common.HalResponse

A B C E F G H I L O R S V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form