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

A

addJobCasting(String, String, ConceptId) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
addJobResource(String, String, ConceptId) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
addUser(Json) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
Add a new user.
addUser(Json) - Method in class ai.grakn.engine.user.UsersHandler
 
ai.grakn.engine - package ai.grakn.engine
 
ai.grakn.engine.backgroundtasks - package ai.grakn.engine.backgroundtasks
 
ai.grakn.engine.backgroundtasks.config - package ai.grakn.engine.backgroundtasks.config
 
ai.grakn.engine.backgroundtasks.distributed - package ai.grakn.engine.backgroundtasks.distributed
 
ai.grakn.engine.backgroundtasks.standalone - package ai.grakn.engine.backgroundtasks.standalone
 
ai.grakn.engine.backgroundtasks.taskstatestorage - package ai.grakn.engine.backgroundtasks.taskstatestorage
 
ai.grakn.engine.controller - package ai.grakn.engine.controller
 
ai.grakn.engine.loader - package ai.grakn.engine.loader
 
ai.grakn.engine.postprocessing - package ai.grakn.engine.postprocessing
 
ai.grakn.engine.session - package ai.grakn.engine.session
 
ai.grakn.engine.user - package ai.grakn.engine.user
 
ai.grakn.engine.util - package ai.grakn.engine.util
 
ai.grakn.factory - package ai.grakn.factory
 
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
 
AuthController - Class in ai.grakn.engine.controller
Endpoints used to handle operations related to authentication.
AuthController() - Constructor for class ai.grakn.engine.controller.AuthController
 

B

BackgroundTask - Interface in ai.grakn.engine.backgroundtasks
Interface which all tasks that wish to be scheduled for later execution as background tasks must implement.

C

checkpoint(String) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
checkpoint() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
childEvent(CuratorFramework, TreeCacheEvent) - Method in class ai.grakn.engine.backgroundtasks.distributed.TaskFailover
 
clearJobSetCastings(String, String) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
clearJobSetResources(String, String) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
client() - Static method in class ai.grakn.engine.backgroundtasks.config.ConfigHelper
 
close() - Method in class ai.grakn.engine.backgroundtasks.distributed.DistributedTaskManager
 
close() - Method in class ai.grakn.engine.backgroundtasks.distributed.Scheduler
Stop the main loop, causing run() to exit.
close() - Method in class ai.grakn.engine.backgroundtasks.distributed.TaskFailover
 
close() - Method in class ai.grakn.engine.backgroundtasks.distributed.TaskRunner
Stop the main loop, causing run() to exit.
close() - Method in class ai.grakn.engine.backgroundtasks.distributed.ZookeeperConnection
Close the connection to zookeeper.
close() - Method in class ai.grakn.engine.backgroundtasks.standalone.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() - Constructor for class ai.grakn.engine.controller.CommitLogController
 
CONFIG_FILE_SYSTEM_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
ConfigHelper - Class in ai.grakn.engine.backgroundtasks.config
Class containing helper methods to retrieve the default configuration for Zookeeper and Kafka consumers & producers
ConfigHelper() - Constructor for class ai.grakn.engine.backgroundtasks.config.ConfigHelper
 
ConfigProperties - Class in ai.grakn.engine.util
Singleton class used to read config file and make all the settings available to the Grakn Engine classes.
configuration(Json) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
configuration() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
connection() - Method in class ai.grakn.engine.backgroundtasks.distributed.ZookeeperConnection
Get the connection to zookeeper
CREATED_BY - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
createTask(String, String, Instant, long, Json) - Method in class ai.grakn.engine.backgroundtasks.distributed.DistributedTaskManager
 
createTask(String, String, Instant, long, Json) - Method in class ai.grakn.engine.backgroundtasks.standalone.StandaloneTaskManager
 
createTask(String, String, Instant, long, Json) - Method in interface ai.grakn.engine.backgroundtasks.TaskManager
Schedule a single shot/one off BackgroundTask to run after a @delay in milliseconds.
creator(String) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
creator() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
CURRENT_DIR_SYSTEM_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 

D

DEFAULT_CONFIG_FILE - Static variable in class ai.grakn.engine.util.ConfigProperties
 
DEFAULT_KEYSPACE_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
DEFAULT_LOG_CONFIG_FILE - Static variable in class ai.grakn.engine.util.ConfigProperties
 
deleteJobCasting(String, String, ConceptId) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
deleteJobResource(String, String, ConceptId) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
deserialize(String) - Static method in class ai.grakn.engine.backgroundtasks.TaskState
 
