com.day.cq.contentbus

Interface PathContext

All Known Implementing Classes:

AbstractPathContext, DefaultPathContext

public interface PathContext

The PathContext interface use used to provide path information to the contentbus when resolving relative handles.

Since:

coati

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Iterator	paths() Deprecated. since echidna, use paths(Ticket) instead
java.util.Iterator	paths(Ticket ticket) Returns an iteration over paths.
java.lang.String	resolveHandle(Ticket ticket, java.lang.String handle) Resolves the handle in the path using the given ticket.

Method Detail

paths

java.util.Iterator paths()

Deprecated. since echidna, use paths(Ticket) instead

Returns an iteration over paths. Please note that all returned paths always end with a '/'.

Returns:

an iteration of strings.

paths

java.util.Iterator paths(Ticket ticket)

Returns an iteration over paths. Please note that all returned paths always end with a '/'.

Parameters:

ticket - The Ticket to use in case the path cache needs rebuild.

Returns:

an iteration of strings.

Since:

echidna

resolveHandle

java.lang.String resolveHandle(Ticket ticket,
                             java.lang.String handle)

Resolves the handle in the path using the given ticket. As the resolution is based on the ticket, it is legal for the results to be different for different Tickets.

Parameters:

ticket - The ticket to use for the resolution

handle - The handle to resovle. If this is an absolute handle, it is returned unmodified.

Returns:

An absolute handle being the input handle resolved using the path components or null if the handle cannot be resolved.