A B C D E F G H I J K L M O P R S T U V W 
All Classes All Packages

A

ABANDONED - com.decisionbrain.optimserver.common.enumeration.JobStatus
A job is abandoned if a it was aborted before the job processing had started, or if the timeout has been reached before the job processing had started, or if the destination task queue was full when receiving the message.
ABORTED - com.decisionbrain.optimserver.common.enumeration.JobStatus
A job is aborted if has been ended by a call to the abortion API, while it is running.
AbstractEventDTO - Class in com.decisionbrain.optimserver.common.dto.event
An event has the identifier of the job it is related to, and a timestamp.
AbstractEventDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
 
AbstractEventDTO(String) - Constructor for class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
 
AbstractEventDTO(String, Instant) - Constructor for class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
 
addKpi(KpiDTO<T>) - Method in interface com.decisionbrain.optimserver.common.client.JobEventListener
 
AmqpClientMessagingConfiguration - Class in com.decisionbrain.optimserver.client.amqp.config
 
AmqpClientMessagingConfiguration() - Constructor for class com.decisionbrain.optimserver.client.amqp.config.AmqpClientMessagingConfiguration
 

B

BATCH - com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode
Batch: the worker is started with the job id to run has parameter and exit when the job has finished.
build() - Method in class com.decisionbrain.optimserver.common.dto.event.client.LogDTO.LogDTOBuilder
 
builder() - Static method in class com.decisionbrain.optimserver.common.dto.event.client.LogDTO
 

C

com.decisionbrain.optimserver.client.amqp.annotation - package com.decisionbrain.optimserver.client.amqp.annotation
This package contains the spring annotation that allows to import AMQP clients classes in the spring context.
com.decisionbrain.optimserver.client.amqp.config - package com.decisionbrain.optimserver.client.amqp.config
 
com.decisionbrain.optimserver.client.amqp.service - package com.decisionbrain.optimserver.client.amqp.service
This package contains the AMQP client interfaces and spring services implementation.
com.decisionbrain.optimserver.common.client - package com.decisionbrain.optimserver.common.client
This package exposes interfaces for job events clients.
com.decisionbrain.optimserver.common.client.stomp - package com.decisionbrain.optimserver.common.client.stomp
 
com.decisionbrain.optimserver.common.dto.event - package com.decisionbrain.optimserver.common.dto.event
This package provides DTOs related to job events.
com.decisionbrain.optimserver.common.dto.event.client - package com.decisionbrain.optimserver.common.dto.event.client
 
com.decisionbrain.optimserver.common.dto.event.master - package com.decisionbrain.optimserver.common.dto.event.master
 
com.decisionbrain.optimserver.common.enumeration - package com.decisionbrain.optimserver.common.enumeration
This package provides enumeration types.
COMPLETED - com.decisionbrain.optimserver.common.enumeration.JobStatus
A job successfully completed.
connect() - Method in interface com.decisionbrain.optimserver.common.client.stomp.StompClient
 
COPY - com.decisionbrain.optimserver.common.enumeration.JobRelationType
If a job j2 is a copy of another job j1, then there should be an arc (j1, j2) with this type in the related flow.

D

DAEMON - com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode
Daemon: the worker is kept alive and consumes jobs from the Rabbitmq queues.
disconnect() - Method in interface com.decisionbrain.optimserver.common.client.stomp.StompClient
 

E

EnableOptimServerAmqpClient - Annotation Type in com.decisionbrain.optimserver.client.amqp.annotation
Allows to import AMQP clients classes in the spring context.
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
 
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.client.JobStatusDTO
 
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.client.LogDTO
 
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.client.MessageDTO
Deprecated.
 
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO
 
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO.Parameter
 
equals(Object) - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
 

F

FAILED - com.decisionbrain.optimserver.common.enumeration.JobStatus
A job is failed if an error occurred while it was processed on a worker.

G

getBucketId() - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO.Parameter
 
getCoefficient() - Method in class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
getJobId() - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
 
getKey() - Method in class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
getLevel() - Method in class com.decisionbrain.optimserver.common.dto.event.client.LogDTO
 
getMessage() - Method in class com.decisionbrain.optimserver.common.dto.event.client.JobStatusDTO
 
getMessage() - Method in class com.decisionbrain.optimserver.common.dto.event.client.MessageDTO
Deprecated.
 
getMessage() - Method in class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 
getMessage() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
 
getName() - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO.Parameter
 
getParameters() - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO
 
getProgressType() - Method in class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 
getProgressValue() - Method in class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 
getSolution() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
 
getStatus() - Method in class com.decisionbrain.optimserver.common.dto.event.client.JobStatusDTO
 
getTimestamp() - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
 