DISTRIBUTED_TASK_MANAGER - Static variable in class ai.grakn.engine.util.ConfigProperties
 
DistributedTaskManager - Class in ai.grakn.engine.backgroundtasks.distributed
Class to manage tasks distributed using Kafka.
DistributedTaskManager() - Constructor for class ai.grakn.engine.backgroundtasks.distributed.DistributedTaskManager
 

E

ENGINE_ID - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
EngineCache - Class in ai.grakn.engine.postprocessing
Engine's internal Concept ID cache
EngineGraknGraphFactory - Class in ai.grakn.factory
Engine's internal Graph Factory
engineID(String) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
engineID() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
EngineID - Class in ai.grakn.engine.util
Assigns a random ID to the current instance of Engine.
exception(String) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
exception() - Method in class ai.grakn.engine.backgroundtasks.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
extractUserFromJWT(String) - Static method in class ai.grakn.engine.util.JWTHandler
 

G

getAcceptType(Request) - Static method in class ai.grakn.engine.controller.Utilities
 
getAsList(String, String) - Static method in class ai.grakn.engine.controller.Utilities
 
getAsString(String, String) - Static method in class ai.grakn.engine.controller.Utilities
 
getAvailableThreads() - Method in class ai.grakn.engine.util.ConfigProperties
 
getBytes(String) - Static method in class ai.grakn.engine.user.Password
 
getCastingJobs(String) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
getGraph(String) - Method in class ai.grakn.factory.EngineGraknGraphFactory
 
getGraphBatchLoading(String) - Method in class ai.grakn.factory.EngineGraknGraphFactory
 
getId() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
getInstance() - Static method in class ai.grakn.engine.postprocessing.EngineCache
 
getInstance() - Static method in class ai.grakn.engine.postprocessing.PostProcessing
 
getInstance() - Static method in class ai.grakn.engine.user.UsersHandler
 
getInstance() - Static method in class ai.grakn.engine.util.ConfigProperties
 
getInstance() - Static method in class ai.grakn.engine.util.EngineID
 
getInstance() - Static method in class ai.grakn.factory.EngineGraknGraphFactory
 
getKeyspace(Request) - Static method in class ai.grakn.engine.controller.Utilities
 
getKeyspaces() - Method in class ai.grakn.engine.postprocessing.EngineCache
 
getLogFilePath() - Method in class ai.grakn.engine.util.ConfigProperties
 
getNumCastingJobs(String) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
getNumJobs(String) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
getNumResourceJobs(String) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
getPath(String) - Method in class ai.grakn.engine.util.ConfigProperties
 
getProperties() - Method in class ai.grakn.engine.util.ConfigProperties
 
getProperty(String) - Method in class ai.grakn.engine.util.ConfigProperties
 
getProperty(String, String) - Method in class ai.grakn.engine.util.ConfigProperties
 
getPropertyAsBool(String) - Method in class ai.grakn.engine.util.ConfigProperties
 
getPropertyAsInt(String) - Method in class ai.grakn.engine.util.ConfigProperties
 
getPropertyAsLong(String) - Method in class ai.grakn.engine.util.ConfigProperties
 
getResourceJobs(String) - Method in class ai.grakn.engine.postprocessing.EngineCache
 
getScheduler() - Method in class ai.grakn.engine.backgroundtasks.distributed.SchedulerElector
 
getState(String) - Method in interface ai.grakn.engine.backgroundtasks.TaskStateStorage
This is a copy of the internal TaskState object.
getState(String) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateGraphStore
 
getState(String) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateInMemoryStore
 
getState(String) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateZookeeperStore
Retrieve the TaskState associated with the given ID.
getTaskManager() - Static method in class ai.grakn.engine.GraknEngineServer
 
getTasks(TaskStatus, String, String, int, int) - Method in interface ai.grakn.engine.backgroundtasks.TaskStateStorage
Return a Set of Pairs of tasks that match any of the criteria.
getTasks(TaskStatus, String, String, int, int) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateGraphStore
 
getTasks(TaskStatus, String, String, int, int, Boolean) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateGraphStore
 
getTasks(TaskStatus, String, String, int, int) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateInMemoryStore
 
getTasks(TaskStatus, String, String, int, int) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateZookeeperStore
This implementation will fetch all of the tasks from zookeeper and then filer them out.
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_ASCII - Static variable in class ai.grakn.engine.util.ConfigProperties
 
