Index

A C F G I L N P Q R S W 
All Classes and Interfaces|All Packages

A

AbstractLinkableResource - Class in io.wcm.caravan.rhyme.aem.api.resources
An abstract implementation of LinkableResource, that you can use as a super class for your sling models implementing your HalApiInterfaces.
AbstractLinkableResource() - Constructor for class io.wcm.caravan.rhyme.aem.api.resources.AbstractLinkableResource
 
adaptResource(Resource, Class<T>) - Method in interface io.wcm.caravan.rhyme.aem.api.SlingRhyme
Creates a new sling model instance for the given resource.
adaptTo(Class<I>) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
adaptTo(Class<I>, Class<M>) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 

C

configureRhymeBuilder(RhymeBuilder, SlingHttpServletRequest) - Method in interface io.wcm.caravan.rhyme.aem.api.SlingRhymeCustomization
An extension point that allows to configure the RhymeBuilder that is used when creating SlingRhyme instance
createLink() - Method in class io.wcm.caravan.rhyme.aem.api.resources.AbstractLinkableResource
 
createLinkToCurrentResource(SlingLinkableResource) - Method in interface io.wcm.caravan.rhyme.aem.api.linkbuilder.SlingLinkBuilder
 

F

filter(Predicate<Resource>) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
filterAdaptableTo(Class<?>) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
filterAdaptableTo(Class<T>, Predicate<T>) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
filterWithName(String) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
fromCurrentPage() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
fromGrandParentPage() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
fromParentPage() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
fromResourceAt(String) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 

G

getApiEntryPoint(SlingResourceAdapter) - Method in interface io.wcm.caravan.rhyme.aem.api.RhymeResourceRegistration
Returns an instance of the resource that should be linked from the global API discovery entry point of the Rhyme AEM integration.
getCoreRhyme() - Method in interface io.wcm.caravan.rhyme.aem.api.SlingRhyme
Provides access to the underlying Rhyme instance of the core framework, just in case you need to call one of the methods for which there doesn't exist a delegate in the SlingRhyme interface
getCurrentResource() - Method in interface io.wcm.caravan.rhyme.aem.api.SlingRhyme
 
getDefaultLinkTitle() - Method in class io.wcm.caravan.rhyme.aem.api.resources.AbstractLinkableResource
 
getInstance() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.PostAdaptationStage
 
getLinkProperties() - Method in class io.wcm.caravan.rhyme.aem.api.resources.AbstractLinkableResource
 
getLinkProperties() - Method in interface io.wcm.caravan.rhyme.aem.api.resources.SlingLinkableResource
 
getModelClassesWithSelectors() - Method in interface io.wcm.caravan.rhyme.aem.api.RhymeResourceRegistration
Lists all linkable resource implementation classes (e.g. sling models) defined in your bundle, and defines the Sling selectors to be used in the links to these resources
getName() - Method in class io.wcm.caravan.rhyme.aem.api.linkbuilder.LinkProperties
 
getOptional() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.PostAdaptationStage
 
getRemoteResource(String, Class<T>) - Method in interface io.wcm.caravan.rhyme.aem.api.SlingRhyme
Create a dynamic client proxy to load HAL+JSON resources from an upstream service.
getRequestedResource() - Method in interface io.wcm.caravan.rhyme.aem.api.SlingRhyme
 
getStream() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.PostAdaptationStage
 
getTitle() - Method in class io.wcm.caravan.rhyme.aem.api.linkbuilder.LinkProperties
 

I

io.wcm.caravan.rhyme.aem.api - package io.wcm.caravan.rhyme.aem.api
Core interfaces and annotations for integration of the Rhyme framework in AEM
io.wcm.caravan.rhyme.aem.api.adaptation - package io.wcm.caravan.rhyme.aem.api.adaptation
 
io.wcm.caravan.rhyme.aem.api.linkbuilder - package io.wcm.caravan.rhyme.aem.api.linkbuilder
 