getValue() - Method in class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
getValue() - Method in enum com.decisionbrain.optimserver.common.enumeration.JobRelationType
 
getValue() - Method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus
 
getWorkerId() - Method in class com.decisionbrain.optimserver.common.dto.event.client.JobStatusDTO
 

H

hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
 
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.client.JobStatusDTO
 
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.client.LogDTO
 
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.client.MessageDTO
Deprecated.
 
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO
 
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO.Parameter
 
hashCode() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
 

I

isFailure() - Method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus
 
isLast() - Method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus
 

J

JobEventListener - Interface in com.decisionbrain.optimserver.common.client
Implement this interface to listen to job events posted by the master.
jobEventsForClients() - Method in class com.decisionbrain.optimserver.client.amqp.config.AmqpClientMessagingConfiguration
Master posts all job events to this exchange, so that clients can subscribe.
JobEventsStandaloneSubscriptionService - Interface in com.decisionbrain.optimserver.client.amqp.service
This interface allows to (un)subscribe to events related to a given job.
jobId(String) - Method in class com.decisionbrain.optimserver.common.dto.event.client.LogDTO.LogDTOBuilder
 
JobRelationType - Enum in com.decisionbrain.optimserver.common.enumeration
This enumeration defines possible relations between jobs, in a job flow.
JobsCompletionWaitingService - Interface in com.decisionbrain.optimserver.client.amqp.service
A jobs completion waiting service allows a client to be blocked will waiting a given job completion.
JobsEventsSharedSubscriptionService - Interface in com.decisionbrain.optimserver.client.amqp.service
This interface allows to (un)subscribe to all job events, in such a way that events are distributed among all subscribers, in a round-robin way.
JobsEventsStandaloneSubscriptionService - Interface in com.decisionbrain.optimserver.client.amqp.service
This interface allows to (un)subscribe to job events for all jobs.
JobStarterFunction - Interface in com.decisionbrain.optimserver.client.amqp.service
This function should allow to request the master to start a job.
JobStatus - Enum in com.decisionbrain.optimserver.common.enumeration
This enumeration defines possible execution statuses for a job.
JobStatusDTO - Class in com.decisionbrain.optimserver.common.dto.event.client
 
JobStatusDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.JobStatusDTO
 
JobStatusDTO(String, JobStatus, String, String) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.JobStatusDTO
 

K

KpiDTO<T> - Class in com.decisionbrain.optimserver.common.dto.event.client
 
KpiDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
KpiDTO(String, String, T) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
KpiDTO(String, String, T, Double) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
KpiDTO(String, Instant, String, T) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
KpiDTO(String, Instant, String, T, Double) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 

L

level(String) - Method in class com.decisionbrain.optimserver.common.dto.event.client.LogDTO.LogDTOBuilder
 
LogDTO - Class in com.decisionbrain.optimserver.common.dto.event.client
A message with a log level.
LogDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.LogDTO
 
LogDTO(String, String, String) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.LogDTO
 
LogDTO.LogDTOBuilder - Class in com.decisionbrain.optimserver.common.dto.event.client
 

M

message(String) - Method in class com.decisionbrain.optimserver.common.dto.event.client.LogDTO.LogDTOBuilder
 
MessageDTO - Class in com.decisionbrain.optimserver.common.dto.event.client
Deprecated.
use a logger to log messages instead
MessageDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.MessageDTO
Deprecated.
 
MessageDTO(String, String) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.MessageDTO
Deprecated.
 

O

onMessage(MessageDTO) - Method in interface com.decisionbrain.optimserver.common.client.JobEventListener
 
onProgress(ProgressDTO) - Method in interface com.decisionbrain.optimserver.common.client.JobEventListener
 
onSolution(SolutionNotificationDTO) - Method in interface com.decisionbrain.optimserver.common.client.JobEventListener
Deprecated.
use onSolution(SolutionDTO solution) instead. This way, the whole solution is directly in the message.
onSolution(SolutionDTO) - Method in interface com.decisionbrain.optimserver.common.client.JobEventListener
 
onStatus(JobStatusDTO) - Method in interface com.decisionbrain.optimserver.common.client.JobEventListener
 

P

Parameter() - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO.Parameter
 
Parameter(String, String) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO.Parameter
 
PARENTHOOD - com.decisionbrain.optimserver.common.enumeration.JobRelationType
If a job j1 creates a sub-job j2, then there should be an arc (j1, j2) with this type in the related flow.
ProgressDTO - Class in com.decisionbrain.optimserver.common.dto.event.client
 
ProgressDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 
ProgressDTO(String, String, String, double) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 
ProgressDTO(String, Instant, String, String, double) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 

R

rabbitAdmin(CachingConnectionFactory) - Method in class com.decisionbrain.optimserver.client.amqp.config.AmqpClientMessagingConfiguration
 
