Package org.keycloak.models.map.storage.tree

Class TreeStorageNodePrescription

java.lang.Object

org.keycloak.models.map.storage.tree.DefaultTreeNode<TreeStorageNodePrescription>

org.keycloak.models.map.storage.tree.TreeStorageNodePrescription

All Implemented Interfaces:

TreeNode<TreeStorageNodePrescription>

public class TreeStorageNodePrescription
extends DefaultTreeNode<TreeStorageNodePrescription>

Prescription of the tree storage. This prescription can be externalized and contains e.g. details on the particular storage type represented by this node, or properties of the node and edge between this and the parent storage.

Realization of this prescription is in TreeStorageNodeInstance, namely it does not contain a map storage instance that can be directly used for accessing data.

Author:

hmlnarik

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TreeStorageNodePrescription.FieldContainedStatus

Nested classes/interfaces inherited from interface org.keycloak.models.map.storage.tree.TreeNode

TreeNode.PathOrientation

Field Summary

Fields inherited from class org.keycloak.models.map.storage.tree.DefaultTreeNode

edgeProperties, nodeProperties, treeProperties

Constructor Summary

Constructors

Constructor	Description
TreeStorageNodePrescription(Map<String,Object> treeProperties)
TreeStorageNodePrescription(Map<String,Object> nodeProperties, Map<String,Object> edgeProperties, Map<String,Object> treeProperties)

Method Summary

Modifier and Type	Method	Description
<V extends AbstractEntity> TreeStorageNodePrescription	forEntityClass(Class<V> targetEntityClass)
protected String	getLabel()
<V extends AbstractEntity> TreeStorageNodeInstance<V>	instantiate(KeycloakSession session)
TreeStorageNodePrescription.FieldContainedStatus	isCacheFor(EntityField<?> field, Object parameter)
TreeStorageNodePrescription.FieldContainedStatus	isPrimarySourceFor(EntityField<?> field, Object parameter)	Returns if the given field is primary source for the field, potentially specified further by a parameter.
boolean	isReadOnly()

Methods inherited from class org.keycloak.models.map.storage.tree.DefaultTreeNode

addChild, addChild, cloneTree, equals, findFirstBfs, findFirstBottommostDfs, findFirstDfs, forEachParent, getChild, getChildren, getEdgeProperties, getEdgeProperty, getId, getNodeProperties, getNodeProperty, getParent, getParentsStream, getPathToRoot, getTreeProperties, getTreeProperty, hasChildren, hashCode, hasNoChildren, removeChild, removeChild, setEdgeProperty, setId, setNodeProperty, setParent, toString, walkBfs, walkDfs

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TreeStorageNodePrescription

public TreeStorageNodePrescription(Map<String,Object> treeProperties)

TreeStorageNodePrescription

public TreeStorageNodePrescription(Map<String,Object> nodeProperties,
                                   Map<String,Object> edgeProperties,
                                   Map<String,Object> treeProperties)

Method Detail

forEntityClass

public <V extends AbstractEntity> TreeStorageNodePrescription forEntityClass(Class<V> targetEntityClass)

instantiate

public <V extends AbstractEntity> TreeStorageNodeInstance<V> instantiate(KeycloakSession session)

isReadOnly

public boolean isReadOnly()

isPrimarySourceFor

public TreeStorageNodePrescription.FieldContainedStatus isPrimarySourceFor(EntityField<?> field,
                                                                           Object parameter)

Returns if the given field is primary source for the field, potentially specified further by a parameter.

Parameters:

field - Field

parameter - First parameter, which in case of maps is the key to that map, e.g. attribute name.

Returns:

For a fully specified field and a parameter (e.g. "attribute" and "attr1"), or a parameterless field (e.g. "client_id"), returns either FULLY or NOT_CONTAINED. May also return PARTIAL for a field that requires a parameter but the parameter is not specified.

isCacheFor

public TreeStorageNodePrescription.FieldContainedStatus isCacheFor(EntityField<?> field,
                                                                   Object parameter)

getLabel

protected String getLabel()

Overrides:

getLabel in class DefaultTreeNode<TreeStorageNodePrescription>