Package org.forgerock.am.trees.api
Interface TreeUsage
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
Reports the usages of a tree in a realm.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final record
Represents the result of a tree usage. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The maximum number of usages in the usage report. -
Method Summary
Modifier and TypeMethodDescriptionreportUsages
(Realm realm, String treeName) Reports the usages of a tree in a realm.
-
Field Details
-
MAX_USAGES
static final int MAX_USAGESThe maximum number of usages in the usage report.- See Also:
-
-
Method Details
-
reportUsages
Reports the usages of a tree in a realm.- Parameters:
realm
- the realmtreeName
- the tree name- Returns:
- a
TreeUsage.Response
object containing the result of the usage. - Throws:
TreeUsageException
-