A B C E G H I J K L M N O P Q R S T U V
All Classes All Packages

A

AdaptTo - Class in io.wcm.sling.commons.adapter

Utility methods around Sling Adaptable.

apply(String, ResourceResolver) - Method in interface io.wcm.sling.commons.caservice.PathPreprocessor

Preprocess a path.

APPS_PREFIX - Static variable in class io.wcm.sling.commons.resource.ResourceType

Deprecated.

Search paths are confurable and should not be hard-coded.

B

bind(T, Map<String, Object>) - Method in class io.wcm.sling.commons.osgi.RankedServices

Deprecated.

Handle bind service event.

build() - Method in class io.wcm.sling.commons.request.QueryStringBuilder

Build query string.

build() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap.Builder

Returns a newly-created immutable map.

builder() - Static method in class io.wcm.sling.commons.resource.ImmutableValueMap

Returns a new builder.

Builder() - Constructor for class io.wcm.sling.commons.resource.ImmutableValueMap.Builder

C

changed() - Method in interface io.wcm.sling.commons.osgi.RankedServices.ChangeListener

Deprecated.

Is called when the list of ranked services was changed due to bundle bindings/unbindings.

clear() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

Deprecated.

Unsupported operation

close() - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceCollectionResolver

It is recommended to close the collection resolver instance when the using OSGi component is deactivated.

compare(Resource, Resource) - Method in class io.wcm.sling.commons.resource.NameResourceComparator

containsKey(Object) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

containsValue(Object) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

ContextAwareService - Interface in io.wcm.sling.commons.caservice

Marker interface for Context-Aware services.

ContextAwareServiceCollectionResolver<S extends ContextAwareService,D> - Interface in io.wcm.sling.commons.caservice

Resolves the best-matching context-aware service implementation.

ContextAwareServiceResolver - Interface in io.wcm.sling.commons.caservice

Resolves the best-matching context-aware service implementation.

ContextAwareServiceResolver.ResolveAllResult<S extends ContextAwareService> - Interface in io.wcm.sling.commons.caservice

Result of the ContextAwareServiceResolver.resolveAll(Class, Adaptable) method.

copyOf(Map<String, Object>) - Static method in class io.wcm.sling.commons.resource.ImmutableValueMap

Returns an immutable map containing the same entries as map.

E

entrySet() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

equals(String, String) - Static method in class io.wcm.sling.commons.resource.ResourceType

Deprecated.

Please use ResourceType.equals(String, String, ResourceResolver) instead.

equals(String, String, ResourceResolver) - Static method in class io.wcm.sling.commons.resource.ResourceType

Returns true if the given resource type are equal.

equals(Object) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

Escape - Class in io.wcm.sling.commons.util

Encoding utility functions.

G

get() - Method in class io.wcm.sling.commons.osgi.RankedServices

Deprecated.

Lists all services registered in OSGi, sorted by service ranking.

get(String, Class<T>) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

get(String, T) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

