com.yahoo.elide.core.dictionary

Class EntityDictionary

java.lang.Object

com.yahoo.elide.core.dictionary.EntityDictionary

public class EntityDictionary
extends Object

Entity Dictionary maps JSON API Entity beans to/from Entity type names.

See Also:

Include.name()

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	apiVersions
protected CopyOnWriteArrayList<Type<?>>	bindEntityRoots
protected ConcurrentHashMap<org.apache.commons.lang3.tuple.Pair<String,String>,Type<?>>	bindJsonApiToEntity
protected com.google.common.collect.BiMap<String,Class<? extends Check>>	checkNames
static String	ELIDE_PACKAGE_PREFIX
protected ConcurrentHashMap<Type<?>,EntityBinding>	entityBindings
protected ConcurrentHashMap<Type<?>,Function<RequestScope,PermissionExecutor>>	entityPermissionExecutor
protected Injector	injector
static String	NO_VERSION
static String	REGULAR_ID_NAME
protected Map<String,UserCheck>	roleChecks
protected Function<Class,Serde>	serdeLookup
protected ConcurrentHashMap<Type<?>,List<Type<?>>>	subclassingEntities

Constructor Summary

Constructors

Constructor and Description
EntityDictionary(Map<String,Class<? extends Check>> checks) Instantiate a new EntityDictionary with the provided set of checks.
EntityDictionary(Map<String,Class<? extends Check>> checks, Injector injector) Instantiate a new EntityDictionary with the provided set of checks and an injection function.
EntityDictionary(Map<String,Class<? extends Check>> checks, Injector injector, Function<Class,Serde> serdeLookup)
EntityDictionary(Map<String,Class<? extends Check>> checks, Injector injector, Function<Class,Serde> serdeLookup, Set<Type<?>> entitiesToExclude)
EntityDictionary(Map<String,Class<? extends Check>> checks, Injector injector, Set<Type<?>> entitiesToExclude) Instantiate a new EntityDictionary with the provided set of checks and an injection function.
EntityDictionary(Map<String,Class<? extends Check>> checks, Map<String,UserCheck> roleChecks, Injector injector) Instantiate a new EntityDictionary with the provided set of checks and an injection function.
EntityDictionary(Map<String,Class<? extends Check>> checks, Map<String,UserCheck> roleChecks, Injector injector, Function<Class,Serde> serdeLookup, Set<Type<?>> entitiesToExclude)
EntityDictionary(Map<String,Class<? extends Check>> checks, Set<Type<?>> entitiesToExclude) Instantiate a new EntityDictionary with the provided set of checks.

Method Summary

