com.redhat.lightblue.eval

Class FieldAccessRoleEvaluator

java.lang.Object

com.redhat.lightblue.eval.FieldAccessRoleEvaluator

public final class FieldAccessRoleEvaluator
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldAccessRoleEvaluator.Operation

Constructor Summary

Constructors

Constructor and Description
FieldAccessRoleEvaluator(EntityMetadata md, Set<String> callerRoles)

Method Summary

Methods

Modifier and Type	Method and Description
Projection	getExcludedFields(FieldAccessRoleEvaluator.Operation op) Returns a projection that excludes the fields the caller does not have access to based on the operation
List<Path>	getInaccessibleFields_Insert(JsonDoc doc) Returns a list of fields in the doc inaccessible to the current user during insertion.
List<Path>	getInaccessibleFields_Update(JsonDoc newDoc, JsonDoc oldDoc) Returns a list of fields in the doc inaccessible to the current user during update.
Set<Path>	getInaccessibleFields(FieldAccessRoleEvaluator.Operation op) Returns a set of fields that are inaccessible to the user for the given operation
boolean	hasAccess(Path field, FieldAccessRoleEvaluator.Operation op) Returns whether the current caller has access to the given field based on the operation
boolean	hasAccess(Set<Path> fields, FieldAccessRoleEvaluator.Operation op) Returns whether the current caller has access to all the given fields based on the operation

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldAccessRoleEvaluator

public FieldAccessRoleEvaluator(EntityMetadata md,
                        Set<String> callerRoles)

Method Detail

hasAccess

public boolean hasAccess(Set<Path> fields,
                FieldAccessRoleEvaluator.Operation op)

Returns whether the current caller has access to all the given fields based on the operation

hasAccess

public boolean hasAccess(Path field,
                FieldAccessRoleEvaluator.Operation op)

Returns whether the current caller has access to the given field based on the operation

getInaccessibleFields

public Set<Path> getInaccessibleFields(FieldAccessRoleEvaluator.Operation op)

Returns a set of fields that are inaccessible to the user for the given operation

getInaccessibleFields_Insert

public List<Path> getInaccessibleFields_Insert(JsonDoc doc)

Returns a list of fields in the doc inaccessible to the current user during insertion. If the returned list is empty, the user can insert the doc.

getInaccessibleFields_Update

public List<Path> getInaccessibleFields_Update(JsonDoc newDoc,
                                      JsonDoc oldDoc)

Returns a list of fields in the doc inaccessible to the current user during update.

Parameters:

newDoc - The new version of the document

oldDoc - The old version of the document

getExcludedFields

public Projection getExcludedFields(FieldAccessRoleEvaluator.Operation op)

Returns a projection that excludes the fields the caller does not have access to based on the operation