Index (JSON Pipeline API 0.7.1-SNAPSHOT API)

A C E F G H I J M N P R S T W Z
All Classes All Packages

A

addCachePoint(CacheStrategy) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Makes the result of the current pipeline cacheable.
applyAction(JsonPipelineAction) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Applies an action on this pipeline, specifying an algorithm by the implementation of JsonPipelineAction.
applyFunction(String, Func1<JsonPipelineOutput, JsonPipelineOutput>) - Static method in class io.wcm.caravan.pipeline.JsonPipelineActions: Applies a custom function on the JsonPipelineOutput of this pipeline.
assertExists(String, int, String) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Raises an exception in case, if expected content is not present in the actual JSON node of this pipeline.

C

CacheAdapter - Interface in io.wcm.caravan.pipeline.cache.spi: Provides cache support for pipelines.
CacheControlUtils - Class in io.wcm.caravan.pipeline.cache: Cache control utilities aid to manage pipeline output cache control meta data.
CacheDateUtils - Class in io.wcm.caravan.pipeline.cache: some formatting/parsing functions for the date-format to be used in HTTP headers (see http://tools.ietf.org/html/rfc2616#section-3.3.1)
CachePersistencyOptions - Class in io.wcm.caravan.pipeline.cache: Cache persistency options configure entry store requirements while read or write operations in CacheAdapter.
CachePersistencyOptions(int, int, boolean) - Constructor for class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Default constructor for complete initialization of cache persistency and transient options.
CachePersistencyOptions(int, int, boolean, boolean) - Constructor for class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Default constructor for complete initialization of cache persistency and transient options.
CacheStrategies - Class in io.wcm.caravan.pipeline.cache: Default implementations of different cache strategies.
CacheStrategy - Interface in io.wcm.caravan.pipeline.cache: A cache-strategy implements the core decisions about storage time and lifetime of responses that are temporarily or permanently cached by inserting cache points into a JsonPipeline (via JsonPipeline.addCachePoint(CacheStrategy)).
call(JsonPipelineOutput, RuntimeException) - Method in interface io.wcm.caravan.pipeline.JsonPipelineExceptionHandler: The method that defines the exception handling behavior.
collect(String) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Extracts multiple properties (or individual entries from a property array!) from the pipeline's response by specifying a JSONPath expression.
collect(String, String) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Extracts multiple properties (or individual entries from a property array!) from the pipeline's response by specifying a JSONPath expression.
create(CaravanHttpRequest) - Method in interface io.wcm.caravan.pipeline.JsonPipelineFactory: Creates a new JsonPipeline to process the response from a CaravanHttpClient request for the given service
create(CaravanHttpRequest, Map<String, String>) - Method in interface io.wcm.caravan.pipeline.JsonPipelineFactory: Creates a new JsonPipeline to process the response from a CaravanHttpClient request for the given service and predefined cache meta data.
createEmpty() - Method in interface io.wcm.caravan.pipeline.JsonPipelineFactory: Creates an empty pipeline.
createEmpty(Map<String, String>) - Method in interface io.wcm.caravan.pipeline.JsonPipelineFactory: Creates an empty pipeline with predefined cache meta data.
createPersistentAndTimeToIdle(int, int) - Static method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Creates caching options specifying cache refresh interval and storing time per entry with next extension of storing time.
createPersistentAndTimeToLive(int, int) - Static method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Creates caching options specifying cache refresh interval and storing time per entry without next extension of storing time.
createTransient(int) - Static method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Creates caching options specifying cache refresh interval.

E

execute(JsonPipelineOutput, JsonPipelineContext) - Method in interface io.wcm.caravan.pipeline.JsonPipelineAction: Provides a subscription to the JSON pipeline output with the the results of this action.
extract(String) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Extracts a single (first) property from the pipeline's response by specifying a JSONPath expression.
extract(String, String) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Extracts a single (first) property from the pipeline's response by specifying a JSONPath expression.

F

fallbackFor404(JsonNode, int) - Static method in class io.wcm.caravan.pipeline.JsonPipelineExceptionHandlers: Creates an exception handling function that will provide static fallback content if the exception being caught has a status code of 404 (and otherwise rethrow the original exception )
fallbackFor50x(JsonNode, int) - Static method in class io.wcm.caravan.pipeline.JsonPipelineExceptionHandlers: Creates an exception handling function that will provide static fallback content if the exception being caught has a status code > 500 (and otherwise rethrow the original exception )
formatCurrentTime() - Static method in class io.wcm.caravan.pipeline.cache.CacheDateUtils
formatRelativeTime(int) - Static method in class io.wcm.caravan.pipeline.cache.CacheDateUtils

G

get(String, CachePersistencyOptions) - Method in interface io.wcm.caravan.pipeline.cache.spi.CacheAdapter: Retrieve an item from cache.
getCacheAdapter() - Method in interface io.wcm.caravan.pipeline.JsonPipelineContext
getCachePersistencyOptions(Collection<CaravanHttpRequest>) - Method in interface io.wcm.caravan.pipeline.cache.CacheStrategy
getCorrelationId() - Method in interface io.wcm.caravan.pipeline.JsonPipelineOutput
getDescriptor() - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Provides a string representation of all the actions executed by this pipeline.
getFactory() - Method in interface io.wcm.caravan.pipeline.JsonPipelineContext
getId() - Method in interface io.wcm.caravan.pipeline.JsonPipelineAction: Provides an unique identifier of this actions, which must be guaranteed by the implementation to be constant during the whole lifetime of the action instance.
getJsonOutput() - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Subscribes asynchronous client to the JSON payload of the pipeline.
getLowestMaxAge(JsonPipelineOutput...) - Static method in class io.wcm.caravan.pipeline.cache.CacheControlUtils
getLowestMaxAge(Iterable<JsonPipelineOutput>) - Static method in class io.wcm.caravan.pipeline.cache.CacheControlUtils
getMaxAge() - Method in interface io.wcm.caravan.pipeline.JsonPipelineOutput
getOutput() - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Subscribes asynchronous client to the full pipeline output that consists of a JsonNode payload and some additional metadata.
getPayload() - Method in interface io.wcm.caravan.pipeline.JsonPipelineOutput
getPerformanceMetrics() - Method in interface io.wcm.caravan.pipeline.JsonPipeline
getProperties() - Method in interface io.wcm.caravan.pipeline.JsonPipelineContext
getReason() - Method in exception io.wcm.caravan.pipeline.JsonPipelineInputException
getRefreshInterval() - Method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Defines the time (in seconds) after which a cached response for the given request should be considered stale.
getRequests() - Method in interface io.wcm.caravan.pipeline.JsonPipeline
getRequests() - Method in interface io.wcm.caravan.pipeline.JsonPipelineOutput
getSecondsSince(String) - Static method in class io.wcm.caravan.pipeline.cache.CacheDateUtils
getSecondsUntil(String) - Static method in class io.wcm.caravan.pipeline.cache.CacheDateUtils
getSourceServices() - Method in interface io.wcm.caravan.pipeline.JsonPipeline
getStatusCode() - Method in exception io.wcm.caravan.pipeline.JsonPipelineInputException: Provides the appropriate status code for this exception.
getStatusCode() - Method in interface io.wcm.caravan.pipeline.JsonPipelineOutput
getStorageTime() - Method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Defines the time (in seconds) for which the response to the given request should be at least stored in the cache.
getStringOutput() - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Subscribes asynchronous client to the serialized payload of the pipeline.

H

handleException(JsonPipelineExceptionHandler) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Catches all exceptions from any of the previous pipeline steps, and passes them to the given exception handler function, together with a fallback content object that is initialized with the appropriate status code for the given exception, and the max-age value set to 0.

I

io.wcm.caravan.pipeline - package io.wcm.caravan.pipeline: JSON Pipeline API
io.wcm.caravan.pipeline.cache - package io.wcm.caravan.pipeline.cache: JSON Pipeline API for Cache Handling.
io.wcm.caravan.pipeline.cache.spi - package io.wcm.caravan.pipeline.cache.spi: JSON Pipeline SPI for Cache Adapter implementations.
isCacheable() - Method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Checks if the entry should be cached.
isExtendStorageTimeOnGet() - Method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Determines whether to automatically extend the storage time (to the duration returned by CachePersistencyOptions.getStorageTime() whenever a response was successfully retrieved from cache, resulting in a "time-to-idle" cache behavior, where the total storage time is unlimited, but instead data is kept in the cache as long as it is still being requested.
isPersistent() - Method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Deprecated.
Use CachePersistencyOptions.shouldUsePersistentCaches() instead of deprecated CachePersistencyOptions.isPersistent().

J

JsonPipeline - Interface in io.wcm.caravan.pipeline: A pipeline aids consuming/orchestrating services to transform, merge and cache JSON responses from a CaravanHttpClient and allows to select only specific parts of the JSON tree with a JsonPath expression (using JsonPipeline.collect(String, String)) merge all content of another pipeline into a new property of its own result document (using JsonPipeline.merge(JsonPipeline, String)) cache the original result, or the result of any transformation/aggregation step (using JsonPipeline.addCachePoint(CacheStrategy) access the overall output either as a Jackson JsonNode, a JSON string, or as a type-mapped Java object Note that JsonPipeline's are immutable.
JsonPipelineAction - Interface in io.wcm.caravan.pipeline: A JSON pipeline action aids in specifying of custom operations, which could be applied on JsonPipelineOutput.
JsonPipelineActions - Class in io.wcm.caravan.pipeline: Default implementations of JsonPipelineAction
JsonPipelineContext - Interface in io.wcm.caravan.pipeline: The context from which a given pipeline instance was created.
JsonPipelineExceptionHandler - Interface in io.wcm.caravan.pipeline: A functional interface that allow users of the JsonPipeline to specify custom exception handling for 404 responses and other server-side or network exceptions via JsonPipeline.handleException(JsonPipelineExceptionHandler).
JsonPipelineExceptionHandlers - Class in io.wcm.caravan.pipeline: Contains some common exception handling strategies to be used with JsonPipeline.handleException(JsonPipelineExceptionHandler)
JsonPipelineFactory - Interface in io.wcm.caravan.pipeline: JSON Pipeline factory service interface.
JsonPipelineInputException - Exception in io.wcm.caravan.pipeline: Used to indicate that the JSON input data of a JsonPipeline could not be retrieved, was invalid JSON, or didn't match the expected data structure.
JsonPipelineInputException(int, String) - Constructor for exception io.wcm.caravan.pipeline.JsonPipelineInputException
JsonPipelineInputException(int, String, Throwable) - Constructor for exception io.wcm.caravan.pipeline.JsonPipelineInputException
JsonPipelineOutput - Interface in io.wcm.caravan.pipeline: The immutable output of a JsonPipeline's processing step: the main JSON content payload, and additional metadata about the status and cachability of the content.
JsonPipelineOutputException - Exception in io.wcm.caravan.pipeline: Used to indicate a problem while creating the output of a JsonPipeline (most likely due to an impossible type-mapping).
JsonPipelineOutputException(String) - Constructor for exception io.wcm.caravan.pipeline.JsonPipelineOutputException
JsonPipelineOutputException(String, Throwable) - Constructor for exception io.wcm.caravan.pipeline.JsonPipelineOutputException

M

merge(JsonPipeline) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Merges/Zips the JSON response objects of this pipeline and another pipeline, specifying by secondarySource parameter.
merge(JsonPipeline, String) - Method in interface io.wcm.caravan.pipeline.JsonPipeline: Merges/Zips the JSON response objects of this pipeline and another pipeline, specifying by secondarySource parameter.

N

noCache() - Static method in class io.wcm.caravan.pipeline.cache.CacheStrategies: No caching.
nonTransientAndTimeToIdle(int, TimeUnit) - Static method in class io.wcm.caravan.pipeline.cache.CacheStrategies: Invalidate item after a time-to-idle interval: The content is considered immutable, and storage time will be extended to specified value on each get operation on this item, so it is kept in cache as long as it is requested.

P

parse(String) - Static method in class io.wcm.caravan.pipeline.cache.CacheDateUtils
put(String, String, CachePersistencyOptions) - Method in interface io.wcm.caravan.pipeline.cache.spi.CacheAdapter: Store an item in the cache.

R

rethrow404(RuntimeException) - Static method in class io.wcm.caravan.pipeline.JsonPipelineExceptionHandlers: Creates an exception handling function that will throw the given exception if the exception being caught has a status code of 404 (and otherwise rethrow the original exception )
rethrow404(String) - Static method in class io.wcm.caravan.pipeline.JsonPipelineExceptionHandlers: Creates an exception handling function that will throw a new JsonPipelineInputException with the given message if the exception being caught has a status code of 404
rethrow50x(RuntimeException) - Static method in class io.wcm.caravan.pipeline.JsonPipelineExceptionHandlers: Creates an exception handling function that will throw the given exception if the exception being caught has a status code >= 500 (and otherwise rethrow the original exception )
rethrow50x(String) - Static method in class io.wcm.caravan.pipeline.JsonPipelineExceptionHandlers: Creates an exception handling function that will throw throw a new JsonPipelineInputException with the given message if the exception being caught has a status code in the 50x range

S

setReason(String) - Method in exception io.wcm.caravan.pipeline.JsonPipelineInputException
shouldUsePersistentCaches() - Method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Check if the entry should be cached by persistent cache implementation.
shouldUseTransientCaches() - Method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions: Check if the entry should be cached by transient cache implementation.
simpleTransformation(String, Func1<JsonNode, JsonNode>) - Static method in class io.wcm.caravan.pipeline.JsonPipelineActions: Applies a custom transformation on the JsonNode (e.g.

T

temporary(int, TimeUnit) - Static method in class io.wcm.caravan.pipeline.cache.CacheStrategies: Stores items only in the local, non-persistent CacheAdapter for the given maximum duration.
timeToIdle(int, TimeUnit) - Static method in class io.wcm.caravan.pipeline.cache.CacheStrategies: Invalidate item after a time-to-idle interval: The content is considered immutable, and storage time will be extended to specified value on each get operation on this item, so it is kept in cache as long as it is requested
timeToLive(int, TimeUnit) - Static method in class io.wcm.caravan.pipeline.cache.CacheStrategies: Invalidate item after a fixed time-to-live interval, using the same duration as storage time and revalidation-interval
toString() - Method in class io.wcm.caravan.pipeline.cache.CachePersistencyOptions

W

withMaxAge(int) - Method in interface io.wcm.caravan.pipeline.JsonPipelineOutput
withPayload(JsonNode) - Method in interface io.wcm.caravan.pipeline.JsonPipelineOutput
withStatusCode(int) - Method in interface io.wcm.caravan.pipeline.JsonPipelineOutput

Z

zipWithLowestMaxAge(Iterable<JsonPipeline>, Func1<List<JsonPipelineOutput>, JsonPipelineOutput>) - Static method in class io.wcm.caravan.pipeline.cache.CacheControlUtils: Aggregates multiple resources fetched with different JsonPipeline instances, into a single JsonPipelineOutput and ensures sure that the max-age Cache-Control-Header is set to the minimum value of all aggregated responses.
zipWithLowestMaxAge(Observable<JsonPipeline>, Func1<List<JsonPipelineOutput>, JsonPipelineOutput>) - Static method in class io.wcm.caravan.pipeline.cache.CacheControlUtils: Aggregates multiple resources fetched with different JsonPipeline instances, into a single JsonPipelineOutput and ensures sure that the max-age Cache-Control-Header is set to the minimum value of all aggregated responses.

A C E F G H I J M N P R S T W Z
All Classes All Packages