GraknEngineServer - Class in ai.grakn.engine
Main class in charge to start a web server and all the REST controllers.
GraknEngineServer() - Constructor for class ai.grakn.engine.GraknEngineServer
 
GRAPH_COMPUTER_CONFIG_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
GRAPH_CONFIG_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
GraphFactoryController - Class in ai.grakn.engine.controller
Controller Providing Configs for building Grakn Graphs
GraphFactoryController() - Constructor for class ai.grakn.engine.controller.GraphFactoryController
 

H

HAL_DEGREE_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
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)

I

id() - Method in class ai.grakn.engine.util.EngineID
 
instanceToState(GraknGraph, Instance) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateGraphStore
Given an instance concept, turn it into a TaskState object.
interval(long) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
interval() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
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)
isPasswordProtected - Static variable in class ai.grakn.engine.GraknEngineServer
 
isRecurring(Boolean) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
isRecurring() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 

J

JWT_SECRET_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
JWTHandler - Class in ai.grakn.engine.util
Retrieves and verifies user data using JWT
JWTHandler() - Constructor for class ai.grakn.engine.util.JWTHandler
 

K

KAFKA_BATCH_SIZE - Static variable in class ai.grakn.engine.util.ConfigProperties
 
KAFKA_BOOTSTRAP_SERVERS - Static variable in class ai.grakn.engine.util.ConfigProperties
 
KAFKA_BUFFER_MEM - Static variable in class ai.grakn.engine.util.ConfigProperties
 
KAFKA_LINGER_MS - Static variable in class ai.grakn.engine.util.ConfigProperties
 
KAFKA_RETRIES - Static variable in class ai.grakn.engine.util.ConfigProperties
 
KAFKA_SESSION_TIMEOUT - Static variable in class ai.grakn.engine.util.ConfigProperties
 
kafkaConsumer(String) - Static method in class ai.grakn.engine.backgroundtasks.config.ConfigHelper
 
kafkaProducer() - Static method in class ai.grakn.engine.backgroundtasks.config.ConfigHelper
 
KafkaTerms - Interface in ai.grakn.engine.backgroundtasks.config
Class containing strings that describe the Kafka queues and groups

L

LOADER_REPEAT_COMMITS - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LoaderTask - Class in ai.grakn.engine.loader
Task that will load data into a graph.
LoaderTask() - Constructor for class ai.grakn.engine.loader.LoaderTask
 
LOG_FILE_CONFIG_SYSTEM_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LOG_FILE_OUTPUT_SYSTEM_PROPERTY_MAIN - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LOG_FILE_OUTPUT_SYSTEM_PROPERTY_POST_PROCESSING - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LOG_LEVEL_SYSTEM_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LOG_NAME_POSTPROCESSING_DEFAULT - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LOG_NAME_POSTPROCESSING_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LOG_TOPIC - Static variable in interface ai.grakn.engine.backgroundtasks.config.KafkaTerms
 
LOGGING_FILE_PATH_MAIN - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LOGGING_FILE_PATH_POST_PROCESSING - Static variable in class ai.grakn.engine.util.ConfigProperties
 
LOGGING_LEVEL - Static variable in class ai.grakn.engine.util.ConfigProperties
 

M

main(String[]) - Static method in class ai.grakn.engine.GraknEngineServer
 

N

NEW_TASKS_TOPIC - Static variable in interface ai.grakn.engine.backgroundtasks.config.KafkaTerms
 
newState(TaskState) - Method in interface ai.grakn.engine.backgroundtasks.TaskStateStorage
Create a new task state and store it, returning an ID to later access this task state.
newState(TaskState) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateGraphStore
 
newState(TaskState) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateInMemoryStore
 
newState(TaskState) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateZookeeperStore
 
noThrow(ExceptionWrapper.RunnableWithExceptions, String) - Static method in class ai.grakn.engine.util.ExceptionWrapper
 
NUM_THREADS_PROPERTY - Static variable in class ai.grakn.engine.util.ConfigProperties
 

O

onClose(Session, int, String) - Method in class ai.grakn.engine.session.RemoteSession
 
onConnect(Session) - Method in class ai.grakn.engine.session.RemoteSession
 
onMessage(Session, String) - Method in class ai.grakn.engine.session.RemoteSession
 
open() - Method in class ai.grakn.engine.backgroundtasks.standalone.StandaloneTaskManager
 

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.util.ConfigProperties
 
pause() - Method in interface ai.grakn.engine.backgroundtasks.BackgroundTask
Called to suspend the execution of a currently running task.
pause() - Method in class ai.grakn.engine.loader.LoaderTask
 
