Skip navigation links
Grakn
A B C D E F G H I J K L M N O P Q R S T U V W 

A

addTask(TaskState, TaskConfiguration) - Method in class ai.grakn.engine.tasks.BackgroundTask
Submit a new task for execution
addTask(TaskState, TaskConfiguration) - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskManager
 
addTask(TaskState, TaskConfiguration) - Method in class ai.grakn.engine.tasks.manager.StandaloneTaskManager
 
addTask(TaskState, TaskConfiguration) - Method in interface ai.grakn.engine.tasks.manager.TaskSubmitter
Schedule a BackgroundTask for execution.
addUser(Json) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
Add a new user.
addUser(Json) - Method in class ai.grakn.engine.user.UsersHandler
 
adjustCount(String, long) - Method in class ai.grakn.engine.tasks.connection.RedisCountStorage
Adjusts the count for a specific key.
ADMIN_PASSWORD_PROPERTY - Static variable in class ai.grakn.engine.GraknEngineConfig
 
ai.grakn.engine - package ai.grakn.engine
Implements the REST controllers, task management and post processing features.
ai.grakn.engine.controller - package ai.grakn.engine.controller
Implementation of Grakn server REST endpoints.
ai.grakn.engine.controller.util - package ai.grakn.engine.controller.util
 
ai.grakn.engine.factory - package ai.grakn.engine.factory
 
ai.grakn.engine.loader - package ai.grakn.engine.loader
Implements MutatorTask.
ai.grakn.engine.lock - package ai.grakn.engine.lock
 
ai.grakn.engine.postprocessing - package ai.grakn.engine.postprocessing
 
ai.grakn.engine.session - package ai.grakn.engine.session
Severside websocket implementation.
ai.grakn.engine.tasks - package ai.grakn.engine.tasks
 
ai.grakn.engine.tasks.connection - package ai.grakn.engine.tasks.connection
 
ai.grakn.engine.tasks.manager - package ai.grakn.engine.tasks.manager
 
ai.grakn.engine.tasks.manager.redisqueue - package ai.grakn.engine.tasks.manager.redisqueue
 
ai.grakn.engine.tasks.mock - package ai.grakn.engine.tasks.mock
 
ai.grakn.engine.user - package ai.grakn.engine.user
Implements graph user management.
ai.grakn.engine.util - package ai.grakn.engine.util
Implementation of internal engine utilities.
allUsers(int, int) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
Retrieve the list of all users with all their properties.
allUsers(int, int) - Method in class ai.grakn.engine.user.UsersHandler
 
at(Instant) - Static method in class ai.grakn.engine.tasks.manager.TaskSchedule
Create a schedule to run a task at a specified instant.
AuthController - Class in ai.grakn.engine.controller
Endpoints used to handle operations related to authentication.
AuthController(Service, boolean, JWTHandler, UsersHandler) - Constructor for class ai.grakn.engine.controller.AuthController
 

B

BackgroundTask - Class in ai.grakn.engine.tasks
Interface which all tasks that wish to be scheduled for later execution as background tasks must implement.
BackgroundTask() - Constructor for class ai.grakn.engine.tasks.BackgroundTask
 

C

cancelled - Variable in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
cancelledTasks() - Static method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
checkpoint() - Method in class ai.grakn.engine.tasks.manager.TaskCheckpoint
 
