Index

A C D E F G H J L P R S 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(JobContext) - Method in interface edu.ucsb.cs156.jobs.services.JobContextConsumer
 
allJobs() - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
 
ALLOWED_SORT_FIELDS - Static variable in class edu.ucsb.cs156.jobs.controllers.JobsController
 

C

createContext(Job) - Method in class edu.ucsb.cs156.jobs.services.JobContextFactory
 

D

DEFAULT_RATE_LIMIT_MS - Static variable in class edu.ucsb.cs156.jobs.services.JobRateLimit
 
deleteAllJobs() - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
 
deleteByScopeTypeAndScopeId(String, Long) - Method in interface edu.ucsb.cs156.jobs.repositories.JobsRepository
 
deleteJob(Long) - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
 

E

edu.ucsb.cs156.jobs.config - package edu.ucsb.cs156.jobs.config
 
edu.ucsb.cs156.jobs.controllers - package edu.ucsb.cs156.jobs.controllers
 
edu.ucsb.cs156.jobs.entities - package edu.ucsb.cs156.jobs.entities
 
edu.ucsb.cs156.jobs.errors - package edu.ucsb.cs156.jobs.errors
 
edu.ucsb.cs156.jobs.repositories - package edu.ucsb.cs156.jobs.repositories
 
edu.ucsb.cs156.jobs.services - package edu.ucsb.cs156.jobs.services
 
EntityNotFoundException - Exception Class in edu.ucsb.cs156.jobs.errors
RuntimeException indicating that an entity of a specific type with a given id was not found.
EntityNotFoundException(Class<?>, Object) - Constructor for exception class edu.ucsb.cs156.jobs.errors.EntityNotFoundException
Constructor for the exception

F

findAllByOrderByIdDesc() - Method in interface edu.ucsb.cs156.jobs.repositories.JobsRepository
 
findByJobIdAndIdGreaterThanOrderByIdAsc(Long, Long) - Method in interface edu.ucsb.cs156.jobs.repositories.JobLogRepository
Everything logged since afterId — the incremental "tail -f" query.
findByJobIdOrderByIdAsc(Long) - Method in interface edu.ucsb.cs156.jobs.repositories.JobLogRepository
Full log, chronological order — used to assemble the complete log for one job.
findByScopeTypeAndScopeIdOrderByIdDesc(String, Long) - Method in interface edu.ucsb.cs156.jobs.repositories.JobsRepository
 
findTop10ByJobIdOrderByIdDesc(Long) - Method in interface edu.ucsb.cs156.jobs.repositories.JobLogRepository
The most recent lines, newest first — used for the list/paginated endpoints' preview.

G

getCurrentUserEmail() - Method in interface edu.ucsb.cs156.jobs.services.JobUserProvider
 
getCurrentUserId() - Method in interface edu.ucsb.cs156.jobs.services.JobUserProvider
 
