Package uk.gov.gchq.gaffer.federatedstore

Class FederatedAccess

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.FederatedAccess

All Implemented Interfaces:

AccessControlledResource

public class FederatedAccess
extends Object
implements AccessControlledResource

Conditions required for a User to have access to a graph within the FederatedStore via FederatedAccess

FederatedAccess truth table

User Ops	AccessHook Ops	User added graph	hasAccess?
'A'	'A'	n/a	T
'A','B'	'A'	n/a	T
'A'	'A','B'	n/a	T
'A'	'B'	F	F
'A'	'B'	T	T
n/a	null	T	T
n/a	null	F	F
n/a	empty	T	T
n/a	empty	F	F

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FederatedAccess.Builder

Field Summary

Fields inherited from interface uk.gov.gchq.gaffer.access.AccessControlledResource

DONT_CHECK_ADMIN_AUTH

Constructor Summary

Constructors

Constructor	Description
FederatedAccess(Set<String> graphAuths, String owningUserId)
FederatedAccess(Set<String> graphAuths, String owningUserId, boolean isPublic)
FederatedAccess(Set<String> graphAuths, String owningUserId, boolean isPublic, AccessPredicate readAccessPredicate, AccessPredicate writeAccessPredicate)

Method Summary

Modifier and Type	Method	Description
static AccessPredicate	deserialisePredicate(String predicateJson)
boolean	equals(Object o)
Set<String>	getGraphAuths()
AccessPredicate	getOrDefaultReadAccessPredicate()
AccessPredicate	getOrDefaultWriteAccessPredicate()
String	getOwningUserId()
AccessPredicate	getReadAccessPredicate()
ResourceType	getResourceType()
AccessPredicate	getWriteAccessPredicate()
int	hashCode()
boolean	hasReadAccess(User user, String adminAuth)
boolean	hasWriteAccess(User user, String adminAuth)
boolean	isPublic()
static String	serialisePredicate(AccessPredicate accessPredicate)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.gov.gchq.gaffer.access.AccessControlledResource

hasReadAccess, hasWriteAccess

Constructor Detail

FederatedAccess

public FederatedAccess(Set<String> graphAuths,
                       String owningUserId)

FederatedAccess

public FederatedAccess(Set<String> graphAuths,
                       String owningUserId,
                       boolean isPublic)

FederatedAccess

public FederatedAccess(Set<String> graphAuths,
                       String owningUserId,
                       boolean isPublic,
                       AccessPredicate readAccessPredicate,
                       AccessPredicate writeAccessPredicate)

Method Detail

getGraphAuths

public Set<String> getGraphAuths()

getOwningUserId

public String getOwningUserId()

isPublic

public boolean isPublic()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in interface AccessControlledResource

hasReadAccess

public boolean hasReadAccess(User user,
                             String adminAuth)

Specified by:

hasReadAccess in interface AccessControlledResource

hasWriteAccess

public boolean hasWriteAccess(User user,
                              String adminAuth)

Specified by:

hasWriteAccess in interface AccessControlledResource

deserialisePredicate

public static AccessPredicate deserialisePredicate(String predicateJson)

serialisePredicate

public static String serialisePredicate(AccessPredicate accessPredicate)

toString

public String toString()

Overrides:

toString in class Object

getReadAccessPredicate

public AccessPredicate getReadAccessPredicate()

getWriteAccessPredicate

public AccessPredicate getWriteAccessPredicate()

getOrDefaultReadAccessPredicate

public AccessPredicate getOrDefaultReadAccessPredicate()

getOrDefaultWriteAccessPredicate

public AccessPredicate getOrDefaultWriteAccessPredicate()