REGISTER - com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode
Register: the worker send to master the information about its tasks and exit.
registerJob(String) - Method in interface com.decisionbrain.optimserver.common.client.JobEventListener
Deprecated.
register on the chosen client instead. The listener should be given to the client while registering.
registerJob(String, JobEventListener) - Method in interface com.decisionbrain.optimserver.common.client.stomp.StompClient
 
registerJobEventsListener(JobEventListener) - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobsEventsStandaloneSubscriptionService
The registered listener will receive all events for all jobs running in the optim server instance.
registerJobEventsListener(JobEventListener, List<String>) - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobsEventsStandaloneSubscriptionService
The registered listener will receive all events of the given type(s) for all jobs running in the optim server instance.
registerJobEventsListener(String, JobEventListener) - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobEventsStandaloneSubscriptionService
The registered listener will receive all events for the given job ID.
registerJobEventsListener(String, JobEventListener, List<String>) - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobEventsStandaloneSubscriptionService
The registered listener will receive all events of the given types for the given job ID.
REJECTED - com.decisionbrain.optimserver.common.enumeration.JobStatus
A worker can reject a job if invalid inputs are received.
RUNNING - com.decisionbrain.optimserver.common.enumeration.JobStatus
A job that is currently processed by a worker is running.

S

SCHEDULED - com.decisionbrain.optimserver.common.enumeration.JobStatus
When a message has been sent to the worker(s) queue, the job is scheduled.
setAuthenticationToken(String) - Method in interface com.decisionbrain.optimserver.common.client.stomp.StompClient
Set an authentication token for a Bearer authentication scheme.
setBasicAuthenticationCredentials(String, String) - Method in interface com.decisionbrain.optimserver.common.client.stomp.StompClient
Set credentials for a Basic authentication scheme.
shareJobEventsSubscription(JobEventListener, String) - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobsEventsSharedSubscriptionService
The registered listener will receive some of the events for jobs running in the optim server instance.
SolutionDTO - Class in com.decisionbrain.optimserver.common.dto.event
A solution DTO contains the output(s) emitted by a job before completion.
SolutionDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
 
SolutionDTO(String, SolutionParameter, String) - Constructor for class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
 
SolutionNotificationDTO - Class in com.decisionbrain.optimserver.common.dto.event.client
 
SolutionNotificationDTO() - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO
 
SolutionNotificationDTO(String, List<SolutionNotificationDTO.Parameter>) - Constructor for class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO
 
SolutionNotificationDTO.Parameter - Class in com.decisionbrain.optimserver.common.dto.event.client
 
startJob() - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobStarterFunction
Starts a job.
StompClient - Interface in com.decisionbrain.optimserver.common.client.stomp
 
SUBMITTED - com.decisionbrain.optimserver.common.enumeration.JobStatus
A job entity saved in the database is submitted.

T

TimeoutDTO - Interface in com.decisionbrain.optimserver.common.dto.event.master
Common interface for DTOs that can be sent with a timeout.
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.AbstractEventDTO
 
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.client.JobStatusDTO
 
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.client.KpiDTO
 
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.client.MessageDTO
Deprecated.
 
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.client.ProgressDTO
 
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO.Parameter
 
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.client.SolutionNotificationDTO
 
toString() - Method in class com.decisionbrain.optimserver.common.dto.event.SolutionDTO
 

U

unregisterJob(String) - Method in interface com.decisionbrain.optimserver.common.client.JobEventListener
Deprecated.
unregister on the chosen client instead.
unregisterJob(String) - Method in interface com.decisionbrain.optimserver.common.client.stomp.StompClient
 
unregisterJobEventsListener() - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobsEventsStandaloneSubscriptionService
Unregistering the listener releases the resources.
unregisterJobEventsListenerForJob(String) - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobEventsStandaloneSubscriptionService
Unregistering the listener releases the resources.
unregisterJobEventsListenerForSubscription(String) - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobsEventsSharedSubscriptionService
Unregistering the listener will prevent receiving events, and release the resources if the subscriber was the last one.

V

valueOf(String) - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobRelationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobRelationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.decisionbrain.optimserver.common.enumeration.JobStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.decisionbrain.optimserver.common.enumeration.WorkerLifecycleMode
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForJobCompletion(String, Long, JobStarterFunction) - Method in interface com.decisionbrain.optimserver.client.amqp.service.JobsCompletionWaitingService
Starts a job, listens for this jobEvents, and returns on completion (success or failure) or timeout.
WorkerLifecycleMode - Enum in com.decisionbrain.optimserver.common.enumeration
Represent the type of lifecycle the worker is running in.
A B C D E F G H I J K L M O P R S T U V W 
All Classes All Packages