get(Map<String, String[]>, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter.
In addition the method fixes problems with incorrect UTF-8 characters returned by the servlet engine.

get(ServletRequest, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter.
In addition the method fixes problems with incorrect UTF-8 characters returned by the servlet engine.

get(ServletRequest, String, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter.
In addition the method fixes problems with incorrect UTF-8 characters returned by the servlet engine.

get(Object) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

getAbsoluteLevel(String) - Static method in class io.wcm.sling.commons.resource.ResourcePath

Deprecated.

Gets level from parent use same logic (but reverse) as Text.getAbsoluteParent(String, int).

getAdaptable() - Method in exception io.wcm.sling.commons.adapter.UnableToAdaptException

getBoolean(ServletRequest, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as boolean.

getBoolean(ServletRequest, String, boolean) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as boolean.

getCollectionResolver(Collection<ServiceReference<S>>) - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceResolver

Gets a ContextAwareServiceCollectionResolver which operates on a given collection of service references of the required service.

getCollectionResolver(Collection<ServiceReference<S>>, BiFunction<ServiceReference<S>, S, D>) - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceResolver

Gets a ContextAwareServiceCollectionResolver which operates on a given collection of service references of the required service.

getCombinedKey() - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceResolver.ResolveAllResult

Gets a combined key that represents the path filter sets of all affected context-aware services that matched for the given resource and a timestamp of the service registration for this service interface changed last.

getDouble(ServletRequest, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as double.

getDouble(ServletRequest, String, double) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as double.

getEnum(ServletRequest, String, Class<T>) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as enum value.

getEnum(ServletRequest, String, Class<T>, T) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as enum value.

getFloat(ServletRequest, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as float.

getFloat(ServletRequest, String, float) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as float.

getInt(ServletRequest, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as integer.

getInt(ServletRequest, String, int) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as integer.

getLong(ServletRequest, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as long.

getLong(ServletRequest, String, long) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter as long.

getMultiple(ServletRequest, String) - Static method in class io.wcm.sling.commons.request.RequestParam

Returns a request parameter array.
The method fixes problems with incorrect UTF-8 characters returned by the servlet engine.

getServices() - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceResolver.ResolveAllResult

Gets all matching services

getThreadRequest() - Method in interface io.wcm.sling.commons.request.RequestContext

Returns sling request associated with the current thread.

getType() - Method in exception io.wcm.sling.commons.adapter.UnableToAdaptException

H

hasAnySelector(SlingHttpServletRequest, String...) - Static method in class io.wcm.sling.commons.request.RequestPath

Checks if one of the given selectors is present in the current URL request (at any position).

hashCode() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

hasSelector(SlingHttpServletRequest, String) - Static method in class io.wcm.sling.commons.request.RequestPath

Checks if the given selector is present in the current URL request (at any position).

I

ImmutableValueMap - Class in io.wcm.sling.commons.resource

ValueMap that does not support changing its content.

ImmutableValueMap.Builder - Class in io.wcm.sling.commons.resource

Builder interface for ImmutableValueMap.

io.wcm.sling.commons.adapter - package io.wcm.sling.commons.adapter

Helper classes around the Sling Adaptable concept.

io.wcm.sling.commons.caservice - package io.wcm.sling.commons.caservice

Context-Aware services.

io.wcm.sling.commons.osgi - package io.wcm.sling.commons.osgi

Helper classes for OSGi and SCR.

io.wcm.sling.commons.request - package io.wcm.sling.commons.request

Helper classes for request handling.

io.wcm.sling.commons.resource - package io.wcm.sling.commons.resource

Helper classes around the Sling Resource concept.

io.wcm.sling.commons.util - package io.wcm.sling.commons.util

Miscellaneous helper classes.

is(Resource, String) - Static method in class io.wcm.sling.commons.resource.ResourceType

Returns true if the resource type or any of the resource's super type(s) equals the given resource type.

isEmpty() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

iterator() - Method in class io.wcm.sling.commons.osgi.RankedServices

Deprecated.

Iterates all services registered in OSGi, sorted by service ranking.

J

jcrQueryContainsExpr(String) - Static method in class io.wcm.sling.commons.util.Escape

Convert a string to a JCR search expression literal, suitable for use in jcr:contains() (inside XPath) or contains (JCR-SQL2).

jcrQueryLikeString(String) - Static method in class io.wcm.sling.commons.util.Escape

Convert a string to a JCR search expression literal, suitable for use in jcr:like() (inside XPath) or contains (JCR-SQL2).

jcrQueryLiteral(String) - Static method in class io.wcm.sling.commons.util.Escape

Convert a string to a literal, suitable for inclusion in a query (XPath or JCR-SQL2).

K

keySet() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

L

LIBS_PREFIX - Static variable in class io.wcm.sling.commons.resource.ResourceType

Deprecated.

Search paths are confurable and should not be hard-coded.

M

makeAbsolute(String, ResourceResolver) - Static method in class io.wcm.sling.commons.resource.ResourceType

Converts the resource type to an absolute path.

makeRelative(String) - Static method in class io.wcm.sling.commons.resource.ResourceType

Deprecated.

Please use ResourceType.makeRelative(String, ResourceResolver) instead.

makeRelative(String, ResourceResolver) - Static method in class io.wcm.sling.commons.resource.ResourceType

Makes the given resource type relative by stripping off any search path prefix.

N

NameResourceComparator - Class in io.wcm.sling.commons.resource

Orders resources alphabetically by name (ascending).

NameResourceComparator() - Constructor for class io.wcm.sling.commons.resource.NameResourceComparator

notNull(Adaptable, Class<T>) - Static method in class io.wcm.sling.commons.adapter.AdaptTo

Try to adapt the adaptable to the given type and ensures that it succeeds.

O

of() - Static method in class io.wcm.sling.commons.resource.ImmutableValueMap

Returns the empty map.

of(String, Object) - Static method in class io.wcm.sling.commons.resource.ImmutableValueMap

Returns an immutable map containing a single entry.

of(String, Object, String, Object) - Static method in class io.wcm.sling.commons.resource.ImmutableValueMap

Returns an immutable map containing the given entries, in order.

of(String, Object, String, Object, String, Object) - Static method in class io.wcm.sling.commons.resource.ImmutableValueMap

Returns an immutable map containing the given entries, in order.

of(String, Object, String, Object, String, Object, String, Object) - Static method in class io.wcm.sling.commons.resource.ImmutableValueMap

Returns an immutable map containing the given entries, in order.

of(String, Object, String, Object, String, Object, String, Object, String, Object) - Static method in class io.wcm.sling.commons.resource.ImmutableValueMap

Returns an immutable map containing the given entries, in order.

P

param(String, Object) - Method in class io.wcm.sling.commons.request.QueryStringBuilder

Add parameter to query string.

PARAMETER_FORMENCODING - Static variable in class io.wcm.sling.commons.request.RequestParam

The name of the form encoding parameter.

params(Map<String, Object>) - Method in class io.wcm.sling.commons.request.QueryStringBuilder

Add map of parameters to query string.

PathPreprocessor - Interface in io.wcm.sling.commons.caservice

Allows to preprocess a path before matching it against the regular experessions of the context-aware services.

PROPERTY_ACCEPTS_CONTEXT_PATH_EMPTY - Static variable in interface io.wcm.sling.commons.caservice.ContextAwareService

Accepts empty context paths.

PROPERTY_CONTEXT_PATH_BLACKLIST_PATTERN - Static variable in interface io.wcm.sling.commons.caservice.ContextAwareService

Context path blacklist expression.

PROPERTY_CONTEXT_PATH_PATTERN - Static variable in interface io.wcm.sling.commons.caservice.ContextAwareService

Context path whitelist expression.

put(String, Object) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap.Builder

Associates key with value in the built map.

put(Map.Entry<String, Object>) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap.Builder

Adds the given entry to the map, making it immutable if necessary.

put(String, Object) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

Deprecated.

Unsupported operation

putAll(Map<String, Object>) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap.Builder

Associates all of the given map's keys and values in the built map.

putAll(Map<? extends String, ? extends Object>) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

Deprecated.

Unsupported operation

Q

QueryStringBuilder - Class in io.wcm.sling.commons.request

Builds a property URL-encoded query string.

QueryStringBuilder() - Constructor for class io.wcm.sling.commons.request.QueryStringBuilder

R

RankedServices<T> - Class in io.wcm.sling.commons.osgi

Deprecated.

Please use org.apache.sling.commons.osgi.RankedServices instead.

RankedServices() - Constructor for class io.wcm.sling.commons.osgi.RankedServices

Deprecated.

Instantiate without change listener.

RankedServices(RankedServices.ChangeListener) - Constructor for class io.wcm.sling.commons.osgi.RankedServices

Deprecated.

Instantiate without change listener.

RankedServices.ChangeListener - Interface in io.wcm.sling.commons.osgi

Deprecated.

Notification for changes on services list.

remove(Object) - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

Deprecated.

Unsupported operation

RequestContext - Interface in io.wcm.sling.commons.request

OSGi service interface for getting a sling request for the current thread.

RequestParam - Class in io.wcm.sling.commons.request

Several helper methods for getting parameters from the servlet request.

RequestPath - Class in io.wcm.sling.commons.request

Utility methods when for sling paths and resources.

resolve(Class<S>, Adaptable) - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceResolver

Resolves the best-matching service implementation for the given resource context.

resolve(Adaptable) - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceCollectionResolver

Resolves the best-matching service implementation for the given resource context.

resolveAll(Class<S>, Adaptable) - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceResolver

Resolves all matching service implementations for the given resource context.

resolveAll(Adaptable) - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceCollectionResolver

Resolves all matching service implementations for the given resource context wrapped in it's decorator.

resolveAllDecorated(Adaptable) - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceCollectionResolver

Resolves all matching service implementations for the given resource context each one wrapped in it's decorator.

resolveDecorated(Adaptable) - Method in interface io.wcm.sling.commons.caservice.ContextAwareServiceCollectionResolver

Resolves the best-matching service implementation for the given resource context.

ResourcePath - Class in io.wcm.sling.commons.resource

Deprecated.

Use io.wcm.wcm.commons.util.Path instead.

ResourceType - Class in io.wcm.sling.commons.resource

Helper methods for resource type path handling.

S

size() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

T

toString() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

U

UnableToAdaptException - Exception in io.wcm.sling.commons.adapter

Exception is thrown if AdaptTo.notNull(org.apache.sling.api.adapter.Adaptable, java.lang.Class<T>) call was not successful.

UnableToAdaptException(Adaptable, Class<?>) - Constructor for exception io.wcm.sling.commons.adapter.UnableToAdaptException

unbind(T, Map<String, Object>) - Method in class io.wcm.sling.commons.osgi.RankedServices

Deprecated.

Handle unbind service event.

urlEncode(String) - Static method in class io.wcm.sling.commons.util.Escape

Applies URL-Encoding to the given parameter name or value.

V

validFilename(String) - Static method in class io.wcm.sling.commons.util.Escape

Create valid filename by applying method Escape.validName(String) on filename and extension.

validName(String) - Static method in class io.wcm.sling.commons.util.Escape

Creates a valid node name.

values() - Method in class io.wcm.sling.commons.resource.ImmutableValueMap

A B C E G H I J K L M N O P Q R S T U V
All Classes All Packages