org.forgerock.openam.entitlement.indextree

Class TreeSearchIndex

java.lang.Object

org.forgerock.openam.entitlement.indextree.TreeSearchIndex

All Implemented Interfaces:

ISearchIndex

public class TreeSearchIndex
extends Object
implements ISearchIndex

This search index implementation acts as a go between for the entitlements framework and the delegate. The benefit is that a dumb implementation can be substituted when in the client context removing the need for SDK to package up third party dependencies.

Author:

apforrest

Constructor Summary

Constructors

Constructor and Description
TreeSearchIndex()

Method Summary

Modifier and Type	Method and Description
ResourceSearchIndexes	getIndexes(String resource, String realm) Returns search indexes for a given resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeSearchIndex

public TreeSearchIndex()

Method Detail

getIndexes

public ResourceSearchIndexes getIndexes(String resource,
                                        String realm)
                                 throws EntitlementException

Description copied from interface: ISearchIndex

Returns search indexes for a given resource.

Specified by:

getIndexes in interface ISearchIndex

Parameters:

resource - Resource for generating the indexes.

realm - Current realm to be searched.

Returns:

search indexes for a given resource.

Throws:

EntitlementException - When an error occurs in the entitlements framework.