checkpoint(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.manager.TaskState
 
checkpoint() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
clearTasks() - Static method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
clone() - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
 
close() - Method in class ai.grakn.engine.GraknEngineServer
 
close() - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskManager
 
close() - Method in class ai.grakn.engine.tasks.manager.StandaloneTaskManager
 
CommitLogController - Class in ai.grakn.engine.controller
A controller which core submits commit logs to so we can post-process jobs for cleanup.
CommitLogController(Service, String, int, TaskManager) - Constructor for class ai.grakn.engine.controller.CommitLogController
 
completedTasks() - Static method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
ConceptController - Class in ai.grakn.engine.controller
Endpoints used to query the graph by concept type or identifier
ConceptController(EngineGraknGraphFactory, Service, MetricRegistry) - Constructor for class ai.grakn.engine.controller.ConceptController
 
configuration() - Method in class ai.grakn.engine.tasks.BackgroundTask
Get the configuration needed to execute the task
configuration() - Method in class ai.grakn.engine.tasks.manager.TaskConfiguration
 
configureSpark(Service, GraknEngineConfig, JWTHandler) - Static method in class ai.grakn.engine.GraknEngineServer
 
configureSpark(Service, String, int, String, boolean, JWTHandler) - Static method in class ai.grakn.engine.GraknEngineServer
 
containsKeyspace(String) - Method in class ai.grakn.engine.SystemKeyspace
Checks if the keyspace exists in the system.
containsTask(TaskId) - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskStorage
 
containsTask(TaskId) - Method in class ai.grakn.engine.tasks.manager.TaskStateInMemoryStore
 
containsTask(TaskId) - Method in interface ai.grakn.engine.tasks.manager.TaskStateStorage
Returns whether the storage contains the given task
copy() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
create(Properties) - Static method in class ai.grakn.engine.factory.EngineGraknGraphFactory
 
create() - Static method in class ai.grakn.engine.GraknEngineConfig
 
create() - Static method in class ai.grakn.engine.session.RemoteSession
 
create(Pool<Jedis>) - Static method in class ai.grakn.engine.tasks.connection.RedisCountStorage
 
create(Pool<Jedis>, MetricRegistry) - Static method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskStorage
 
create(String, EngineGraknGraphFactory) - Static method in class ai.grakn.engine.user.UsersHandler
 
create(String) - Static method in class ai.grakn.engine.util.JWTHandler
 
createAndLoadSystemOntology(Properties) - Static method in class ai.grakn.engine.factory.EngineGraknGraphFactory
 
createConfig(String, String) - Static method in class ai.grakn.engine.postprocessing.PostProcessingTask
Helper method which creates the task config needed in order to execute a PP task
createConfig(String, String) - Static method in class ai.grakn.engine.postprocessing.UpdatingInstanceCountTask
Helper method which creates the task config needed in order to execute the updating count task
createdAt() - Method in class ai.grakn.engine.tasks.manager.TaskCheckpoint
 
createTask(Class, int) - Static method in class ai.grakn.engine.postprocessing.PostProcessingTask
Helper method which creates PP Task States.
createTask(Class) - Static method in class ai.grakn.engine.postprocessing.UpdatingInstanceCountTask
Helper method which creates PP Task States.
creator() - Method in class ai.grakn.engine.tasks.manager.TaskState
 

D

DashboardController - Class in ai.grakn.engine.controller
Private endpoints used by dashboard to query by concept type.
DashboardController(EngineGraknGraphFactory, Service) - Constructor for class ai.grakn.engine.controller.DashboardController
 
DEFAULT_CONFIG_FILE - Static variable in class ai.grakn.engine.GraknEngineConfig
 
DEFAULT_KEYSPACE_PROPERTY - Static variable in class ai.grakn.engine.GraknEngineConfig
 
DELETE_UNATTACHED_CONFIG - Static variable in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask
 
DELETE_UNATTACHED_DEFAULT - Static variable in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask
 
deleteKeyspace(String) - Method in class ai.grakn.engine.SystemKeyspace
This is called when a graph is deleted via GraknAdmin.delete().
deleteUnattached(boolean) - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
Specify whether resources that are not associated with any entity or relationship should be deleted from the database.
deleteUnattached() - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
Return true if this job will delete unattached resources and false otherwise.
doStage(MapReduce.Stage) - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
We skip the combine stage and do only MAP and REDUCE.

E

EndlessExecutionMockTask - Class in ai.grakn.engine.tasks.mock
Mocked task that will never end
EndlessExecutionMockTask() - Constructor for class ai.grakn.engine.tasks.mock.EndlessExecutionMockTask
 
engineConfiguration() - Method in class ai.grakn.engine.tasks.BackgroundTask
 
EngineGraknGraphFactory - Class in ai.grakn.engine.factory
Engine's internal Graph Factory
engineID() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
EngineID - Class in ai.grakn.engine.util
Assigns a random ID to the current instance of Engine.
ensureKeyspaceInitialised(String) - Method in class ai.grakn.engine.SystemKeyspace
Notify that we just opened a keyspace with the same engineUrl & config.
equals(Object) - Method in class ai.grakn.engine.tasks.manager.TaskCheckpoint
 
equals(Object) - Method in class ai.grakn.engine.tasks.manager.TaskConfiguration
 
equals(Object) - Method in class ai.grakn.engine.util.EngineID
 
exception() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
ExceptionWrapper - Class in ai.grakn.engine.util
Utility class to execute a Runnable and log any exceptions thrown without propagating them further.
ExceptionWrapper() - Constructor for class ai.grakn.engine.util.ExceptionWrapper
 
ExceptionWrapper.RunnableWithExceptions<E extends Exception> - Interface in ai.grakn.engine.util
Function interface that throws exception for use in the noThrow function
executeResumeInner(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.mock.EndlessExecutionMockTask
 
executeResumeInner(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.mock.FailingMockTask
 
executeResumeInner(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.mock.LongExecutionMockTask
 
executeResumeInner(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
executeResumeInner(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.mock.ShortExecutionMockTask
 
executeStartInner(TaskId) - Method in class ai.grakn.engine.tasks.mock.EndlessExecutionMockTask
 
executeStartInner(TaskId) - Method in class ai.grakn.engine.tasks.mock.FailingMockTask
 
executeStartInner(TaskId) - Method in class ai.grakn.engine.tasks.mock.LongExecutionMockTask
 
executeStartInner(TaskId) - Method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
executeStartInner(TaskId) - Method in class ai.grakn.engine.tasks.mock.ShortExecutionMockTask
 
extractUserFromJWT(String) - Method in class ai.grakn.engine.util.JWTHandler
 

F

factory() - Method in class ai.grakn.engine.GraknEngineServer
 
factory() - Method in class ai.grakn.engine.tasks.BackgroundTask
 
FACTORY_ANALYTICS - Static variable in class ai.grakn.engine.GraknEngineConfig
 
FACTORY_INTERNAL - Static variable in class ai.grakn.engine.GraknEngineConfig
 
FailingMockTask - Class in ai.grakn.engine.tasks.mock
Mocked task that will throw exception
FailingMockTask() - Constructor for class ai.grakn.engine.tasks.mock.FailingMockTask
 

G

generateFinalResult(Iterator<KeyValue<String, Long>>) - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
 
getAvailableThreads() - Method in class ai.grakn.engine.GraknEngineConfig
 
getBytes(String) - Static method in class ai.grakn.engine.user.Password
 
getConfigFilePath() - Static method in class ai.grakn.engine.GraknEngineConfig
 
getConfiguration() - Method in class ai.grakn.engine.tasks.manager.TaskConfiguration
 
getCount(String) - Method in class ai.grakn.engine.tasks.connection.RedisCountStorage
Gets the count for the specified key.
getCreator() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
getEngineID() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
getGraph(String, GraknTxType) - Method in class ai.grakn.engine.factory.EngineGraknGraphFactory
 
getId() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
getInterval() - Method in class ai.grakn.engine.tasks.manager.TaskSchedule
 
getKeyNumInstances(String, ConceptId) - Static method in class ai.grakn.engine.tasks.connection.RedisCountStorage
All the valid keys which map to values in the redis cache
getKeyNumShards(String, ConceptId) - Static method in class ai.grakn.engine.tasks.connection.RedisCountStorage
 
getLock(String) - Method in interface ai.grakn.engine.lock.LockProvider
 
getLock(String) - Method in class ai.grakn.engine.lock.ProcessWideLockProvider
 
getLock(String) - Method in class ai.grakn.engine.lock.RedissonLockProvider
 
getLockProvider() - Method in class ai.grakn.engine.tasks.BackgroundTask
 
getMemoryKey() - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
 
getPath(String) - Method in class ai.grakn.engine.GraknEngineConfig
 
getPriority() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
getProperties() - Method in class ai.grakn.engine.GraknEngineConfig
 
getProperty(String) - Method in class ai.grakn.engine.GraknEngineConfig
 
getPropertyAsBool(String, boolean) - Method in class ai.grakn.engine.GraknEngineConfig
 
getPropertyAsInt(String) - Method in class ai.grakn.engine.GraknEngineConfig
 
getPropertyAsLong(String) - Method in class ai.grakn.engine.GraknEngineConfig
 
getQueue() - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskManager
 
getRunAt() - Method in class ai.grakn.engine.tasks.manager.TaskSchedule
 
getSchedule() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
getSerialVersionUID() - Static method in class ai.grakn.engine.tasks.manager.TaskState
 
getState(TaskId) - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskStorage
 
getState(TaskId) - Method in class ai.grakn.engine.tasks.manager.TaskStateInMemoryStore
 
getState(TaskId) - Method in interface ai.grakn.engine.tasks.manager.TaskStateStorage
This is a copy of the internal TaskState object.
getStatus() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
getTaskCheckpoint() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
getTaskClassName() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
getTaskManager() - Method in class ai.grakn.engine.GraknEngineServer
 
getTasks(TaskStatus, String, String, EngineID, int, int) - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskStorage
 
getTasks(TaskStatus, String, String, EngineID, int, int) - Method in class ai.grakn.engine.tasks.manager.TaskStateInMemoryStore
 
getTasks(TaskStatus, String, String, EngineID, int, int) - Method in interface ai.grakn.engine.tasks.manager.TaskStateStorage
Return a Set of Pairs of tasks that match any of the criteria.
getUser(String) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
Return the user with the specified name as a JSON object where the properties have the same names as the Grakn resource types.
getUser(String) - Method in class ai.grakn.engine.user.UsersHandler
 
GRAKN_VERSION_KEY - Static variable in class ai.grakn.engine.GraknEngineConfig
 
GraknEngineConfig - Class in ai.grakn.engine
Singleton class used to read config file and make all the settings available to the Grakn Engine classes.
GraknEngineServer - Class in ai.grakn.engine
Main class in charge to start a web server and all the REST controllers.
GraknEngineServer(GraknEngineConfig) - Constructor for class ai.grakn.engine.GraknEngineServer
 
GraphMutators - Class in ai.grakn.engine.postprocessing
Abstract class containing utilities for graph mutations
GraphMutators() - Constructor for class ai.grakn.engine.postprocessing.GraphMutators
 
GraqlController - Class in ai.grakn.engine.controller
Endpoints used to query the graph using Graql and build a HAL, Graql or Json response.
GraqlController(EngineGraknGraphFactory, Service, MetricRegistry) - Constructor for class ai.grakn.engine.controller.GraqlController
 

H

hash(char[], byte[]) - Static method in class ai.grakn.engine.user.Password
Returns a salted and hashed password using the provided hash.
Note - side effect: the password is destroyed (the char[] is filled with zeros)
hashCode() - Method in class ai.grakn.engine.tasks.manager.TaskCheckpoint
 
hashCode() - Method in class ai.grakn.engine.tasks.manager.TaskConfiguration
 
hashCode() - Method in class ai.grakn.engine.util.EngineID
 

I

incrementByInterval() - Method in class ai.grakn.engine.tasks.manager.TaskSchedule
Returns a copy of this Schedule that will start a task after the given interval
initialize(Consumer<TaskCheckpoint>, TaskConfiguration, TaskSubmitter, GraknEngineConfig, RedisCountStorage, EngineGraknGraphFactory, LockProvider, MetricRegistry) - Method in class ai.grakn.engine.tasks.BackgroundTask
Initialize the BackgroundTask.
interval() - Method in class ai.grakn.engine.tasks.manager.TaskSchedule
Get the interval that the task should recur, if it is a recurring task.
isExpectedPassword(char[], byte[], byte[]) - Static method in class ai.grakn.engine.user.Password
Returns true if the given password and salt match the hashed value, false otherwise.
Note - side effect: the password is destroyed (the char[] is filled with zeros)
isRecurring() - Method in class ai.grakn.engine.tasks.manager.TaskSchedule
Get whether the task is a recurring task.

J

Job() - Constructor for class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
 
JSON - Static variable in class ai.grakn.engine.controller.SystemController
 
json() - Method in class ai.grakn.engine.tasks.manager.TaskConfiguration
 
JWT_SECRET_PROPERTY - Static variable in class ai.grakn.engine.GraknEngineConfig
 
JWTHandler - Class in ai.grakn.engine.util
Retrieves and verifies user data using JWT

K

keyspace(String) - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
Specify the keyspace to use for the deduplication job.
KEYSPACE_CONFIG - Static variable in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask
 
KEYSPACE_DEFAULT - Static variable in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask
 
KEYSPACE_ENTITY - Static variable in class ai.grakn.engine.SystemKeyspace
 
KEYSPACE_RESOURCE - Static variable in class ai.grakn.engine.SystemKeyspace
 

L

LOADER_REPEAT_COMMITS - Static variable in class ai.grakn.engine.GraknEngineConfig
 
loadSystemOntology() - Method in class ai.grakn.engine.SystemKeyspace
Load the system ontology into a newly created system keyspace.
lock() - Method in class ai.grakn.engine.lock.NonReentrantLock
 
lockInterruptibly() - Method in class ai.grakn.engine.lock.NonReentrantLock
 
LockProvider - Interface in ai.grakn.engine.lock
Distributed lock interface
LongExecutionMockTask - Class in ai.grakn.engine.tasks.mock
Mock task that will run for 10 ms
LongExecutionMockTask() - Constructor for class ai.grakn.engine.tasks.mock.LongExecutionMockTask
 

M

main(String[]) - Static method in class ai.grakn.engine.GraknEngineServer
 
mandatoryBody(Request) - Static method in class ai.grakn.engine.controller.util.Requests
Given a {@link Request), retreive the value of the request body.
mandatoryQueryParameter(Request, String) - Static method in class ai.grakn.engine.controller.util.Requests
Given a Request object retrieve the value of the argument.
mandatoryQueryParameter(Function<String, Optional<T>>, String) - Static method in class ai.grakn.engine.controller.util.Requests
Given a Function, retrieve the value of the by applying that function
map(Vertex, MapReduce.MapEmitter<String, ConceptId>) - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
Emit the resoucre index (value + type) mapped to the concept ID of the resource instance.
markCompleted() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
markFailed(Throwable) - Method in class ai.grakn.engine.tasks.manager.TaskState
 
markRunning(EngineID) - Method in class ai.grakn.engine.tasks.manager.TaskState
 
markScheduled() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
markStopped() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
me() - Static method in class ai.grakn.engine.util.EngineID
 
metricRegistry() - Method in class ai.grakn.engine.tasks.BackgroundTask
 
MockBackgroundTask - Class in ai.grakn.engine.tasks.mock
Main task Mock class- keeps track of completed and failed tasks
MockBackgroundTask() - Constructor for class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
MutatorTask - Class in ai.grakn.engine.loader
Task that will mutate data in a graph.
MutatorTask() - Constructor for class ai.grakn.engine.loader.MutatorTask
 

N

newCondition() - Method in class ai.grakn.engine.lock.NonReentrantLock
 
newState(TaskState) - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskStorage
 
newState(TaskState) - Method in class ai.grakn.engine.tasks.manager.TaskStateInMemoryStore
 
newState(TaskState) - Method in interface ai.grakn.engine.tasks.manager.TaskStateStorage
Create a new task state and store it, returning an ID to later access this task state.
NonReentrantLock - Class in ai.grakn.engine.lock
A non-reentrant lock
NonReentrantLock() - Constructor for class ai.grakn.engine.lock.NonReentrantLock
 
noThrow(ExceptionWrapper.RunnableWithExceptions, String) - Static method in class ai.grakn.engine.util.ExceptionWrapper
 
now() - Static method in class ai.grakn.engine.tasks.manager.TaskSchedule
Create a schedule to run a task now.
NUM_THREADS_PROPERTY - Static variable in class ai.grakn.engine.GraknEngineConfig
 

O

of(Json) - Static method in class ai.grakn.engine.tasks.manager.TaskCheckpoint
 
of(Json) - Static method in class ai.grakn.engine.tasks.manager.TaskConfiguration
 
of(Class<?>, String, TaskSchedule, TaskState.Priority) - Static method in class ai.grakn.engine.tasks.manager.TaskState
 
of(TaskId) - Static method in class ai.grakn.engine.tasks.manager.TaskState
 
of(String) - Static method in class ai.grakn.engine.util.EngineID
 
onWebSocketClose(int, String) - Method in class ai.grakn.engine.session.RemoteSession
 
onWebSocketText(String) - Method in class ai.grakn.engine.session.RemoteSession
 

P

Password - Class in ai.grakn.engine.user
A utility class for hashing user passwords
PASSWORD_PROTECTED_PROPERTY - Static variable in class ai.grakn.engine.GraknEngineConfig
 
passwordProtected(UsersHandler) - Static method in class ai.grakn.engine.session.RemoteSession
 
pause() - Method in class ai.grakn.engine.tasks.BackgroundTask
Called to suspend the execution of a currently running task.
POST_PROCESSING_TASK_DELAY - Static variable in class ai.grakn.engine.GraknEngineConfig
 
PostProcessingTask - Class in ai.grakn.engine.postprocessing
Task that control when postprocessing starts.
PostProcessingTask() - Constructor for class ai.grakn.engine.postprocessing.PostProcessingTask
 
priority() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
ProcessWideLockProvider - Class in ai.grakn.engine.lock
Simple locking meachanism that can be used in case of single engine execution
ProcessWideLockProvider() - Constructor for class ai.grakn.engine.lock.ProcessWideLockProvider
 
properties() - Method in class ai.grakn.engine.factory.EngineGraknGraphFactory
 

Q

queryParameter(Request, String) - Static method in class ai.grakn.engine.controller.util.Requests
Given a Request, retrieve the value of the
queue() - Method in enum ai.grakn.engine.tasks.manager.TaskState.Priority
 

R

read(String) - Static method in class ai.grakn.engine.GraknEngineConfig
 
recurring(Duration) - Static method in class ai.grakn.engine.tasks.manager.TaskSchedule
Create a schedule to run a task that recurs on an interval.
recurring(Instant, Duration) - Static method in class ai.grakn.engine.tasks.manager.TaskSchedule
Create a schedule to run a task that recurs on an interval, starting at the specified instance.
redis() - Method in class ai.grakn.engine.tasks.BackgroundTask
 
REDIS_SENTINEL_MASTER - Static variable in class ai.grakn.engine.GraknEngineConfig
 
REDIS_SERVER_PORT - Static variable in class ai.grakn.engine.GraknEngineConfig
 
REDIS_SERVER_URL - Static variable in class ai.grakn.engine.GraknEngineConfig
 
RedisCountStorage - Class in ai.grakn.engine.tasks.connection
Connection To Redis Server
RedisInflightTaskConsumer - Class in ai.grakn.engine.tasks.manager.redisqueue
Consumer from a redis queue
RedisInflightTaskConsumer(Pool<Jedis>, Duration, Config, String) - Constructor for class ai.grakn.engine.tasks.manager.redisqueue.RedisInflightTaskConsumer
 
RedissonLockProvider - Class in ai.grakn.engine.lock
Proxy for Redisson lock
RedissonLockProvider(RedissonClient) - Constructor for class ai.grakn.engine.lock.RedissonLockProvider
 
RedisTaskManager - Class in ai.grakn.engine.tasks.manager.redisqueue
Handle the lifecycle of tasks in Redis.
RedisTaskManager(EngineID, GraknEngineConfig, Pool<Jedis>, EngineGraknGraphFactory, LockProvider, MetricRegistry) - Constructor for class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskManager
 
RedisTaskManager(EngineID, GraknEngineConfig, Pool<Jedis>, int, EngineGraknGraphFactory, LockProvider, MetricRegistry) - Constructor for class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskManager
 
RedisTaskQueueConsumer - Class in ai.grakn.engine.tasks.manager.redisqueue
Consumer from a redis queue
RedisTaskQueueConsumer(String, TaskState, TaskConfiguration) - Constructor for class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskQueueConsumer
 
RedisTaskQueueConsumer(Task) - Constructor for class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskQueueConsumer
 
RedisTaskQueueConsumer(Map<String, Object>) - Constructor for class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskQueueConsumer
 
RedisTaskStorage - Class in ai.grakn.engine.tasks.manager.redisqueue
DAO for redis task states
reduce(String, Iterator<ConceptId>, MapReduce.ReduceEmitter<String, Long>) - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
Here we simply collect all concepts for a key and ask our concept fixer to do its thing.
refreshConnections() - Method in class ai.grakn.engine.factory.EngineGraknGraphFactory
 
RemoteSession - Class in ai.grakn.engine.session
Web socket for running a Graql shell
removeUser(String) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
Removes a user with the given username.
removeUser(String) - Method in class ai.grakn.engine.user.UsersHandler
 
Requests - Class in ai.grakn.engine.controller.util
Utility class for handling http requests
Requests() - Constructor for class ai.grakn.engine.controller.util.Requests
 
ResourceDeduplicationTask - Class in ai.grakn.engine.postprocessing
This is a task meant to be run periodically to eliminate resource duplication.
ResourceDeduplicationTask() - Constructor for class ai.grakn.engine.postprocessing.ResourceDeduplicationTask
 
ResourceDeduplicationTask.Job - Class in ai.grakn.engine.postprocessing
The map-reduce job submitted to the GraknGraphComputer that scan the whole set of resources in the graph and reduces by eliminating duplicates.
resume(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.BackgroundTask
This method may be called when resuming from a paused state or recovering from a crash or failure of any kind.
resume(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
resumedCounter - Static variable in class ai.grakn.engine.tasks.mock.LongExecutionMockTask
 
resumedCounter - Static variable in class ai.grakn.engine.tasks.mock.ShortExecutionMockTask
 
rethrow(Throwable) - Static method in class ai.grakn.engine.util.ExceptionWrapper
 
run() - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisInflightTaskConsumer
 
run() - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskQueueConsumer
 
run() - Method in interface ai.grakn.engine.util.ExceptionWrapper.RunnableWithExceptions
 
runAt() - Method in class ai.grakn.engine.tasks.manager.TaskSchedule
Get the instant the task is specified to run at.
runBatchMutationWithRetry(EngineGraknGraphFactory, String, int, Consumer<GraknGraph>) - Static method in class ai.grakn.engine.postprocessing.GraphMutators
 

S

saveCheckpoint(TaskCheckpoint) - Method in class ai.grakn.engine.tasks.BackgroundTask
 
schedule() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
schedule(TaskSchedule) - Method in class ai.grakn.engine.tasks.manager.TaskState
 
SERVER_HOST_NAME - Static variable in class ai.grakn.engine.GraknEngineConfig
 
SERVER_PORT_NUMBER - Static variable in class ai.grakn.engine.GraknEngineConfig
 
setConfigProperty(String, String) - Method in class ai.grakn.engine.GraknEngineConfig
 
setRunningState(RedisTaskManager, EngineID, GraknEngineConfig, Pool<Jedis>, EngineGraknGraphFactory, LockProvider, MetricRegistry) - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskQueueConsumer
 
ShortExecutionMockTask - Class in ai.grakn.engine.tasks.mock
Mocked task that will finish nearly instantaneously
ShortExecutionMockTask() - Constructor for class ai.grakn.engine.tasks.mock.ShortExecutionMockTask
 
signJWT(String) - Method in class ai.grakn.engine.util.JWTHandler
 
stackTrace() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
StandaloneTaskManager - Class in ai.grakn.engine.tasks.manager
In-memory task manager to schedule and execute tasks.
StandaloneTaskManager(EngineID, GraknEngineConfig, RedisCountStorage, EngineGraknGraphFactory, LockProvider, MetricRegistry) - Constructor for class ai.grakn.engine.tasks.manager.StandaloneTaskManager
 
start() - Method in class ai.grakn.engine.GraknEngineServer
 
start() - Method in class ai.grakn.engine.loader.MutatorTask
 
start() - Method in class ai.grakn.engine.postprocessing.PostProcessingTask
Apply CASTING and RESOURCE post processing jobs the concept ids in the provided configuration
start() - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask
 
start() - Method in class ai.grakn.engine.postprocessing.UpdatingInstanceCountTask
 
start() - Method in class ai.grakn.engine.tasks.BackgroundTask
Called to start execution of the task, may be called on a newly scheduled or previously stopped task.
start() - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskManager
 
start() - Method in class ai.grakn.engine.tasks.manager.StandaloneTaskManager
 
start() - Method in interface ai.grakn.engine.tasks.manager.TaskManager
Make sure the manager is initialized and starts processing tasks
start() - Method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
startedCounter - Static variable in class ai.grakn.engine.tasks.mock.LongExecutionMockTask
 
startHTTP() - Method in class ai.grakn.engine.GraknEngineServer
 
STATIC_FILES_PATH - Static variable in class ai.grakn.engine.GraknEngineConfig
 
status() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
statusChangeTime() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
stop() - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask
 
stop() - Method in class ai.grakn.engine.tasks.BackgroundTask
Called to stop execution of the task, may be called on a running or paused task.
stop() - Method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
stopHTTP() - Method in class ai.grakn.engine.GraknEngineServer
 
stopTask(TaskId) - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskManager
 
stopTask(TaskId) - Method in class ai.grakn.engine.tasks.manager.StandaloneTaskManager
 
stopTask(TaskId) - Method in interface ai.grakn.engine.tasks.manager.TaskManager
Stop a Scheduled, Paused or Running task.
storage() - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskManager
 
storage() - Method in class ai.grakn.engine.tasks.manager.StandaloneTaskManager
 
storage() - Method in interface ai.grakn.engine.tasks.manager.TaskManager
Return the StateStorage instance that is used by this class.
SUPERUSER - Static variable in class ai.grakn.engine.user.UsersHandler
 
superUsername() - Method in class ai.grakn.engine.user.UsersHandler
 
sync - Variable in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
SYSTEM_GRAPH_NAME - Static variable in class ai.grakn.engine.SystemKeyspace
 
SystemController - Class in ai.grakn.engine.controller
Controller Providing Configs for building Grakn Graphs
SystemController(EngineGraknGraphFactory, Service, MetricRegistry) - Constructor for class ai.grakn.engine.controller.SystemController
 
systemKeyspace() - Method in class ai.grakn.engine.factory.EngineGraknGraphFactory
 
SystemKeyspace - Class in ai.grakn.engine
Manages the system keyspace.
SystemKeyspace(EngineGraknGraphFactory) - Constructor for class ai.grakn.engine.SystemKeyspace
 
SystemKeyspace(EngineGraknGraphFactory, boolean) - Constructor for class ai.grakn.engine.SystemKeyspace
 
SystemKeyspaceUsers - Class in ai.grakn.engine.user
A DAO for managing users in the Grakn system keyspace.

T

TASK_MANAGER_IMPLEMENTATION - Static variable in class ai.grakn.engine.GraknEngineConfig
 
TaskCheckpoint - Class in ai.grakn.engine.tasks.manager
Internal checkpoint used to keep track of task execution
taskClass() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
TaskConfiguration - Class in ai.grakn.engine.tasks.manager
Internal checkpoint used to keep track of task execution
TaskConfiguration(Json) - Constructor for class ai.grakn.engine.tasks.manager.TaskConfiguration
 
TaskConfiguration(String) - Constructor for class ai.grakn.engine.tasks.manager.TaskConfiguration
 
TaskManager - Interface in ai.grakn.engine.tasks.manager
The base TaskManager interface.
TASKS_RETRY_DELAY - Static variable in class ai.grakn.engine.GraknEngineConfig
 
TaskSchedule - Class in ai.grakn.engine.tasks.manager
Scheduling information for tasks, contained within a TaskState.
TaskSchedule(Instant, Duration) - Constructor for class ai.grakn.engine.tasks.manager.TaskSchedule
 
TaskSchedule(long, Long) - Constructor for class ai.grakn.engine.tasks.manager.TaskSchedule
 
TasksController - Class in ai.grakn.engine.controller
Endpoints used to query and control queued background tasks.
TasksController(Service, TaskManager, MetricRegistry) - Constructor for class ai.grakn.engine.controller.TasksController
 
TaskState - Class in ai.grakn.engine.tasks.manager
Internal task state model used to keep track of scheduled tasks.
TaskState(Class<?>, String, TaskSchedule, TaskId, TaskState.Priority) - Constructor for class ai.grakn.engine.tasks.manager.TaskState
 
TaskState.Priority - Enum in ai.grakn.engine.tasks.manager
The priority of the task which decides which queue the task should go into
TaskStateInMemoryStore - Class in ai.grakn.engine.tasks.manager
Implementation of StateStorage that stores task state in memory.
TaskStateInMemoryStore() - Constructor for class ai.grakn.engine.tasks.manager.TaskStateInMemoryStore
 
TaskStateStorage - Interface in ai.grakn.engine.tasks.manager
The base StateStorage interface.
TaskSubmitter - Interface in ai.grakn.engine.tasks.manager
Submits Background Tasks for processing
toString() - Method in class ai.grakn.engine.tasks.manager.TaskCheckpoint
 
toString() - Method in class ai.grakn.engine.tasks.manager.TaskConfiguration
 
toString() - Method in class ai.grakn.engine.tasks.manager.TaskState
 
toString() - Method in class ai.grakn.engine.util.EngineID
 
totalElimintated() - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask
 
tryLock() - Method in class ai.grakn.engine.lock.NonReentrantLock
 
tryLock(long, TimeUnit) - Method in class ai.grakn.engine.lock.NonReentrantLock
 
tryProperty(String) - Method in class ai.grakn.engine.GraknEngineConfig
 

U

unlock() - Method in class ai.grakn.engine.lock.NonReentrantLock
 
updateState(TaskState) - Method in class ai.grakn.engine.tasks.manager.redisqueue.RedisTaskStorage
 
updateState(TaskState) - Method in class ai.grakn.engine.tasks.manager.TaskStateInMemoryStore
 
updateState(TaskState) - Method in interface ai.grakn.engine.tasks.manager.TaskStateStorage
Used to update task state.
updateUser(Json) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
Update a given user.
updateUser(Json) - Method in class ai.grakn.engine.user.UsersHandler
 
UpdatingInstanceCountTask - Class in ai.grakn.engine.postprocessing
Task that controls when types are updated with their new instance counts
UpdatingInstanceCountTask() - Constructor for class ai.grakn.engine.postprocessing.UpdatingInstanceCountTask
 
uri() - Method in class ai.grakn.engine.GraknEngineConfig
 
uri(String) - Method in class ai.grakn.engine.postprocessing.ResourceDeduplicationTask.Job
Specify the uri to use for the deduplication job.
USER_EMAIL - Static variable in class ai.grakn.engine.user.UsersHandler
 
USER_ENTITY - Static variable in class ai.grakn.engine.user.UsersHandler
 
USER_FIRST_NAME - Static variable in class ai.grakn.engine.user.UsersHandler
 
USER_IS_ADMIN - Static variable in class ai.grakn.engine.user.UsersHandler
 
USER_LAST_NAME - Static variable in class ai.grakn.engine.user.UsersHandler
 
USER_NAME - Static variable in class ai.grakn.engine.user.UsersHandler
 
USER_PASSWORD - Static variable in class ai.grakn.engine.user.UsersHandler
 
USER_SALT - Static variable in class ai.grakn.engine.user.UsersHandler
 
UserController - Class in ai.grakn.engine.controller
Endpoint used to control user interaction.
UserController(Service, UsersHandler) - Constructor for class ai.grakn.engine.controller.UserController
 
userExists(String) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
Return true if the user with the specified name exists and false otherwise.
userExists(String) - Method in class ai.grakn.engine.user.UsersHandler
 
UsersHandler - Class in ai.grakn.engine.user
Class to interact with users stored in the graph.
UsersHandler(String) - Constructor for class ai.grakn.engine.user.UsersHandler
 

V

validateUser(String, String) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
 
validateUser(String, String) - Method in class ai.grakn.engine.user.UsersHandler
 
value() - Method in class ai.grakn.engine.util.EngineID
 
valueOf(String) - Static method in enum ai.grakn.engine.tasks.manager.TaskState.Priority
Returns the enum constant of this type with the specified name.
values() - Static method in enum ai.grakn.engine.tasks.manager.TaskState.Priority
Returns an array containing the constants of this enum type, in the order they are declared.
verifyJWT(String) - Method in class ai.grakn.engine.util.JWTHandler
 

W

WEBSOCKET_TIMEOUT - Static variable in class ai.grakn.engine.GraknEngineConfig
 
whenTaskFinishes(Consumer<TaskId>) - Static method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
whenTaskResumes(Consumer<TaskCheckpoint>) - Static method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
whenTaskStarts(Consumer<TaskId>) - Static method in class ai.grakn.engine.tasks.mock.MockBackgroundTask
 
A B C D E F G H I J K L M N O P Q R S T U V W 
Skip navigation links
Grakn

Copyright © 2017 Grakn Labs Ltd. All rights reserved.