io.wcm.caravan.rhyme.aem.api.parameters - package io.wcm.caravan.rhyme.aem.api.parameters
 
io.wcm.caravan.rhyme.aem.api.resources - package io.wcm.caravan.rhyme.aem.api.resources
 
isTemplated() - Method in class io.wcm.caravan.rhyme.aem.api.linkbuilder.LinkProperties
 

L

linkBuilder - Variable in class io.wcm.caravan.rhyme.aem.api.resources.AbstractLinkableResource
 
LinkProperties - Class in io.wcm.caravan.rhyme.aem.api.linkbuilder
 
LinkProperties() - Constructor for class io.wcm.caravan.rhyme.aem.api.linkbuilder.LinkProperties
 

N

name() - Element in annotation interface io.wcm.caravan.rhyme.aem.api.parameters.QueryParam
Specifies the name of the query parameter.

P

PostAdaptationStage<I,M extends I> - Interface in io.wcm.caravan.rhyme.aem.api.adaptation
 

Q

QueryParam - Annotation Interface in io.wcm.caravan.rhyme.aem.api.parameters
 

R

resourceAdapter - Variable in class io.wcm.caravan.rhyme.aem.api.resources.AbstractLinkableResource
 
rhyme - Variable in class io.wcm.caravan.rhyme.aem.api.resources.AbstractLinkableResource
 
RhymeResourceRegistration - Interface in io.wcm.caravan.rhyme.aem.api
An SPI interface that needs to be implemented as an OSGi Component in your service bundle.

S

select(Stream<Resource>) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectChildPages() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectChildResource(String) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectChildResources() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectContainingPage() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectContentOfChildPage(String) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectContentOfChildPages() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectContentOfCurrentPage() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectContentOfGrandChildPages() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectContentResource() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectCurrentResource() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectGrandChildPages() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectGrandChildResources() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectParentResource() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectResourceAt(String) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
selectSiblingResource(String) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.SlingResourceAdapter
 
setName(String) - Method in class io.wcm.caravan.rhyme.aem.api.linkbuilder.LinkProperties
 
setResponseMaxAge(Duration) - Method in interface io.wcm.caravan.rhyme.aem.api.SlingRhyme
Limit the maximum time for which the response should be cached by clients and downstream services.
setTemplated(boolean) - Method in class io.wcm.caravan.rhyme.aem.api.linkbuilder.LinkProperties
 
setTitle(String) - Method in class io.wcm.caravan.rhyme.aem.api.linkbuilder.LinkProperties
 
SlingLinkableResource - Interface in io.wcm.caravan.rhyme.aem.api.resources
 
SlingLinkBuilder - Interface in io.wcm.caravan.rhyme.aem.api.linkbuilder
 
SlingResourceAdapter - Interface in io.wcm.caravan.rhyme.aem.api.adaptation
A sling model (directly adaptable from SlingRhyme) that provides a convenient way to navigate to related resources and adapt them to your sling models implementing your HalApiInterfaces.
SlingRhyme - Interface in io.wcm.caravan.rhyme.aem.api
An AEM-specific wrapper for the general Rhyme facade interface.
SlingRhymeCustomization - Interface in io.wcm.caravan.rhyme.aem.api
An SPI interface to be implemented as an OSGi component if your application needs to apply further customizations to RhymeBuilder instance created by the HalApiServlet.

W

withLinkName(String) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.PostAdaptationStage
 
withLinkTitle(String) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.PostAdaptationStage
 
withModifications(Consumer<M>) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.PostAdaptationStage
 
withPartialLinkTemplate() - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.PostAdaptationStage
 
withQueryParameterTemplate(String...) - Method in interface io.wcm.caravan.rhyme.aem.api.adaptation.PostAdaptationStage
 
A C F G I L N P Q R S W 
All Classes and Interfaces|All Packages