Package uk.gov.gchq.gaffer.federatedstore

Class FederatedGraphStorage

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.FederatedGraphStorage

public class FederatedGraphStorage
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACCESS_IS_NULL
static String	ERROR_ADDING_GRAPH_TO_CACHE
static String	GRAPH_IDS_NOT_VISIBLE
static String	USER_IS_ATTEMPTING_TO_OVERWRITE

Constructor Summary

Constructors

Constructor	Description
FederatedGraphStorage(String suffixFederatedStoreCacheName)

Method Summary

Modifier and Type	Method	Description
boolean	changeGraphAccess(String graphId, FederatedAccess newFederatedAccess, User requestingUser)
boolean	changeGraphAccess(String graphId, FederatedAccess newFederatedAccess, User requestingUser, String adminAuth)
boolean	changeGraphId(String graphId, String newGraphId, User requestingUser)
boolean	changeGraphId(String graphId, String newGraphId, User requestingUser, String adminAuth)
Collection<GraphSerialisable>	get(User user, List<String> graphIds)	returns all graphs objects matching the given graphIds, that is visible to the user.
List<GraphSerialisable>	get(User user, List<String> graphIds, String adminAuth)	returns all graphs objects matching the given graphIds, that is visible to the user.
Collection<GraphSerialisable>	getAll(User user)	Returns all graph object that are visible for the given user.
List<String>	getAllIds(User user)	Returns all the graphIds that are visible for the given user.
List<String>	getAllIds(User user, String adminAuth)
void	put(Collection<GraphSerialisable> graphs, FederatedAccess access)	places a collections of graphs into storage, protected by the given access.
void	put(GraphSerialisable graph, FederatedAccess access)	places a graph into storage, protected by the given access.
boolean	remove(String graphId, User user, boolean removeCache)	Removes a graph from storage and returns the success.
void	setGraphLibrary(GraphLibrary graphLibrary)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_ADDING_GRAPH_TO_CACHE

public static final String ERROR_ADDING_GRAPH_TO_CACHE

See Also:

Constant Field Values

USER_IS_ATTEMPTING_TO_OVERWRITE

public static final String USER_IS_ATTEMPTING_TO_OVERWRITE

See Also:

Constant Field Values

ACCESS_IS_NULL

public static final String ACCESS_IS_NULL

See Also:

Constant Field Values

GRAPH_IDS_NOT_VISIBLE

public static final String GRAPH_IDS_NOT_VISIBLE

See Also:

Constant Field Values

Constructor Detail

FederatedGraphStorage

public FederatedGraphStorage(String suffixFederatedStoreCacheName)

Method Detail

put

public void put(Collection<GraphSerialisable> graphs,
                FederatedAccess access)
         throws StorageException

places a collections of graphs into storage, protected by the given access.

Parameters:

graphs - the graphs to add to the storage.

access - access required to for the graphs, can't be null

Throws:

StorageException - if unable to put arguments into storage

See Also:

put(GraphSerialisable, FederatedAccess)

put

public void put(GraphSerialisable graph,
                FederatedAccess access)
         throws StorageException

places a graph into storage, protected by the given access.

GraphId can't already exist, otherwise OverwritingException is thrown.

Access can't be null otherwise IllegalArgumentException is thrown

Parameters:

graph - the graph to add to the storage.

access - access required to for the graph.

Throws:

StorageException - if unable to put arguments into storage

getAllIds

public List<String> getAllIds(User user)

Returns all the graphIds that are visible for the given user.

Parameters:

user - to match visibility against.

Returns:

visible graphIds.

getAllIds

public List<String> getAllIds(User user,
                              String adminAuth)

getAll

public Collection<GraphSerialisable> getAll(User user)

Returns all graph object that are visible for the given user.

Parameters:

user - to match visibility against.

Returns:

visible graphs

remove

public boolean remove(String graphId,
                      User user,
                      boolean removeCache)

Removes a graph from storage and returns the success. The given user must have visibility of the graph to be able to remove it.

Parameters:

graphId - the graphId to remove.

user - to match visibility against.

removeCache - to remove associated caches with this graph.

Returns:

if a graph was removed.

See Also:

isValidToView(User, FederatedAccess)

get

public Collection<GraphSerialisable> get(User user,
                                         List<String> graphIds)

returns all graphs objects matching the given graphIds, that is visible to the user.

Parameters:

user - to match visibility against.

graphIds - the graphIds to get graphs for.

Returns:

visible graphs from the given graphIds.

get

public List<GraphSerialisable> get(User user,
                                   List<String> graphIds,
                                   String adminAuth)

returns all graphs objects matching the given graphIds, that is visible to the user.

Parameters:

user - to match visibility against.

graphIds - the graphIds to get graphs for. List is used because it preserves order.

adminAuth - adminAuths role

Returns:

visible graphs from the given graphIds.

setGraphLibrary

public void setGraphLibrary(GraphLibrary graphLibrary)

changeGraphAccess

public boolean changeGraphAccess(String graphId,
                                 FederatedAccess newFederatedAccess,
                                 User requestingUser)
                          throws StorageException

Throws:

StorageException

changeGraphAccess

public boolean changeGraphAccess(String graphId,
                                 FederatedAccess newFederatedAccess,
                                 User requestingUser,
                                 String adminAuth)
                          throws StorageException

Throws:

StorageException

changeGraphId

public boolean changeGraphId(String graphId,
                             String newGraphId,
                             User requestingUser)
                      throws StorageException

Throws:

StorageException

changeGraphId

public boolean changeGraphId(String graphId,
                             String newGraphId,
                             User requestingUser,
                             String adminAuth)
                      throws StorageException

Throws:

StorageException