uk.gov.gchq.gaffer.federatedstore

Class FederatedAccess

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.FederatedAccess

All Implemented Interfaces:

Serializable, AccessControlledResource

public class FederatedAccess
extends Object
implements AccessControlledResource, Serializable

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 and Description
FederatedAccess(Set<String> graphAuths, String addingUserId)
FederatedAccess(Set<String> graphAuths, String addingUserId, boolean isPublic)
FederatedAccess(Set<String> graphAuths, String addingUserId, boolean isPublic, boolean disabledByDefault)
FederatedAccess(Set<String> graphAuths, String addingUserId, boolean isPublic, boolean disabledByDefault, AccessPredicate readAccessPredicate, AccessPredicate writeAccessPredicate)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAddingUserId()
Set<String>	getGraphAuths()
AccessPredicate	getOrDefaultReadAccessPredicate()
AccessPredicate	getOrDefaultWriteAccessPredicate()
AccessPredicate	getReadAccessPredicate()
ResourceType	getResourceType()
AccessPredicate	getWriteAccessPredicate()
int	hashCode()
boolean	hasReadAccess(User user, String adminAuth)
boolean	hasWriteAccess(User user, String adminAuth)
boolean	isDisabledByDefault()
boolean	isPublic()
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 addingUserId)

FederatedAccess

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

FederatedAccess

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

FederatedAccess

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

Method Detail

getGraphAuths

public Set<String> getGraphAuths()

getAddingUserId

public String getAddingUserId()

isPublic

public boolean isPublic()

isDisabledByDefault

public boolean isDisabledByDefault()

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

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()