pause() - Method in class ai.grakn.engine.postprocessing.PostProcessingTask
 
POST_PROCESSING_DELAY - Static variable in class ai.grakn.engine.util.ConfigProperties
 
POST_PROCESSING_THREADS - Static variable in class ai.grakn.engine.util.ConfigProperties
 
PostProcessing - Class in ai.grakn.engine.postprocessing
Post Processing Manager
PostProcessingTask - Class in ai.grakn.engine.postprocessing
Task that control when postprocessing starts.
PostProcessingTask() - Constructor for class ai.grakn.engine.postprocessing.PostProcessingTask
 
PROJECT_VERSION - Static variable in class ai.grakn.engine.util.ConfigProperties
 

R

RECUR_INTERVAL - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
RECURRING - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
refreshConnections() - Method in class ai.grakn.factory.EngineGraknGraphFactory
 
RemoteSession - Class in ai.grakn.engine.session
Web socket for running a Graql shell
RemoteSession() - Constructor for class ai.grakn.engine.session.RemoteSession
 
RemoteSession(Function<String, GraknGraph>) - Constructor for class ai.grakn.engine.session.RemoteSession
 
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
 
reset() - Method in class ai.grakn.engine.postprocessing.PostProcessing
 
resume(Consumer<String>, String) - Method in interface ai.grakn.engine.backgroundtasks.BackgroundTask
This method may be called when resuming from a paused state or recovering from a crash or failure of any kind.
resume(Consumer<String>, String) - Method in class ai.grakn.engine.loader.LoaderTask
 
resume(Consumer<String>, String) - Method in class ai.grakn.engine.postprocessing.PostProcessingTask
 
run() - Method in class ai.grakn.engine.backgroundtasks.distributed.Scheduler
 
run() - Method in class ai.grakn.engine.backgroundtasks.distributed.TaskRunner
Start the main loop, this will block until a call to stop().
run() - Method in class ai.grakn.engine.postprocessing.PostProcessing
 
run() - Method in interface ai.grakn.engine.util.ExceptionWrapper.RunnableWithExceptions
 
RUN_AT - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
runAt(Instant) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
runAt() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
RUNNERS_STATE - Static variable in interface ai.grakn.engine.backgroundtasks.config.ZookeeperPaths
 
RUNNERS_WATCH - Static variable in interface ai.grakn.engine.backgroundtasks.config.ZookeeperPaths
 

S

SCHEDULED_TASK - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
SCHEDULER - Static variable in interface ai.grakn.engine.backgroundtasks.config.ZookeeperPaths
 
Scheduler - Class in ai.grakn.engine.backgroundtasks.distributed
Handle execution of recurring tasks.
Scheduler(TaskStateStorage) - Constructor for class ai.grakn.engine.backgroundtasks.distributed.Scheduler
 
SCHEDULER_POLLING_FREQ - Static variable in class ai.grakn.engine.util.ConfigProperties
 
SchedulerElector - Class in ai.grakn.engine.backgroundtasks.distributed
There is one "Scheduler" that will be constantly running on the "Leader" machine.
SchedulerElector(TaskStateStorage, ZookeeperConnection) - Constructor for class ai.grakn.engine.backgroundtasks.distributed.SchedulerElector
 
SCHEDULERS_GROUP - Static variable in interface ai.grakn.engine.backgroundtasks.config.KafkaTerms
 
SERIALISED_TASK - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
serialize(TaskState) - Static method in class ai.grakn.engine.backgroundtasks.TaskState
 
SERVER_HOST_NAME - Static variable in class ai.grakn.engine.util.ConfigProperties
 
SERVER_PORT_NUMBER - Static variable in class ai.grakn.engine.util.ConfigProperties
 
setConfigProperty(String, String) - Method in class ai.grakn.engine.util.ConfigProperties
 
signJWT(String) - Static method in class ai.grakn.engine.util.JWTHandler
 
STACK_TRACE - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
stackTrace(String) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
stackTrace() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
StandaloneTaskManager - Class in ai.grakn.engine.backgroundtasks.standalone
In-memory task manager to schedule and execute tasks.
StandaloneTaskManager() - Constructor for class ai.grakn.engine.backgroundtasks.standalone.StandaloneTaskManager
 
start(Consumer<String>, Json) - Method in interface ai.grakn.engine.backgroundtasks.BackgroundTask
Called to start execution of the task, may be called on a newly scheduled or previously stopped task.
start(boolean) - Static method in class ai.grakn.engine.GraknEngineServer
 