getJob() - Method in class edu.ucsb.cs156.jobs.services.JobContext
Exposes the underlying job, mainly so job bodies and their tests can inspect state (e.g.
getJobById(Long) - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
 
getJobLogPreview(Long) - Method in class edu.ucsb.cs156.jobs.services.JobService
The most recent log lines for one job, joined into a single string oldest-first — used to populate a preview on list/paginated responses without shipping each job's entire log.
getJobLogs(Long) - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
 
getJobLogs(Long) - Method in class edu.ucsb.cs156.jobs.services.JobService
The full log for one job, oldest line first.
getJobLogTail(Long, Long) - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
 
getJobLogTail(Long, Long) - Method in class edu.ucsb.cs156.jobs.services.JobService
Everything logged for this job since afterId (exclusive), oldest first — the incremental "tail -f" query: a polling client passes the highest id it has already seen and gets back only new lines.
getJobName() - Method in interface edu.ucsb.cs156.jobs.services.JobContextConsumer
Name recorded on the Job row and shown in the admin UI.
getScopeId() - Method in interface edu.ucsb.cs156.jobs.services.JobContextConsumer
Optional scope: the id of the app-domain object this job belongs to.
getScopeType() - Method in interface edu.ucsb.cs156.jobs.services.JobContextConsumer
Optional scope: the kind of app-domain object this job belongs to (e.g.

H

handleEntityNotFoundException(Throwable) - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
The apps map these exceptions in an app-level base controller; the library controller cannot extend that, so it carries its own handlers with the same response shape.
handleIllegalArgument(Throwable) - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
 

J

Job - Class in edu.ucsb.cs156.jobs.entities
JPA entity for one asynchronous job: who launched it, its status, and a human-readable log that grows while the job runs.
Job() - Constructor for class edu.ucsb.cs156.jobs.entities.Job
 
JobContext - Class in edu.ucsb.cs156.jobs.services
Handed to a running JobContextConsumer; each JobContext.log(java.lang.String) call appends one line to the job's log, so admins can watch progress live.
JobContext(JobLogRepository, Job, TransactionTemplate) - Constructor for class edu.ucsb.cs156.jobs.services.JobContext
 
JobContext(JobsRepository, Job) - Constructor for class edu.ucsb.cs156.jobs.services.JobContext
Deprecated.
kept only so existing test code written against v0.1.x (new JobContext(null, job)) keeps compiling; the jobsRepository parameter is ignored. Use JobContext(JobLogRepository, Job, TransactionTemplate).
JobContextConsumer - Interface in edu.ucsb.cs156.jobs.services
A concrete job: the code that runs asynchronously, receiving a JobContext for logging.
JobContextFactory - Class in edu.ucsb.cs156.jobs.services
Creates JobContext instances; exists as a seam so tests can substitute contexts.
JobContextFactory(JobLogRepository, PlatformTransactionManager) - Constructor for class edu.ucsb.cs156.jobs.services.JobContextFactory
 
JobLog - Class in edu.ucsb.cs156.jobs.entities
One line of a Job's log, stored as its own row rather than appended into a single growing TEXT column on jobs.
JobLog() - Constructor for class edu.ucsb.cs156.jobs.entities.JobLog
 
JobLogRepository - Interface in edu.ucsb.cs156.jobs.repositories
 
JobRateLimit - Class in edu.ucsb.cs156.jobs.services
Configurable delay for rate limiting calls to external APIs from inside jobs.
JobRateLimit(String) - Constructor for class edu.ucsb.cs156.jobs.services.JobRateLimit
 
JobsAutoConfiguration - Class in edu.ucsb.cs156.jobs.config
Auto-configuration for the jobs system; activates when the library is on the classpath.
JobsAutoConfiguration() - Constructor for class edu.ucsb.cs156.jobs.config.JobsAutoConfiguration
 
JobsController - Class in edu.ucsb.cs156.jobs.controllers
Admin REST API for job records: list (all or paginated, filterable, sortable by any field), fetch one, fetch logs (full or incremental tail), delete one or all.
JobsController() - Constructor for class edu.ucsb.cs156.jobs.controllers.JobsController
 
JobService - Class in edu.ucsb.cs156.jobs.services
Creates Job rows and runs JobContextConsumers asynchronously on the jobsExecutor, recording status and log output as they run.
JobService() - Constructor for class edu.ucsb.cs156.jobs.services.JobService
 
jobsExecutor(int, int, int) - Method in class edu.ucsb.cs156.jobs.config.JobsAutoConfiguration
 
JobsRepository - Interface in edu.ucsb.cs156.jobs.repositories
Spring Data repository for Job entities.
JobUserProvider - Interface in edu.ucsb.cs156.jobs.services
Bridge between the library and the consuming app's notion of "current user".

L

libJobsContextFactory(JobLogRepository, PlatformTransactionManager) - Method in class edu.ucsb.cs156.jobs.config.JobsAutoConfiguration
 
libJobsController() - Method in class edu.ucsb.cs156.jobs.config.JobsAutoConfiguration
 
libJobsRateLimit(String) - Method in class edu.ucsb.cs156.jobs.config.JobsAutoConfiguration
 
libJobsService() - Method in class edu.ucsb.cs156.jobs.config.JobsAutoConfiguration
 
log(String) - Method in class edu.ucsb.cs156.jobs.services.JobContext
 
LOG_PREVIEW_LINES - Static variable in class edu.ucsb.cs156.jobs.controllers.JobsController
Number of trailing log lines included as a preview on list/paginated responses.

P

paginatedJobs(int, int, String, String, String, String, String, String, Long) - Method in class edu.ucsb.cs156.jobs.controllers.JobsController
 

R

runAsJob(JobContextConsumer) - Method in class edu.ucsb.cs156.jobs.services.JobService
 
runJobAsync(Job, JobContextConsumer) - Method in class edu.ucsb.cs156.jobs.services.JobService
Runs a job asynchronously.

S

sleep() - Method in class edu.ucsb.cs156.jobs.services.JobRateLimit
 
A C D E F G H J L P R S 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form