Modifier and Type	Method and Description
void	addArgumentsToAttribute(Type<?> cls, String attributeName, Set<ArgumentType> arguments) Add a collection of argument to the attributes.
void	addArgumentToAttribute(Type<?> cls, String attributeName, ArgumentType argument) Add a single argument to the attribute.
void	addArgumentToEntity(Type<?> cls, ArgumentType argument) Add a single argument to the Entity.
void	addRoleCheck(String role, UserCheck check) Adds a user check for a given role to the dictionary.
void	addSecurityCheck(Class<?> cls) Add security checks and bind them to the dictionary.
void	addSecurityChecks(Set<Class<?>> classes) Add security checks and bind them to the dictionary.
<A extends Annotation> boolean	attributeOrRelationAnnotationExists(Type<?> cls, String fieldName, Class<A> annotationClass) Returns whether or not a specified annotation is present on an entity field or its corresponding method.
void	bindEntity(Class<?> cls) Add given Entity bean to dictionary.
void	bindEntity(Class<?> cls, Set<Class<? extends Annotation>> hiddenAnnotations) Add given Entity bean to dictionary.
void	bindEntity(EntityBinding entityBinding) Add an EntityBinding instance to dictionary.
void	bindEntity(Type<?> cls) Add given Entity bean to dictionary.
void	bindEntity(Type<?> cls, Set<Class<? extends Annotation>> hiddenAnnotations) Add given Entity bean to dictionary.
void	bindLegacyHooks(EntityBinding binding)
void	bindPermissionExecutor(Class<?> clz, Function<RequestScope,PermissionExecutor> permissionExecutorFunction) Add a permissionExecutorGenerator to the provided class.
void	bindPermissionExecutor(Type<?> clz, Function<RequestScope,PermissionExecutor> permissionExecutorFunction) Add a permissionExecutorGenerator to the provided class.
void	bindTrigger(Class<?> entityClass, LifeCycleHookBinding.Operation operation, LifeCycleHookBinding.TransactionPhase phase, LifeCycleHook hook, boolean allowMultipleInvocations) Binds a lifecycle hook to a particular entity class.
void	bindTrigger(Class<?> entityClass, String fieldOrMethodName, LifeCycleHookBinding.Operation operation, LifeCycleHookBinding.TransactionPhase phase, LifeCycleHook hook) Binds a lifecycle hook to a particular field or method in an entity.
void	bindTrigger(Type<?> entityClass, LifeCycleHookBinding.Operation operation, LifeCycleHookBinding.TransactionPhase phase, LifeCycleHook hook, boolean allowMultipleInvocations) Binds a lifecycle hook to a particular entity class.
void	bindTrigger(Type<?> entityClass, String fieldOrMethodName, LifeCycleHookBinding.Operation operation, LifeCycleHookBinding.TransactionPhase phase, LifeCycleHook hook) Binds a lifecycle hook to a particular field or method in an entity.
Map<Type<?>,PermissionExecutor>	buildPermissionExecutors(RequestScope scope) Create a PermissionExecutor from list of bound permissionExecutorGenerator.
boolean	cascadeDeletes(Type<?> targetClass, String fieldName) Returns true if the relationship cascades deletes and false otherwise.
Object	coerce(Object target, Object value, String fieldName, Type<?> fieldType) Coerce provided value into expected class type.
boolean	entityHasChecksForPermission(Type<?> resourceClass, Class<? extends Annotation> annotationClass) Determine if a given (entity class, permission) pair have any permissions defined.
static Method	findMethod(Type<?> entityClass, String name, Type<?>... paramClass) Find an arbitrary method.
AccessibleObject	getAccessibleObject(Object target, String fieldName) Retrieve the accessible object for a field from a target object.
AccessibleObject	getAccessibleObject(Type<?> targetClass, String fieldName) Retrieve the accessible object for a field.
javax.persistence.AccessType	getAccessType(Type<?> entityClass) Returns whether the entire entity uses Field or Property level access.
List<String>	getAllFields(Object entity) Get a list of all fields including both relationships and attributes.
List<String>	getAllFields(Type<?> entityClass) Get a list of all fields including both relationships and attributes.
String	getAnnotatedColumnName(Type<?> cls, String fieldName) Get column name using JPA.
<A extends Annotation> A	getAnnotation(PersistentResource record, Class<A> annotationClass) Return annotation from class, parents or package.
<A extends Annotation> A	getAnnotation(Type<?> recordClass, Class<A> annotationClass) Return annotation from class, parents or package.
Set<ArgumentType>	getAttributeArguments(Type<?> cls, String attributeName) Returns the Collection of all arguments of an attribute.
<A extends Annotation> A	getAttributeOrRelationAnnotation(Type<?> entityClass, Class<A> annotationClass, String identifier) Return a single annotation from field or accessor method.
<A extends Annotation> A[]	getAttributeOrRelationAnnotations(Type<?> entityClass, Class<A> annotationClass, String identifier) Return multiple annotations from field or accessor method.
List<String>	getAttributes(Object entity) Get the list of attribute names for an entity.
List<String>	getAttributes(Type<?> entityClass) Get the list of attribute names for an entity.
Set<EntityBinding>	getBindings() Get all bindings.
Set<Type<?>>	getBoundClasses() Get all bound classes.
Set<Type<?>>	getBoundClassesByVersion(String apiVersion) Get all bound classes for a particular API version.
Class<? extends Check>	getCheck(String checkIdentifier) Returns the check mapped to a particular identifier.
String	getCheckIdentifier(Class<? extends Check> checkClass) Returns the friendly named mapped to this given check.
Set<String>	getCheckIdentifiers() Gets all the registered check identifiers.
Map<String,Class<? extends Check>>	getCheckMappings() Get the check mappings.
List<String>	getElideBoundRelationships(Object entity) Get a list of elide-bound relationships.
List<String>	getElideBoundRelationships(Type<?> entityClass) Get a list of elide-bound relationships.
Set<ArgumentType>	getEntityArguments(Type<?> cls) Returns the Collection of all arguments of an entity.
EntityBinding	getEntityBinding(Type<?> entityClass) Returns an entity binding if the provided class has been bound in the dictionary.
Type<?>	getEntityClass(String entityName, String version) Returns the binding class for a given entity name.
static String	getEntityName(Type<?> modelClass) Looks up the API model name for a given class.
Set<String>	getFieldsOfType(Type<?> targetClass, Type<?> targetType) Retrieve fields from an object containing a particular type.
static Annotation	getFirstAnnotation(Type<?> entityClass, List<Class<? extends Annotation>> annotationClassList) Return first matching annotation from class, parents or package.
static Annotation	getFirstPackageAnnotation(Type<?> entityClass, List<Class<? extends Annotation>> annotationClassList) Return first matching annotation from a package or parent package.
String	getId(Object value) Gets id.
Collection<Annotation>	getIdAnnotations(Object value) Returns annotations applied to the ID field.
String	getIdFieldName(Type<?> entityClass) Returns the name of the id field.
Type<?>	getIdType(Type<?> entityClass) Returns type of id field.
Injector	getInjector() Get the Injector for this dictionary.
String	getJsonAliasFor(Type<?> entityClass) Returns the Include name for a given binding class.
<A extends Annotation> A	getMethodAnnotation(Type<?> recordClass, String method, Class<A> annotationClass) Return annotation from class for provided method.
static String	getModelVersion(Type<?> modelClass) Returns the api version bound to a particular model class.
String	getNameFromAlias(Object entity, String alias) Get the true field/method name from an alias.
String	getNameFromAlias(Type<?> entityClass, String alias) Get the true field/method name from an alias.
Type<?>	getParameterizedType(Object entity, String identifier) Retrieve the parameterized type for the given field.
Type<?>	getParameterizedType(Object entity, String identifier, int paramIndex) Retrieve the parameterized type for the given field.
Type<?>	getParameterizedType(Type<?> entityClass, String identifier) Retrieve the parameterized type for the given field.
Type<?>	getParameterizedType(Type<?> entityClass, String identifier, int paramIndex) Retrieve the parameterized type for the given field.
org.antlr.v4.runtime.tree.ParseTree	getPermissionsForClass(Type<?> resourceClass, Class<? extends Annotation> annotationClass) Gets the specified permission definition (if any) at the class level.
org.antlr.v4.runtime.tree.ParseTree	getPermissionsForField(Type<?> resourceClass, String field, Class<? extends Annotation> annotationClass) Gets the specified permission definition (if any) at the class level.
String	getRelationInverse(Type<?> cls, String relation) If a relationship is bidirectional, returns the name of the peer relationship in the peer entity.
List<String>	getRelationships(Object entity) Get the list of relationship names for an entity.
List<String>	getRelationships(Type<?> entityClass) Get the list of relationship names for an entity.
RelationshipType	getRelationshipType(Object entity, String relation) Get the type of relationship from a relation.
RelationshipType	getRelationshipType(Type<?> cls, String relation) Get the type of relationship from a relation.
UserCheck	getRoleCheck(String role) Returns an instantiated role check for the given role.
Map<String,UserCheck>	getRoleChecks() Returns the map of role to their user role check object.
static String	getSimpleName(Type<?> cls) Cache the simple name of the provided class.
List<Type<?>>	getSubclassingEntities(Type entityClass) Get a list of inherited entities from a particular entity.
List<Type<?>>	getSuperClassEntities(Type<?> entityClass) Fetch all entity classes that provided entity inherits from (i.e.
Collection<LifeCycleHook>	getTriggers(Type<?> cls, LifeCycleHookBinding.Operation op, LifeCycleHookBinding.TransactionPhase phase)
Collection<LifeCycleHook>	getTriggers(Type<?> cls, LifeCycleHookBinding.Operation op, LifeCycleHookBinding.TransactionPhase phase, String fieldName)
Type<?>	getType(Object entity, String identifier) Get a type for a field on an entity.
static <T> Type<T>	getType(T object)
Type<?>	getType(Type<?> entityClass, String identifier) Get a type for a field on an entity.
Object	getValue(Object target, String fieldName, RequestScope scope) Invoke the get[fieldName] method on the target object OR get the field with the corresponding name.
boolean	hasBinding(Type<?> cls) Returns whether or not a class is already bound.
<T> void	initializeEntity(T entity) Initialize an entity.
boolean	isAttribute(Type<?> entityClass, String attributeName)
boolean	isComputed(Type<?> entityClass, String fieldName)
boolean	isIdGenerated(Type<?> entityClass) Returns whether or not the ID field for a given model is generated by the persistence layer.
boolean	isJPAEntity(Type<?> objClass) Check whether a class is a JPA entity.
boolean	isMethodRequestScopeable(Object entity, Method method) Determine whether or not a method is request scopeable.
boolean	isMethodRequestScopeable(Type<?> entityClass, Method method) Determine whether or not a method is request scopeable.
boolean	isRelation(Type<?> entityClass, String relationName)
boolean	isRoot(Type<?> entityClass) Is root.
boolean	isStrictNonTransferable(Type<?> entityClass) Returns whether or not an entity can ever be shared post creation.
boolean	isTransferable(Type<?> entityClass) Returns whether or not an entity is shareable.
boolean	isValidField(Type<?> cls, String fieldName) Returns whether or not a specified field exists in an entity.
static Type<?>	lookupAnnotationDeclarationClass(Type<?> objClass, Class<? extends Annotation> annotationClass) Search a class hierarchy to find the first instance of a declared annotation.
Type<?>	lookupBoundClass(Type<?> objClass) Return bound entity or null.
Type<?>	lookupEntityClass(Type<?> objClass) Follow for this class or super-class for JPA Entity annotation.
Type<?>	lookupIncludeClass(Type<?> objClass) Follow for this class or super-class for Include annotation.
void	scanForSecurityChecks() Scan for security checks and automatically bind them to the dictionary.
void	setId(Object target, String id) Sets the ID field of a target object.
void	setValue(Object target, String fieldName, Object value) Invoke the set[fieldName] method on the target object OR set the field with the corresponding name.
<T> List<T>	walkEntityGraph(Set<Type<?>> entities, Function<Type<?>,T> transform) Walks the entity graph and performs a transform function on each element.

Methods inherited from class java.lang.Object

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

Field Detail

ELIDE_PACKAGE_PREFIX

public static final String ELIDE_PACKAGE_PREFIX

See Also:

Constant Field Values

NO_VERSION

public static final String NO_VERSION

See Also:

Constant Field Values

bindJsonApiToEntity

protected final ConcurrentHashMap<org.apache.commons.lang3.tuple.Pair<String,String>,Type<?>> bindJsonApiToEntity

entityBindings

protected final ConcurrentHashMap<Type<?>,EntityBinding> entityBindings

entityPermissionExecutor

protected final ConcurrentHashMap<Type<?>,Function<RequestScope,PermissionExecutor>> entityPermissionExecutor

bindEntityRoots

protected final CopyOnWriteArrayList<Type<?>> bindEntityRoots

subclassingEntities

protected final ConcurrentHashMap<Type<?>,List<Type<?>>> subclassingEntities

checkNames

protected final com.google.common.collect.BiMap<String,Class<? extends Check>> checkNames

roleChecks

protected final Map<String,UserCheck> roleChecks

apiVersions

protected final Set<String> apiVersions

injector

protected final Injector injector

serdeLookup

protected final Function<Class,Serde> serdeLookup

REGULAR_ID_NAME

public static final String REGULAR_ID_NAME

See Also:

Constant Field Values

Constructor Detail

EntityDictionary

public EntityDictionary(Map<String,Class<? extends Check>> checks)

Instantiate a new EntityDictionary with the provided set of checks. In addition all of the checks in com.yahoo.elide.core.security.checks.prefab are mapped to Prefab.CONTAINER.CHECK (e.g. @ReadPermission(expression="Prefab.Role.All") or @ReadPermission(expression="Prefab.Common.UpdateOnCreate"))

Parameters:

checks - a map that links the identifiers used in the permission expression strings to their implementing classes

EntityDictionary

public EntityDictionary(Map<String,Class<? extends Check>> checks,
                        Set<Type<?>> entitiesToExclude)

Instantiate a new EntityDictionary with the provided set of checks. In addition all of the checks in com.yahoo.elide.core.security.checks.prefab are mapped to Prefab.CONTAINER.CHECK (e.g. @ReadPermission(expression="Prefab.Role.All") or @ReadPermission(expression="Prefab.Common.UpdateOnCreate"))

Parameters:

checks - a map that links the identifiers used in the permission expression strings to their implementing classes.

entitiesToExclude - Set of Models to exclude from Binding.

EntityDictionary

public EntityDictionary(Map<String,Class<? extends Check>> checks,
                        Injector injector)

Instantiate a new EntityDictionary with the provided set of checks and an injection function. In addition, all of the checks * in com.yahoo.elide.core.security.checks.prefab are mapped to Prefab.CONTAINER.CHECK * (e.g. @ReadPermission(expression="Prefab.Role.All") or @ReadPermission(expression="Prefab.Common.UpdateOnCreate"))

Parameters:

checks - a map that links the identifiers used in the permission expression strings to their implementing classes

injector - a function typically associated with a dependency injection framework that will initialize Elide models.

EntityDictionary

public EntityDictionary(Map<String,Class<? extends Check>> checks,
                        Map<String,UserCheck> roleChecks,
                        Injector injector)

Instantiate a new EntityDictionary with the provided set of checks and an injection function. In addition, all of the checks * in com.yahoo.elide.core.security.checks.prefab are mapped to Prefab.CONTAINER.CHECK * (e.g. @ReadPermission(expression="Prefab.Role.All") or @ReadPermission(expression="Prefab.Common.UpdateOnCreate"))

Parameters:

checks - a map that links the identifiers used in the permission expression strings to their implementing classes

roleChecks - a map that links the user check identifiers used in the permission expression strings to their User Check object

injector - a function typically associated with a dependency injection framework that will initialize Elide models.

EntityDictionary

public EntityDictionary(Map<String,Class<? extends Check>> checks,
                        Injector injector,
                        Set<Type<?>> entitiesToExclude)

Instantiate a new EntityDictionary with the provided set of checks and an injection function. In addition, all of the checks * in com.yahoo.elide.core.security.checks.prefab are mapped to Prefab.CONTAINER.CHECK * (e.g. @ReadPermission(expression="Prefab.Role.All") or @ReadPermission(expression="Prefab.Common.UpdateOnCreate"))

Parameters:

checks - a map that links the identifiers used in the permission expression strings to their implementing classes

injector - a function typically associated with a dependency injection framework that will initialize Elide models.

entitiesToExclude - Set of Models to exclude from Binding.

EntityDictionary

public EntityDictionary(Map<String,Class<? extends Check>> checks,
                        Injector injector,
                        Function<Class,Serde> serdeLookup)

EntityDictionary

public EntityDictionary(Map<String,Class<? extends Check>> checks,
                        Injector injector,
                        Function<Class,Serde> serdeLookup,
                        Set<Type<?>> entitiesToExclude)

EntityDictionary

public EntityDictionary(Map<String,Class<? extends Check>> checks,
                        Map<String,UserCheck> roleChecks,
                        Injector injector,
                        Function<Class,Serde> serdeLookup,
                        Set<Type<?>> entitiesToExclude)

Method Detail

addRoleCheck

public void addRoleCheck(String role,
                         UserCheck check)

Adds a user check for a given role to the dictionary.

Parameters:

role - The role associated with the check.

check - The instantiated check class.

getRoleCheck

public UserCheck getRoleCheck(String role)

Returns an instantiated role check for the given role.

Parameters:

role - The role associated with the check.

Returns:

The user check associated with the role.

getRoleChecks

public Map<String,UserCheck> getRoleChecks()

Returns the map of role to their user role check object.

Returns:

getCheckIdentifiers

public Set<String> getCheckIdentifiers()

Gets all the registered check identifiers.

Returns:

A set of check identifier strings.

getSimpleName

public static String getSimpleName(Type<?> cls)

Cache the simple name of the provided class.

Parameters:

cls - the Class object to be checked

Returns:

simple name

findMethod

public static Method findMethod(Type<?> entityClass,
                                String name,
                                Type<?>... paramClass)
                         throws NoSuchMethodException

Find an arbitrary method.

Parameters:

entityClass - the entity class

name - the name

paramClass - the param class

Returns:

method method

Throws:

NoSuchMethodException - the no such method exception

getEntityBinding

public EntityBinding getEntityBinding(Type<?> entityClass)

Returns an entity binding if the provided class has been bound in the dictionary. Otherwise the behavior depends on whether the unbound class is an Entity or not. If it is not an Entity, we return an EMPTY_BINDING. This preserves existing behavior for relationships which are entities but not bound. Otherwise, we throw an exception - which also preserves behavior for unbound non-entities.

Parameters:

entityClass -

Returns:

isIdGenerated

public boolean isIdGenerated(Type<?> entityClass)

Returns whether or not the ID field for a given model is generated by the persistence layer.

Parameters:

entityClass - The model to lookup.

Returns:

True if the ID field is generated. False otherwise.

getEntityClass

public Type<?> getEntityClass(String entityName,
                              String version)

Returns the binding class for a given entity name.

Parameters:

entityName - entity name

Returns:

binding class

getJsonAliasFor

public String getJsonAliasFor(Type<?> entityClass)

Returns the Include name for a given binding class.

Parameters:

entityClass - the entity class

Returns:

binding class

See Also:

Include

entityHasChecksForPermission

public boolean entityHasChecksForPermission(Type<?> resourceClass,
                                            Class<? extends Annotation> annotationClass)

Determine if a given (entity class, permission) pair have any permissions defined.

Parameters:

resourceClass - the entity class

annotationClass - the permission annotation

Returns:

true if that permission is defined anywhere within the class

getPermissionsForClass

public org.antlr.v4.runtime.tree.ParseTree getPermissionsForClass(Type<?> resourceClass,
                                                                  Class<? extends Annotation> annotationClass)

Gets the specified permission definition (if any) at the class level.

Parameters:

resourceClass - the entity to check

annotationClass - the permission to look for

Returns:

a ParseTree expressing the permissions, if one exists or null if the permission is not specified at a class level

getPermissionsForField

public org.antlr.v4.runtime.tree.ParseTree getPermissionsForField(Type<?> resourceClass,
                                                                  String field,
                                                                  Class<? extends Annotation> annotationClass)

Gets the specified permission definition (if any) at the class level.

Parameters:

resourceClass - the entity to check

field - the field to inspect

annotationClass - the permission to look for

Returns:

a ParseTree expressing the permissions, if one exists or null if the permission is not specified on that field

getCheck

public Class<? extends Check> getCheck(String checkIdentifier)

Returns the check mapped to a particular identifier.

Parameters:

checkIdentifier - the name from the expression string

Returns:

the Check mapped to the identifier or null if the given identifer is unmapped

getSuperClassEntities

public List<Type<?>> getSuperClassEntities(Type<?> entityClass)

Fetch all entity classes that provided entity inherits from (i.e. all superclass entities down to, but excluding Object).

Parameters:

entityClass - Entity class

Returns:

List of all super class entity classes

getSubclassingEntities

public List<Type<?>> getSubclassingEntities(Type entityClass)

Get a list of inherited entities from a particular entity. Namely, the list of entities inheriting from the provided class.

Parameters:

entityClass - Entity class

Returns:

List of all inherited entity types

getCheckIdentifier

public String getCheckIdentifier(Class<? extends Check> checkClass)

Returns the friendly named mapped to this given check.

Parameters:

checkClass - The class to lookup

Returns:

the friendly name of the check.

getIdFieldName

public String getIdFieldName(Type<?> entityClass)

Returns the name of the id field.

Parameters:

entityClass - Entity class

Returns:

id field name

getAccessType

public javax.persistence.AccessType getAccessType(Type<?> entityClass)

Returns whether the entire entity uses Field or Property level access.

Parameters:

entityClass - Entity Class

Returns:

The JPA Access Type

getBoundClasses

public Set<Type<?>> getBoundClasses()

Get all bound classes.

Returns:

the bound classes

getBoundClassesByVersion

public Set<Type<?>> getBoundClassesByVersion(String apiVersion)

Get all bound classes for a particular API version.

Returns:

the bound classes

getBindings

public Set<EntityBinding> getBindings()

Get all bindings.

Returns:

the bindings

getCheckMappings

public Map<String,Class<? extends Check>> getCheckMappings()

Get the check mappings.

Returns:

a map of check mappings this dictionary knows about

getAttributes

public List<String> getAttributes(Type<?> entityClass)

Get the list of attribute names for an entity.

Parameters:

entityClass - entity name

Returns:

List of attribute names for entity

getInjector

public Injector getInjector()

Get the Injector for this dictionary.

Returns:

Injector instance.

getAttributes

public List<String> getAttributes(Object entity)

Get the list of attribute names for an entity.

Parameters:

entity - entity instance

Returns:

List of attribute names for entity

getRelationships

public List<String> getRelationships(Type<?> entityClass)

Get the list of relationship names for an entity.

Parameters:

entityClass - entity name

Returns:

List of relationship names for entity

getRelationships

public List<String> getRelationships(Object entity)

Get the list of relationship names for an entity.

Parameters:

entity - entity instance

Returns:

List of relationship names for entity

getElideBoundRelationships

public List<String> getElideBoundRelationships(Type<?> entityClass)

Get a list of elide-bound relationships.

Parameters:

entityClass - Entity class to find relationships for

Returns:

List of elide-bound relationship names.

getElideBoundRelationships

public List<String> getElideBoundRelationships(Object entity)

Get a list of elide-bound relationships.

Parameters:

entity - Entity instance to find relationships for

Returns:

List of elide-bound relationship names.

isMethodRequestScopeable

public boolean isMethodRequestScopeable(Object entity,
                                        Method method)

Determine whether or not a method is request scopeable.

Parameters:

entity - Entity instance

method - Method on entity to check

Returns:

True if method accepts a RequestScope, false otherwise.

isMethodRequestScopeable

public boolean isMethodRequestScopeable(Type<?> entityClass,
                                        Method method)

Determine whether or not a method is request scopeable.

Parameters:

entityClass - Entity to check

method - Method on entity to check

Returns:

True if method accepts a RequestScope, false otherwise.

getAllFields

public List<String> getAllFields(Type<?> entityClass)

Get a list of all fields including both relationships and attributes.

Parameters:

entityClass - entity name

Returns:

List of all fields.

getAllFields

public List<String> getAllFields(Object entity)

Get a list of all fields including both relationships and attributes.

Parameters:

entity - entity

Returns:

List of all fields.

getRelationshipType

public RelationshipType getRelationshipType(Type<?> cls,
                                            String relation)

Get the type of relationship from a relation.

Parameters:

cls - Entity class

relation - Name of relationship field

Returns:

Relationship type. RelationshipType.NONE if is none found.

getRelationInverse

public String getRelationInverse(Type<?> cls,
                                 String relation)

If a relationship is bidirectional, returns the name of the peer relationship in the peer entity.

Parameters:

cls - the cls

relation - the relation

Returns:

relation inverse

getRelationshipType

public RelationshipType getRelationshipType(Object entity,
                                            String relation)

Get the type of relationship from a relation.

Parameters:

entity - Entity instance

relation - Name of relationship field

Returns:

Relationship type. RelationshipType.NONE if is none found.

getType

public Type<?> getType(Type<?> entityClass,
                       String identifier)

Get a type for a field on an entity.

If this method is called on a bean such as the following

 
 public class Address {
     {@literal @}Id
     private Long id

     private String street1;

     private String street2;
 }
 
 

then

 
 getType(Address.class, "id") = Long.class
 getType(Address.class, "street1") = String.class
 getType(Address.class, "street2") = String.class
 
 

But if the ID field is not "id" and there is no such non-ID field called "id", i.e.

 
 public class Address {
     {@literal @}Id
     private Long surrogateKey

     private String street1;

     private String street2;
 }
 
 

then

 
 getType(Address.class, "id") = Long.class
 getType(Address.class, "surrogateKey") = Long.class
 getType(Address.class, "street1") = String.class
 getType(Address.class, "street2") = String.class
 
 

JSON-API spec does not allow "id" as non-ID field name. If, therefore, there is a non-ID field called "id", calling this method has undefined behavior

Parameters:

entityClass - Entity class

identifier - Identifier/Field to lookup type

Returns:

Type of entity

getType

public Type<?> getType(Object entity,
                       String identifier)

Get a type for a field on an entity.

Parameters:

entity - Entity instance

identifier - Field to lookup type

Returns:

Type of entity

getParameterizedType

public Type<?> getParameterizedType(Type<?> entityClass,
                                    String identifier)

Retrieve the parameterized type for the given field.

Parameters:

entityClass - the entity class

identifier - the identifier

Returns:

Entity type for field otherwise null.

getParameterizedType

public Type<?> getParameterizedType(Type<?> entityClass,
                                    String identifier,
                                    int paramIndex)

Retrieve the parameterized type for the given field.

Parameters:

entityClass - the entity class

identifier - the identifier/field name

paramIndex - the index of the parameterization

Returns:

Entity type for field otherwise null.

getParameterizedType

public Type<?> getParameterizedType(Object entity,
                                    String identifier)

Retrieve the parameterized type for the given field.

Parameters:

entity - Entity instance

identifier - Field to lookup

Returns:

Entity type for field otherwise null.

getParameterizedType

public Type<?> getParameterizedType(Object entity,
                                    String identifier,
                                    int paramIndex)

Retrieve the parameterized type for the given field.

Parameters:

entity - Entity instance

identifier - Field to lookup

paramIndex - the index of the parameterization

Returns:

Entity type for field otherwise null.

getNameFromAlias

public String getNameFromAlias(Type<?> entityClass,
                               String alias)

Get the true field/method name from an alias.

Parameters:

entityClass - Entity name

alias - Alias to convert

Returns:

Real field/method name as a string. null if not found.

getNameFromAlias

public String getNameFromAlias(Object entity,
                               String alias)

Get the true field/method name from an alias.

Parameters:

entity - Entity instance

alias - Alias to convert

Returns:

Real field/method name as a string. null if not found.

initializeEntity

public <T> void initializeEntity(T entity)

Initialize an entity.

Type Parameters:

T - the type parameter

Parameters:

entity - Entity to initialize

isTransferable

public boolean isTransferable(Type<?> entityClass)

Returns whether or not an entity is shareable.

Parameters:

entityClass - the entity type to check for the shareable permissions

Returns:

true if entityClass is shareable. False otherwise.

isStrictNonTransferable

public boolean isStrictNonTransferable(Type<?> entityClass)

Returns whether or not an entity can ever be shared post creation.

Parameters:

entityClass - the entity type to check for the shareable permissions

Returns:

true if entityClass can never be shared post creation. False otherwise.

bindEntity

public void bindEntity(Class<?> cls)

Add given Entity bean to dictionary.

Parameters:

cls - Entity bean class

bindEntity

public void bindEntity(Type<?> cls)

Add given Entity bean to dictionary.

Parameters:

cls - Entity bean class

bindEntity

public void bindEntity(Class<?> cls,
                       Set<Class<? extends Annotation>> hiddenAnnotations)

Add given Entity bean to dictionary.

Parameters:

cls - Entity bean class

hiddenAnnotations - Annotations for hiding a field in API

bindEntity

public void bindEntity(Type<?> cls,
                       Set<Class<? extends Annotation>> hiddenAnnotations)

Add given Entity bean to dictionary.

Parameters:

cls - Entity bean class

hiddenAnnotations - Annotations for hiding a field in API

bindEntity

public void bindEntity(EntityBinding entityBinding)

Add an EntityBinding instance to dictionary.

Parameters:

entityBinding - EntityBinding instance

bindPermissionExecutor

public void bindPermissionExecutor(Class<?> clz,
                                   Function<RequestScope,PermissionExecutor> permissionExecutorFunction)

Add a permissionExecutorGenerator to the provided class.

Parameters:

clz - Entity model class

permissionExecutorFunction - Function that given a request scope returns permissionExecutor

bindPermissionExecutor

public void bindPermissionExecutor(Type<?> clz,
                                   Function<RequestScope,PermissionExecutor> permissionExecutorFunction)

Add a permissionExecutorGenerator to the provided class.

Parameters:

clz - Entity model type

permissionExecutorFunction - Function that given a request scope returns permissionExecutor

buildPermissionExecutors

public Map<Type<?>,PermissionExecutor> buildPermissionExecutors(RequestScope scope)

Create a PermissionExecutor from list of bound permissionExecutorGenerator.

Parameters:

scope - - request scope to generate permission executor.

Returns:

Map of bound model type to its permission executor object.

getAnnotation

public <A extends Annotation> A getAnnotation(PersistentResource record,
                                              Class<A> annotationClass)

Return annotation from class, parents or package.

Type Parameters:

A - genericClass

Parameters:

record - the record

annotationClass - the annotation class

Returns:

the annotation

getAnnotation

public <A extends Annotation> A getAnnotation(Type<?> recordClass,
                                              Class<A> annotationClass)

Return annotation from class, parents or package.

Type Parameters:

A - genericClass

Parameters:

recordClass - the record class

annotationClass - the annotation class

Returns:

the annotation

getMethodAnnotation

public <A extends Annotation> A getMethodAnnotation(Type<?> recordClass,
                                                    String method,
                                                    Class<A> annotationClass)

Return annotation from class for provided method.

Type Parameters:

A - genericClass

Parameters:

recordClass - the record class

method - the method

annotationClass - the annotation class

Returns:

the annotation

getTriggers

public Collection<LifeCycleHook> getTriggers(Type<?> cls,
                                             LifeCycleHookBinding.Operation op,
                                             LifeCycleHookBinding.TransactionPhase phase,
                                             String fieldName)

getTriggers

public Collection<LifeCycleHook> getTriggers(Type<?> cls,
                                             LifeCycleHookBinding.Operation op,
                                             LifeCycleHookBinding.TransactionPhase phase)

getAttributeOrRelationAnnotation

public <A extends Annotation> A getAttributeOrRelationAnnotation(Type<?> entityClass,
                                                                 Class<A> annotationClass,
                                                                 String identifier)

Return a single annotation from field or accessor method.

Type Parameters:

A - genericClass

Parameters:

entityClass - the entity class

annotationClass - given annotation type

identifier - the identifier

Returns:

annotation found

getAttributeOrRelationAnnotations

public <A extends Annotation> A[] getAttributeOrRelationAnnotations(Type<?> entityClass,
                                                                    Class<A> annotationClass,
                                                                    String identifier)

Return multiple annotations from field or accessor method.

Type Parameters:

A - the type parameter

Parameters:

entityClass - the entity class

annotationClass - given annotation type

identifier - the identifier

Returns:

annotation found or null if none found

getFirstAnnotation

public static Annotation getFirstAnnotation(Type<?> entityClass,
                                            List<Class<? extends Annotation>> annotationClassList)

Return first matching annotation from class, parents or package.

Parameters:

entityClass - Entity class type

annotationClassList - List of sought annotations

Returns:

annotation found

getFirstPackageAnnotation

public static Annotation getFirstPackageAnnotation(Type<?> entityClass,
                                                   List<Class<? extends Annotation>> annotationClassList)

Return first matching annotation from a package or parent package.

Parameters:

entityClass - Entity class type

annotationClassList - List of sought annotations

Returns:

annotation found

isRoot

public boolean isRoot(Type<?> entityClass)

Is root.

Parameters:

entityClass - the entity class

Returns:

the boolean

getId

public String getId(Object value)

Gets id.

Parameters:

value - the value

Returns:

the id

getIdType

public Type<?> getIdType(Type<?> entityClass)

Returns type of id field.

Parameters:

entityClass - the entity class

Returns:

ID type

getIdAnnotations

public Collection<Annotation> getIdAnnotations(Object value)

Returns annotations applied to the ID field.

Parameters:

value - the value

Returns:

Collection of Annotations

lookupEntityClass

public Type<?> lookupEntityClass(Type<?> objClass)

Follow for this class or super-class for JPA Entity annotation.

Parameters:

objClass - provided class

Returns:

class with Entity annotation

lookupIncludeClass

public Type<?> lookupIncludeClass(Type<?> objClass)

Follow for this class or super-class for Include annotation.

Parameters:

objClass - provided class

Returns:

class with Include annotation or

lookupAnnotationDeclarationClass

public static Type<?> lookupAnnotationDeclarationClass(Type<?> objClass,
                                                       Class<? extends Annotation> annotationClass)

Search a class hierarchy to find the first instance of a declared annotation.

Parameters:

objClass - The class to start searching.

annotationClass - The annotation to search for.

Returns:

The class which declares the annotation or null.

lookupBoundClass

public Type<?> lookupBoundClass(Type<?> objClass)

Return bound entity or null.

Parameters:

objClass - provided class

Returns:

Bound class.

isJPAEntity

public final boolean isJPAEntity(Type<?> objClass)

Check whether a class is a JPA entity.

Parameters:

objClass - class

Returns:

True if it is a JPA entity

getAccessibleObject

public AccessibleObject getAccessibleObject(Object target,
                                            String fieldName)

Retrieve the accessible object for a field from a target object.

Parameters:

target - the object to get

fieldName - the field name to get or invoke equivalent get method

Returns:

the value

isComputed

public boolean isComputed(Type<?> entityClass,
                          String fieldName)

getAccessibleObject

public AccessibleObject getAccessibleObject(Type<?> targetClass,
                                            String fieldName)

Retrieve the accessible object for a field.

Parameters:

targetClass - the object to get

fieldName - the field name to get or invoke equivalent get method

Returns:

the value

getFieldsOfType

public Set<String> getFieldsOfType(Type<?> targetClass,
                                   Type<?> targetType)

Retrieve fields from an object containing a particular type.

Parameters:

targetClass - Class to search for fields

targetType - Type of fields to find

Returns:

Set containing field names

isRelation

public boolean isRelation(Type<?> entityClass,
                          String relationName)

isAttribute

public boolean isAttribute(Type<?> entityClass,
                           String attributeName)

scanForSecurityChecks

public void scanForSecurityChecks()

Scan for security checks and automatically bind them to the dictionary.

addSecurityChecks

public void addSecurityChecks(Set<Class<?>> classes)

Add security checks and bind them to the dictionary.

Parameters:

classes - Security check classes.

addSecurityCheck

public void addSecurityCheck(Class<?> cls)

Add security checks and bind them to the dictionary.

Parameters:

cls - Security check class.

bindTrigger

public void bindTrigger(Class<?> entityClass,
                        String fieldOrMethodName,
                        LifeCycleHookBinding.Operation operation,
                        LifeCycleHookBinding.TransactionPhase phase,
                        LifeCycleHook hook)

Binds a lifecycle hook to a particular field or method in an entity. The hook will be called a single time per request per field READ, CREATE, or UPDATE.

Parameters:

entityClass - The entity that triggers the lifecycle hook.

fieldOrMethodName - The name of the field or method.

operation - CREATE, READ, or UPDATE

phase - PRESECURITY, PRECOMMIT, or POSTCOMMIT

hook - The callback to invoke.

bindTrigger

public void bindTrigger(Type<?> entityClass,
                        String fieldOrMethodName,
                        LifeCycleHookBinding.Operation operation,
                        LifeCycleHookBinding.TransactionPhase phase,
                        LifeCycleHook hook)

Binds a lifecycle hook to a particular field or method in an entity. The hook will be called a single time per request per field READ, CREATE, or UPDATE.

Parameters:

entityClass - The entity that triggers the lifecycle hook.

fieldOrMethodName - The name of the field or method.

operation - CREATE, READ, or UPDATE

phase - PRESECURITY, PRECOMMIT, or POSTCOMMIT

hook - The callback to invoke.

bindTrigger

public void bindTrigger(Class<?> entityClass,
                        LifeCycleHookBinding.Operation operation,
                        LifeCycleHookBinding.TransactionPhase phase,
                        LifeCycleHook hook,
                        boolean allowMultipleInvocations)

Binds a lifecycle hook to a particular entity class. The hook will either be called: - A single time single time per request per class READ, CREATE, UPDATE, or DELETE. - Multiple times per request per field READ, CREATE, or UPDATE. The behavior is determined by the value of the allowMultipleInvocations flag.

Parameters:

entityClass - The entity that triggers the lifecycle hook.

operation - CREATE, READ, or UPDATE

phase - PRESECURITY, PRECOMMIT, or POSTCOMMIT

hook - The callback to invoke.

allowMultipleInvocations - Should the same life cycle hook be invoked multiple times for multiple CRUD actions on the same model.

bindTrigger

public void bindTrigger(Type<?> entityClass,
                        LifeCycleHookBinding.Operation operation,
                        LifeCycleHookBinding.TransactionPhase phase,
                        LifeCycleHook hook,
                        boolean allowMultipleInvocations)

Binds a lifecycle hook to a particular entity class. The hook will either be called: - A single time single time per request per class READ, CREATE, UPDATE, or DELETE. - Multiple times per request per field READ, CREATE, or UPDATE. The behavior is determined by the value of the allowMultipleInvocations flag.

Parameters:

entityClass - The entity that triggers the lifecycle hook.

operation - CREATE, READ, or UPDATE

phase - PRESECURITY, PRECOMMIT, or POSTCOMMIT

hook - The callback to invoke.

allowMultipleInvocations - Should the same life cycle hook be invoked multiple times for multiple CRUD actions on the same model.

cascadeDeletes

public boolean cascadeDeletes(Type<?> targetClass,
                              String fieldName)

Returns true if the relationship cascades deletes and false otherwise.

Parameters:

targetClass - The class which owns the relationship.

fieldName - The relationship

Returns:

true or false

walkEntityGraph

public <T> List<T> walkEntityGraph(Set<Type<?>> entities,
                                   Function<Type<?>,T> transform)

Walks the entity graph and performs a transform function on each element.

Type Parameters:

T - The result type.

Parameters:

entities - The roots of the entity graph.

transform - The function to transform each entity class into a result.

Returns:

The collection of results.

hasBinding

public boolean hasBinding(Type<?> cls)

Returns whether or not a class is already bound.

Parameters:

cls - The class to verify.

Returns:

true if the class is bound. False otherwise.

getValue

public Object getValue(Object target,
                       String fieldName,
                       RequestScope scope)

Invoke the get[fieldName] method on the target object OR get the field with the corresponding name.

Parameters:

target - the object to get

fieldName - the field name to get or invoke equivalent get method

Returns:

the value

setId

public void setId(Object target,
                  String id)

Sets the ID field of a target object.

Parameters:

target - the object which owns the ID to set.

id - the value to set

setValue

public void setValue(Object target,
                     String fieldName,
                     Object value)

Invoke the set[fieldName] method on the target object OR set the field with the corresponding name.

Parameters:

target - The object which owns the field to set

fieldName - the field name to set or invoke equivalent set method

value - the value to set

coerce

public Object coerce(Object target,
                     Object value,
                     String fieldName,
                     Type<?> fieldType)

Coerce provided value into expected class type.

Parameters:

target - The model instance which owns the field being coerced.

value - The value being coerced.

fieldName - the field name in the owning model instance.

fieldType - expected class type

Returns:

coerced value

attributeOrRelationAnnotationExists

public <A extends Annotation> boolean attributeOrRelationAnnotationExists(Type<?> cls,
                                                                          String fieldName,
                                                                          Class<A> annotationClass)

Returns whether or not a specified annotation is present on an entity field or its corresponding method.

Type Parameters:

A - The type of the annotationClass

Parameters:

fieldName - The entity field

annotationClass - The provided annotation class

Returns:

true if the field is annotated by the annotationClass

isValidField

public boolean isValidField(Type<?> cls,
                            String fieldName)

Returns whether or not a specified field exists in an entity.

Parameters:

cls - The entity

fieldName - The provided field to check

Returns:

true if the field exists in the entity

addArgumentsToAttribute

public void addArgumentsToAttribute(Type<?> cls,
                                    String attributeName,
                                    Set<ArgumentType> arguments)

Add a collection of argument to the attributes.

Parameters:

cls - The entity

attributeName - attribute name to which argument has to be added

arguments - Set of Argument type containing name and type of each argument.

addArgumentToAttribute

public void addArgumentToAttribute(Type<?> cls,
                                   String attributeName,
                                   ArgumentType argument)

Add a single argument to the attribute.

Parameters:

cls - The entity

attributeName - attribute name to which argument has to be added

argument - A single argument

addArgumentToEntity

public void addArgumentToEntity(Type<?> cls,
                                ArgumentType argument)

Add a single argument to the Entity.

Parameters:

cls - The entity

argument - A single argument

getAttributeArguments

public Set<ArgumentType> getAttributeArguments(Type<?> cls,
                                               String attributeName)

Returns the Collection of all arguments of an attribute.

Parameters:

cls - The entity

attributeName - Name of the argument for ehich arguments are to be retrieved.

Returns:

A Set of ArgumentType for the given attribute.

getEntityArguments

public Set<ArgumentType> getEntityArguments(Type<?> cls)

Returns the Collection of all arguments of an entity.

Parameters:

cls - The entity

Returns:

A Set of ArgumentType for the given entity.

getAnnotatedColumnName

public String getAnnotatedColumnName(Type<?> cls,
                                     String fieldName)

Get column name using JPA.

Parameters:

cls - The entity class.

fieldName - The entity attribute.

Returns:

The jpa column name.

getModelVersion

public static String getModelVersion(Type<?> modelClass)

Returns the api version bound to a particular model class.

Parameters:

modelClass - The model class to lookup.

Returns:

The api version associated with the model or empty string if there is no association.

getEntityName

public static String getEntityName(Type<?> modelClass)

Looks up the API model name for a given class.

Parameters:

modelClass - The model class to lookup.

Returns:

the API name for the model class.

getType

public static <T> Type<T> getType(T object)

bindLegacyHooks

public void bindLegacyHooks(EntityBinding binding)