start(Consumer<String>, Json) - Method in class ai.grakn.engine.loader.LoaderTask
 
start(Consumer<String>, Json) - Method in class ai.grakn.engine.postprocessing.PostProcessingTask
Run postprocessing only if enough time has passed since the last job was added
startHTTP() - Static method in class ai.grakn.engine.GraknEngineServer
 
stateChanged(CuratorFramework, ConnectionState) - Method in class ai.grakn.engine.backgroundtasks.distributed.SchedulerElector
 
STATIC_FILES_PATH - Static variable in class ai.grakn.engine.util.ConfigProperties
 
status(TaskStatus) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
status() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
STATUS - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
STATUS_CHANGE_BY - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
STATUS_CHANGE_TIME - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
statusChangedBy(String) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
statusChangedBy() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
statusChangeTime(Instant) - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
statusChangeTime() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
StatusController - Class in ai.grakn.engine.controller
Endpoints used to retrieve all the info about the current instance of Grakn.
StatusController() - Constructor for class ai.grakn.engine.controller.StatusController
 
stop() - Method in interface ai.grakn.engine.backgroundtasks.BackgroundTask
Called to stop execution of the task, may be called on a running or paused task.
stop() - Method in class ai.grakn.engine.backgroundtasks.distributed.SchedulerElector
When stopping the ClusterManager we must: 1.
stop() - Static method in class ai.grakn.engine.GraknEngineServer
 
stop() - Method in class ai.grakn.engine.loader.LoaderTask
 
stop() - Method in class ai.grakn.engine.postprocessing.PostProcessing
 
stop() - Method in class ai.grakn.engine.postprocessing.PostProcessingTask
 
stopHTTP() - Static method in class ai.grakn.engine.GraknEngineServer
 
stopTask(String, String) - Method in class ai.grakn.engine.backgroundtasks.distributed.DistributedTaskManager
 
stopTask(String, String) - Method in class ai.grakn.engine.backgroundtasks.standalone.StandaloneTaskManager
 
stopTask(String, String) - Method in interface ai.grakn.engine.backgroundtasks.TaskManager
Stop a Scheduled, Paused or Running task.
storage() - Method in class ai.grakn.engine.backgroundtasks.distributed.DistributedTaskManager
 
storage() - Method in class ai.grakn.engine.backgroundtasks.standalone.StandaloneTaskManager
 
storage() - Method in interface ai.grakn.engine.backgroundtasks.TaskManager
Return the StateStorage instance that is used by this class.
SystemKeyspaceUsers - Class in ai.grakn.engine.user
A DAO for managing users in the Grakn system keyspace.
SystemKeyspaceUsers() - Constructor for class ai.grakn.engine.user.SystemKeyspaceUsers
 
SystemOntologyElements - Interface in ai.grakn.engine.util
Describes the system ontology elements related to task loading

T

takeLeadership(CuratorFramework) - Method in class ai.grakn.engine.backgroundtasks.distributed.SchedulerElector
On leadership takeover, start a new Scheduler instance and wait for it to complete.
TASK_CHECKPOINT - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
TASK_CLASS_NAME - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
TASK_CONFIGURATION - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
TASK_EXCEPTION - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
TASK_ID - Static variable in interface ai.grakn.engine.util.SystemOntologyElements
 
TASK_LOCK_SUFFIX - Static variable in interface ai.grakn.engine.backgroundtasks.config.ZookeeperPaths
 
TASK_RUNNER_GROUP - Static variable in interface ai.grakn.engine.backgroundtasks.config.KafkaTerms
 
TASK_RUNNERS - Static variable in interface ai.grakn.engine.backgroundtasks.config.ZookeeperPaths
 
TASK_STATE_SUFFIX - Static variable in interface ai.grakn.engine.backgroundtasks.config.ZookeeperPaths
 
taskClassName() - Method in class ai.grakn.engine.backgroundtasks.TaskState
 
TaskFailover - Class in ai.grakn.engine.backgroundtasks.distributed
Re-schedule tasks that were running when an instance of Engine failed
TaskFailover(CuratorFramework, TreeCache, TaskStateStorage) - Constructor for class ai.grakn.engine.backgroundtasks.distributed.TaskFailover
 
TaskManager - Interface in ai.grakn.engine.backgroundtasks
The base TaskManager interface.
TaskRunner - Class in ai.grakn.engine.backgroundtasks.distributed
Picks up tasks from the work queue, runs them and marks them as completed or failed.
TaskRunner(TaskStateStorage, ZookeeperConnection) - Constructor for class ai.grakn.engine.backgroundtasks.distributed.TaskRunner
 
TASKRUNNER_POLLING_FREQ - Static variable in class ai.grakn.engine.util.ConfigProperties
 
TASKS_NAMESPACE - Static variable in interface ai.grakn.engine.backgroundtasks.config.ZookeeperPaths
 
TASKS_PATH_PREFIX - Static variable in interface ai.grakn.engine.backgroundtasks.config.ZookeeperPaths
 
TasksController - Class in ai.grakn.engine.controller
Endpoints used to query and control queued background tasks.
TasksController(TaskManager) - Constructor for class ai.grakn.engine.controller.TasksController
 
TaskState - Class in ai.grakn.engine.backgroundtasks
Internal task state model used to keep track of scheduled tasks.
TaskState(String) - Constructor for class ai.grakn.engine.backgroundtasks.TaskState
 
TaskState(String, String, TaskStatus) - Constructor for class ai.grakn.engine.backgroundtasks.TaskState
 
TaskStateGraphStore - Class in ai.grakn.engine.backgroundtasks.taskstatestorage
Implementation of StateStorage that stores task state in the Grakn system graph.
TaskStateGraphStore() - Constructor for class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateGraphStore
 
TaskStateInMemoryStore - Class in ai.grakn.engine.backgroundtasks.taskstatestorage
Implementation of StateStorage that stores task state in memory.
TaskStateInMemoryStore() - Constructor for class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateInMemoryStore
 
TaskStateStorage - Interface in ai.grakn.engine.backgroundtasks
The base StateStorage interface.
TaskStateZookeeperStore - Class in ai.grakn.engine.backgroundtasks.taskstatestorage
Manages the state of background BackgroundTask in a synchronized manner withing a cluster.
TaskStateZookeeperStore(ZookeeperConnection) - Constructor for class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateZookeeperStore
 
TIME_LAPSE - Static variable in class ai.grakn.engine.util.ConfigProperties
 

U

updateState(TaskState) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateGraphStore
 
updateState(TaskState) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateInMemoryStore
 
updateState(TaskState) - Method in class ai.grakn.engine.backgroundtasks.taskstatestorage.TaskStateZookeeperStore
 
updateState(TaskState) - Method in interface ai.grakn.engine.backgroundtasks.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
 
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() - 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() - Constructor for class ai.grakn.engine.user.UsersHandler
 
Utilities - Class in ai.grakn.engine.controller
Methods that will be used by all of the controllers.
Utilities() - Constructor for class ai.grakn.engine.controller.Utilities
 

V

validateUser(String, String) - Method in class ai.grakn.engine.user.SystemKeyspaceUsers
 
validateUser(String, String) - Method in class ai.grakn.engine.user.UsersHandler
 
verifyJWT(String) - Static method in class ai.grakn.engine.util.JWTHandler
 
VisualiserController - Class in ai.grakn.engine.controller
Endpoints used to query the graph by ID or Graql match query and build a HAL or Graql response.
VisualiserController() - Constructor for class ai.grakn.engine.controller.VisualiserController
 

W

WORK_QUEUE_TOPIC - Static variable in interface ai.grakn.engine.backgroundtasks.config.KafkaTerms
 

Z

ZK_BACKOFF_BASE_SLEEP_TIME - Static variable in class ai.grakn.engine.util.ConfigProperties
 
ZK_BACKOFF_MAX_RETRIES - Static variable in class ai.grakn.engine.util.ConfigProperties
 
ZK_CONNECTION_TIMEOUT - Static variable in class ai.grakn.engine.util.ConfigProperties
 
ZK_SERVERS - Static variable in class ai.grakn.engine.util.ConfigProperties
 
ZK_SESSION_TIMEOUT - Static variable in class ai.grakn.engine.util.ConfigProperties
 
ZookeeperConnection - Class in ai.grakn.engine.backgroundtasks.distributed
Task encapsulating the connection to Zookeeper.
ZookeeperConnection() - Constructor for class ai.grakn.engine.backgroundtasks.distributed.ZookeeperConnection
Start the connection to zookeeper.
ZookeeperPaths - Interface in ai.grakn.engine.backgroundtasks.config
Class containing strings that describe the file storage locations in Zookeeper
A B C D E G H I J K L M N O P R S T U V W Z 
Skip navigation links
Grakn

Copyright © 2017 Grakn Labs Ltd. All rights reserved.