Package org.opencastproject.serviceregistry.impl

Class ServiceRegistryJpaImpl

java.lang.Object

org.opencastproject.serviceregistry.impl.ServiceRegistryJpaImpl

All Implemented Interfaces:

ServiceRegistry, org.osgi.service.cm.ManagedService

public class ServiceRegistryJpaImpl
extends Object
implements ServiceRegistry, org.osgi.service.cm.ManagedService

JPA implementation of the ServiceRegistry

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	acceptJobLoadsExeedingMaxLoad	Whether to accept a job whose load exceeds the host’s max load
protected TrustedHttpClient	client	The http client to use when connecting to remote servers
protected boolean	collectJobstats	Whether to collect detailed job statistics
protected DBSession	db
protected DBSessionFactory	dbSessionFactory
protected javax.persistence.EntityManagerFactory	emf	The factory used to generate the entity manager
protected static double	encodingThreshold	Threshold value under which defined workers get preferred when dispatching encoding jobs
protected static List<String>	encodingWorkers	Comma-seperate list with URLs of encoding specialised workers
protected String	hostName	This host's base URL
protected Incidents	incidents
protected IncidentService	incidentService
protected List<ObjectInstance>	jmxBeans	The list of registered JMX beans
protected static final List<Job.Status>	JOB_STATUSES_INFLUENCING_LOAD_BALANCING	A static list of statuses that influence how load balancing is calculated
protected static HashMap<Long,Float>	jobCache
protected String	jobHost	The base URL for job URLs
protected float	localSystemLoad
protected int	maxAttemptsBeforeErrorState	Number of failed jobs on a service before to set it in error state. -1 will disable error states completely.
protected int	maxJobAge	Maximum age of jobs being considering for service statistics
protected String	nodeName	This host's descriptive node name eg admin, worker01
protected static final String	OPT_ENCODING_THRESHOLD	Configuration key for the encoding workers load threshold
protected static final String	OPT_ENCODING_WORKERS	Configuration key for the encoding preferred worker nodes
protected static final String	OPT_HEARTBEATINTERVAL	Configuration key for the interval to check whether the hosts in the service registry are still alive, in seconds
protected static final String	OPT_JOBSTATISTICS	Configuration key for the collection of job statistics
protected static final String	OPT_MAXLOAD	Configuration key for the maximum load
protected static final String	OPT_SERVICE_STATISTICS_MAX_JOB_AGE	Configuration key for the retrieval of service statistics: Do not consider jobs older than max_job_age (in days)
static final String	PERSISTENCE_UNIT	JPA persistence unit name
static final String	RESUME	Id of the workflow's resume operation, need to match the corresponding enum value in WorkflowServiceImpl
protected ScheduledExecutorService	scheduledExecutor	The thread pool to use for dispatching queued jobs and checking on phantom services.
protected SecurityService	securityService	The security service
static final String	START_OPERATION	Id of the workflow's start operation operation, need to match the corresponding enum value in WorkflowServiceImpl
static final String	START_WORKFLOW	Id of the workflow's start workflow operation, need to match the corresponding enum value in WorkflowServiceImpl
static final String	TYPE_WORKFLOW	Identifier for the workflow service

Constructor Summary

Constructors

Constructor	Description
ServiceRegistryJpaImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)
long	count(String serviceType, String host, String operation, Job.Status status)	Count the number of jobs executing the given operation in this Job.Status on this host.
long	count(String serviceType, Job.Status status)	Count the number of jobs that match the specified parameters.
Map<String,Map<String,Long>>	countActiveByOrganizationAndHost()	Count active jobs and group them by organization and host.
Map<String,Long>	countActiveTypeByOrganization(String operation)	Count active jobs of a given operation type and group them by organization.
long	countByHost(String serviceType, String host, Job.Status status)	Count the number of jobs in this Job.Status on this host
long	countByOperation(String serviceType, String operation, Job.Status status)	Count the number of jobs running the given operation in this Job.Status.
Job	createJob(String type, String operation)	Create and store a new job that will be dispatched as soon as possible.
Job	createJob(String host, String serviceType, String operation, List<String> arguments, String payload, boolean dispatchable, Job parentJob)	Creates a job on a remote host with a jobLoad of 1.0.
Job	createJob(String host, String serviceType, String operation, List<String> arguments, String payload, boolean dispatchable, Job parentJob, float jobLoad)	Creates a job on a remote host.
Job	createJob(String type, String operation, List<String> arguments)	Create and store a new job that will be dispatched as soon as possible.
Job	createJob(String type, String operation, List<String> arguments, Float jobLoad)	Create and store a new job that will be dispatched as soon as possible.
Job	createJob(String type, String operation, List<String> arguments, String payload, boolean dispatchable)	Create and store a new job.
Job	createJob(String type, String operation, List<String> arguments, String payload, boolean dispatchable, Float jobLoad)	Create and store a new job.
Job	createJob(String type, String operation, List<String> arguments, String payload, boolean dispatchable, Job parentJob)
Job	createJob(String type, String operation, List<String> arguments, String payload, boolean dispatchable, Job parentJob, Float jobLoad)	Create and store a new job.
void	deactivate()
void	disableHost(String host)	Disables a Opencast server from service.
void	enableHost(String host)	Enable an inactive host as a provider of Opencast services.
protected Function<javax.persistence.EntityManager,Optional<HostRegistrationJpaImpl>>	fetchHostRegistrationQuery(String host)	Fetches a host registration from persistence.
List<Job>	getActiveJobs()	Get the list of active jobs.
List<Job>	getChildJobs(long id)	Get all child jobs from a job
SystemLoad	getCurrentHostLoads()	Gets a map of hosts to the number of jobs currently loading that host
Job	getCurrentJob()	Gets the current running job
protected Function<javax.persistence.EntityManager,List<JpaJob>>	getDispatchableJobsWithStatusQuery(int offset, int limit, Job.Status... statuses)	Gets jobs of all types that are in the given state.
HostRegistration	getHostRegistration(String hostname)	Finds host registration for the given hostname.
protected Function<javax.persistence.EntityManager,HostRegistration>	getHostRegistrationQuery(String hostname)
List<HostRegistration>	getHostRegistrations()	Gets all host registrations
protected Function<javax.persistence.EntityManager,List<HostRegistration>>	getHostRegistrationsQuery()	Gets all host registrations
HostStatistics	getHostStatistics()	Get statistics about jobs active on hosts.
Job	getJob(long id)	Gets a receipt by its ID, or null if not found
int	getJobCount(String operation)	Return the number of jobs for a specified operation type.
List<String>	getJobPayloads(String operation)	Return the payload of all jobs for a specified operation type.
List<String>	getJobPayloads(String operation, int limit, int offset)	Return the payload of a specified number of jobs for a specified operation type.
List<Job>	getJobs(String type, Job.Status status)	Gets the list of jobs that match the specified parameters.
Function<javax.persistence.EntityManager,List<JpaJob>>	getJobsByStatusQuery(Job.Status... statuses)	Get the list of jobs with status from the given statuses.
SystemLoad.NodeLoad	getMaxLoadOnNode(String host)	Returns the maximum load that can be handled by a given node.
SystemLoad	getMaxLoads()	Returns the maximum load that can be handled by the currently registered hosts.
float	getOwnLoad()	Gets the load value for the current host (ie, the host this service registry lives on
String	getRegistryHostname()	Returns the service regstry's hostname.
ServiceRegistration	getServiceRegistration(String serviceType, String host)	Finds a single service registration by host and type, even if the service is offline or in maintenance mode.
protected Function<javax.persistence.EntityManager,Optional<ServiceRegistrationJpaImpl>>	getServiceRegistrationQuery(String serviceType, String host)
List<ServiceRegistration>	getServiceRegistrations()	Finds all service registrations, including offline services and those in maintenance mode.
List<ServiceRegistration>	getServiceRegistrationsByHost(String host)	Finds the service registrations on the given host, including offline services and those in maintenance mode.
List<ServiceRegistration>	getServiceRegistrationsByLoad(String serviceType)	Do not look at this, it will burn your eyes!
protected List<ServiceRegistration>	getServiceRegistrationsByLoad(String jobType, List<ServiceRegistration> serviceRegistrations, List<HostRegistration> hostRegistrations, SystemLoad systemLoad)	Returns a filtered list of service registrations, containing only those that are online, not in maintenance mode, and with a specific service type, ordered by load.
List<ServiceRegistration>	getServiceRegistrationsByType(String serviceType)	Finds the service registrations for this kind of job, including offline services and those in maintenance mode.
protected Function<javax.persistence.EntityManager,List<ServiceRegistration>>	getServiceRegistrationsQuery()	Gets all service registrations.
protected List<ServiceRegistration>	getServiceRegistrationsWithCapacity(String jobType, List<ServiceRegistration> serviceRegistrations, List<HostRegistration> hostRegistrations, SystemLoad systemLoad)	Returns a filtered list of service registrations, containing only those that are online, not in maintenance mode, and with a specific service type that are running on a host which is not already maxed out.
List<ServiceStatistics>	getServiceStatistics()	Gets performance and runtime statistics for each known service registration.
Incidents	incident()	Return a facility to record job incidents.
void	modified(Map<String,Object> config)	OSGI callback when the configuration is updated.
void	registerHost(String host, String address, String nodeName, long memory, int cores, float maxLoad)	Registers a host as a provider of Opencast services.
ServiceRegistration	registerService(String serviceType, String baseUrl, String path)	Registers a host to handle a specific type of job
ServiceRegistration	registerService(String serviceType, String baseUrl, String path, boolean jobProducer)	Registers a host to handle a specific type of job
void	removeJobs(List<Long> jobIds)	Deletes the given jobs from the service registry
void	removeParentlessJobs(int lifetime)	Removes all jobs which do not have a parent job (except workflow instance jobs) and which have passed their lifetime.
void	sanitize(String serviceType, String host)	Sets the given service to NORMAL state
void	setCurrentJob(Job job)	Sets the current running job
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	setIncidentService(IncidentService incidentService)	OSGi DI.
protected JpaJob	setJobUri(JpaJob job)
void	setMaintenanceStatus(String baseUrl, boolean maintenance)	Sets a registered host's maintenance status
protected ServiceRegistration	setOnlineStatus(String serviceType, String baseUrl, String path, boolean online, Boolean jobProducer)	Sets the online status of a service registration.
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
void	unregisterHost(String host)	Removes an Opencast server from service.
void	unRegisterService(String serviceType, String baseUrl)	Unregisters a host from handling a specific type of job
void	unsetIncidentService(IncidentService incidentService)
void	updated(Dictionary properties)
protected JpaJob	updateInternal(JpaJob job)	Internal method to update a job, throwing unwrapped JPA exceptions.
Job	updateJob(Job job)	Update the job in the database
void	updateStatisticsJobData()

Methods inherited from class java.lang.Object

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

Field Details

PERSISTENCE_UNIT

public static final String PERSISTENCE_UNIT

JPA persistence unit name

See Also:

• Constant Field Values

START_OPERATION

public static final String START_OPERATION

Id of the workflow's start operation operation, need to match the corresponding enum value in WorkflowServiceImpl

See Also:

• Constant Field Values

START_WORKFLOW

public static final String START_WORKFLOW

Id of the workflow's start workflow operation, need to match the corresponding enum value in WorkflowServiceImpl

See Also:

• Constant Field Values

RESUME

public static final String RESUME

Id of the workflow's resume operation, need to match the corresponding enum value in WorkflowServiceImpl

See Also:

• Constant Field Values

TYPE_WORKFLOW

public static final String TYPE_WORKFLOW

Identifier for the workflow service

See Also:

• Constant Field Values

jmxBeans

protected List<ObjectInstance> jmxBeans

The list of registered JMX beans

OPT_MAXLOAD

protected static final String OPT_MAXLOAD

Configuration key for the maximum load

See Also:

• Constant Field Values

OPT_HEARTBEATINTERVAL

protected static final String OPT_HEARTBEATINTERVAL

Configuration key for the interval to check whether the hosts in the service registry are still alive, in seconds

See Also:

• Constant Field Values

OPT_JOBSTATISTICS

protected static final String OPT_JOBSTATISTICS

Configuration key for the collection of job statistics

See Also:

• Constant Field Values

OPT_SERVICE_STATISTICS_MAX_JOB_AGE

protected static final String OPT_SERVICE_STATISTICS_MAX_JOB_AGE

Configuration key for the retrieval of service statistics: Do not consider jobs older than max_job_age (in days)

See Also:

• Constant Field Values

OPT_ENCODING_WORKERS

protected static final String OPT_ENCODING_WORKERS

Configuration key for the encoding preferred worker nodes

See Also:

• Constant Field Values

OPT_ENCODING_THRESHOLD

protected static final String OPT_ENCODING_THRESHOLD

Configuration key for the encoding workers load threshold

See Also:

• Constant Field Values

client

protected TrustedHttpClient client

The http client to use when connecting to remote servers

maxAttemptsBeforeErrorState

protected int maxAttemptsBeforeErrorState

Number of failed jobs on a service before to set it in error state. -1 will disable error states completely.

hostName

protected String hostName

This host's base URL

nodeName

protected String nodeName

This host's descriptive node name eg admin, worker01

jobHost

protected String jobHost

The base URL for job URLs

encodingWorkers

protected static List<String> encodingWorkers

Comma-seperate list with URLs of encoding specialised workers

encodingThreshold

protected static double encodingThreshold

Threshold value under which defined workers get preferred when dispatching encoding jobs

emf

protected javax.persistence.EntityManagerFactory emf

The factory used to generate the entity manager

dbSessionFactory

protected DBSessionFactory dbSessionFactory

db

protected DBSession db

scheduledExecutor

protected ScheduledExecutorService scheduledExecutor

The thread pool to use for dispatching queued jobs and checking on phantom services.

securityService

protected SecurityService securityService

The security service

incidentService

protected IncidentService incidentService

incidents

protected Incidents incidents

collectJobstats

protected boolean collectJobstats

Whether to collect detailed job statistics

maxJobAge

protected int maxJobAge

Maximum age of jobs being considering for service statistics

JOB_STATUSES_INFLUENCING_LOAD_BALANCING

protected static final List<Job.Status> JOB_STATUSES_INFLUENCING_LOAD_BALANCING

A static list of statuses that influence how load balancing is calculated

jobCache

protected static HashMap<Long,Float> jobCache

acceptJobLoadsExeedingMaxLoad

protected Boolean acceptJobLoadsExeedingMaxLoad

Whether to accept a job whose load exceeds the host’s max load

localSystemLoad

protected float localSystemLoad

Constructor Details

ServiceRegistryJpaImpl

public ServiceRegistryJpaImpl()

Method Details

setDBSessionFactory

public void setDBSessionFactory(DBSessionFactory dbSessionFactory)

activate

public void activate(org.osgi.service.component.ComponentContext cc)

getOwnLoad

public float getOwnLoad()

Description copied from interface: ServiceRegistry

Gets the load value for the current host (ie, the host this service registry lives on

Specified by:

getOwnLoad in interface ServiceRegistry

Returns:

the load value for this host

getRegistryHostname

public String getRegistryHostname()

Description copied from interface: ServiceRegistry

Returns the service regstry's hostname. This can be used to fetch the list of services on the local host.

Specified by:

getRegistryHostname in interface ServiceRegistry

Returns:

The hostname that the service registry is running on.

deactivate

public void deactivate()

createJob

public Job createJob(String type,
 String operation)
              throws ServiceRegistryException

Create and store a new job that will be dispatched as soon as possible. This is equivalent to calling ServiceRegistry.createJob(String, String, List, String, boolean) with an empty argument list.

Note that this job will be linked to the current job as its parent.

Specified by:

createJob in interface ServiceRegistry

Parameters:

type - the type of service responsible for this job

operation - the operation for this service to run

Returns:

the job

Throws:

ServiceRegistryException - if there is a problem creating the job

See Also:

• ServiceRegistry.createJob(java.lang.String, java.lang.String)

createJob

public Job createJob(String type,
 String operation,
 List<String> arguments)
              throws ServiceRegistryException

Create and store a new job that will be dispatched as soon as possible. This is equivalent to calling ServiceRegistry.createJob(String, String, List, String, boolean).

Note that this job will be linked to the current job as its parent.

Specified by:

createJob in interface ServiceRegistry

Parameters:

type - the type of service responsible for this job

operation - the operation for this service to run

arguments - the arguments to the operation

Returns:

the job

Throws:

ServiceRegistryException - if there is a problem creating the job

See Also:

• ServiceRegistry.createJob(java.lang.String, java.lang.String, java.util.List)

createJob

public Job createJob(String type,
 String operation,
 List<String> arguments,
 Float jobLoad)
              throws ServiceRegistryException

Create and store a new job that will be dispatched as soon as possible. This is equivalent to calling ServiceRegistry.createJob(String, String, List, String, boolean).

Note that this job will be linked to the current job as its parent.

Specified by:

createJob in interface ServiceRegistry

Parameters:

type - the type of service responsible for this job

operation - the operation for this service to run

arguments - the arguments to the operation

jobLoad - the load caused by this job, roughly equivalent to the number of cores used this job

Returns:

the job

Throws:

ServiceRegistryException - if there is a problem creating the job

See Also:

• ServiceRegistry.createJob(java.lang.String, java.lang.String, java.util.List, Float)

createJob

public Job createJob(String type,
 String operation,
 List<String> arguments,
 String payload,
 boolean dispatchable)
              throws ServiceRegistryException

Create and store a new job. If enqueueImmediately is true, the job will be in the Job.Status.QUEUED state and will be dispatched as soon as possible. Otherwise, it will be Job.Status.INSTANTIATED.

Note that this job will be linked to the current job as its parent.

Specified by:

createJob in interface ServiceRegistry

Parameters:

type - the type of service responsible for this job

operation - the operation for this service to run

arguments - the arguments to the operation

payload - an optional initial payload

dispatchable - whether the job can be enqueued for dispatch. If false, the job's initial state will be Job.Status.INSTANTIATED and will not be dispatched.

Returns:

the job

Throws:

ServiceRegistryException - if there is a problem creating the job

See Also:

• ServiceRegistry.createJob(java.lang.String, java.lang.String, java.util.List, String, boolean)

createJob

public Job createJob(String type,
 String operation,
 List<String> arguments,
 String payload,
 boolean dispatchable,
 Float jobLoad)
              throws ServiceRegistryException

Create and store a new job. If enqueueImmediately is true, the job will be in the Job.Status.QUEUED state and will be dispatched as soon as possible. Otherwise, it will be Job.Status.INSTANTIATED.

Note that this job will be linked to the current job as its parent.

Specified by:

createJob in interface ServiceRegistry

Parameters:

type - the type of service responsible for this job

operation - the operation for this service to run

arguments - the arguments to the operation

payload - an optional initial payload

dispatchable - whether the job can be enqueued for dispatch. If false, the job's initial state will be Job.Status.INSTANTIATED and will not be dispatched.

jobLoad - the load caused by this job, roughly equivalent to the number of cores used this job

Returns:

the job

Throws:

ServiceRegistryException - if there is a problem creating the job

See Also:

• ServiceRegistry.createJob(java.lang.String, java.lang.String, java.util.List, java.lang.String, boolean, Float)

createJob

public Job createJob(String type,
 String operation,
 List<String> arguments,
 String payload,
 boolean dispatchable,
 Job parentJob)
              throws ServiceRegistryException

Throws:

ServiceRegistryException

createJob

public Job createJob(String type,
 String operation,
 List<String> arguments,
 String payload,
 boolean dispatchable,
 Job parentJob,
 Float jobLoad)
              throws ServiceRegistryException

Create and store a new job. If enqueueImmediately is true, the job will be in the Job.Status.QUEUED state and will be dispatched as soon as possible. Otherwise, it will be Job.Status.INSTANTIATED.

Specified by:

createJob in interface ServiceRegistry

Parameters:

type - the type of service responsible for this job

operation - the operation for this service to run

arguments - the arguments to the operation

payload - an optional initial payload

dispatchable - whether the job can be enqueued for dispatch. If false, the job's initial state will be Job.Status.INSTANTIATED and will not be dispatched.

parentJob - the parent job

jobLoad - the load caused by this job, roughly equivalent to the number of cores used this job

Returns:

the job

Throws:

ServiceRegistryException - if there is a problem creating the job

See Also:

• ServiceRegistry.createJob(java.lang.String, java.lang.String, java.util.List, java.lang.String, boolean, org.opencastproject.job.api.Job, Float)

createJob

public Job createJob(String host,
 String serviceType,
 String operation,
 List<String> arguments,
 String payload,
 boolean dispatchable,
 Job parentJob)
              throws ServiceRegistryException

Creates a job on a remote host with a jobLoad of 1.0.

Throws:

ServiceRegistryException

createJob

public Job createJob(String host,
 String serviceType,
 String operation,
 List<String> arguments,
 String payload,
 boolean dispatchable,
 Job parentJob,
 float jobLoad)
              throws ServiceRegistryException

Creates a job on a remote host.

Throws:

ServiceRegistryException

removeJobs

public void removeJobs(List<Long> jobIds)
                throws NotFoundException,
ServiceRegistryException

Description copied from interface: ServiceRegistry

Deletes the given jobs from the service registry

Specified by:

removeJobs in interface ServiceRegistry

Parameters:

jobIds - the job ids

Throws:

NotFoundException

ServiceRegistryException

removeParentlessJobs

public void removeParentlessJobs(int lifetime)
                          throws ServiceRegistryException

Description copied from interface: ServiceRegistry

Removes all jobs which do not have a parent job (except workflow instance jobs) and which have passed their lifetime.

Specified by:

removeParentlessJobs in interface ServiceRegistry

Parameters:

lifetime - lifetime in days

Throws:

ServiceRegistryException - if removing the jobs fails

updated

public void updated(Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

See Also:

• ManagedService.updated(java.util.Dictionary)

modified

public void modified(Map<String,Object> config)
              throws org.osgi.service.cm.ConfigurationException

OSGI callback when the configuration is updated. This method is only here to prevent the configuration admin service from calling the service deactivate and activate methods for a config update. It does not have to do anything as the updates are handled by updated().

Throws:

org.osgi.service.cm.ConfigurationException

getJob

public Job getJob(long id)
           throws NotFoundException,
ServiceRegistryException

Description copied from interface: ServiceRegistry

Gets a receipt by its ID, or null if not found

Specified by:

getJob in interface ServiceRegistry

Parameters:

id - the job id

Returns:

the job or null

Throws:

NotFoundException

ServiceRegistryException

getCurrentJob

public Job getCurrentJob()

Gets the current running job

Specified by:

getCurrentJob in interface ServiceRegistry

Returns:

the current job

See Also:

• ServiceRegistry.getCurrentJob()

setCurrentJob

public void setCurrentJob(Job job)

Sets the current running job

Specified by:

setCurrentJob in interface ServiceRegistry

Parameters:

job - the current job

See Also:

• ServiceRegistry.setCurrentJob(Job)

updateJob

public Job updateJob(Job job)
              throws ServiceRegistryException

Description copied from interface: ServiceRegistry

Update the job in the database

Specified by:

updateJob in interface ServiceRegistry

Parameters:

job -

Returns:

the updated job

Throws:

ServiceRegistryException - if there is a problem updating the job

setJobUri

protected JpaJob setJobUri(JpaJob job)

updateInternal

protected JpaJob updateInternal(JpaJob job)
                         throws NotFoundException

Internal method to update a job, throwing unwrapped JPA exceptions.

Parameters:

job - the job to update

Returns:

the updated job

Throws:

NotFoundException

updateStatisticsJobData

public void updateStatisticsJobData()

fetchHostRegistrationQuery

protected Function<javax.persistence.EntityManager,Optional<HostRegistrationJpaImpl>> fetchHostRegistrationQuery(String host)

Fetches a host registration from persistence.

Parameters:

host - the host name

Returns:

the host registration, or null if none exists

registerHost

public void registerHost(String host,
 String address,
 String nodeName,
 long memory,
 int cores,
 float maxLoad)
                  throws ServiceRegistryException

Registers a host as a provider of Opencast services.

Specified by:

registerHost in interface ServiceRegistry

Parameters:

host - The base URL for this server

address - The IP address of this host

nodeName - Human readable description of this node

memory - The allocated memory of this host

cores - The available cores of this host

maxLoad - the maximum load this host can support

Throws:

ServiceRegistryException - if communication with the service registry fails

See Also:

• ServiceRegistry.registerHost(String, String, String, long, int, float)

unregisterHost

public void unregisterHost(String host)
                    throws ServiceRegistryException

Removes an Opencast server from service.

Specified by:

unregisterHost in interface ServiceRegistry

Parameters:

host - The base URL for this server

Throws:

ServiceRegistryException - if communication with the service registry fails

See Also:

• ServiceRegistry.unregisterHost(java.lang.String)

enableHost

public void enableHost(String host)
                throws ServiceRegistryException,
NotFoundException

Enable an inactive host as a provider of Opencast services.

Specified by:

enableHost in interface ServiceRegistry

Parameters:

host - The base URL for this server

Throws:

ServiceRegistryException - if communication with the service registry fails

NotFoundException - if the host does not exist

See Also:

• ServiceRegistry.enableHost(String)

disableHost

public void disableHost(String host)
                 throws ServiceRegistryException,
NotFoundException

Disables a Opencast server from service.

Specified by:

disableHost in interface ServiceRegistry

Parameters:

host - The base URL for this server

Throws:

ServiceRegistryException - if communication with the service registry fails

NotFoundException - if the host does not exist

See Also:

• ServiceRegistry.disableHost(String)

registerService

public ServiceRegistration registerService(String serviceType,
 String baseUrl,
 String path)
                                    throws ServiceRegistryException

Registers a host to handle a specific type of job

Specified by:

registerService in interface ServiceRegistry

Parameters:

serviceType - The job type

baseUrl - The base URL where the service that can handle this service type can be found

path - The path to the service endpoint

Returns:

the service registration

Throws:

ServiceRegistryException - if communication with the service registry fails

See Also:

• ServiceRegistry.registerService(java.lang.String, java.lang.String, java.lang.String)

registerService

public ServiceRegistration registerService(String serviceType,
 String baseUrl,
 String path,
 boolean jobProducer)
                                    throws ServiceRegistryException

Registers a host to handle a specific type of job

Specified by:

registerService in interface ServiceRegistry

Parameters:

serviceType - The service type

baseUrl - The base URL where the service that can handle this job type can be found

path - The path to the service endpoint

jobProducer - Whether this service registration produces Jobs to track long running operations

Returns:

the service registration

Throws:

ServiceRegistryException - if communication with the service registry fails

See Also:

• ServiceRegistry.registerService(java.lang.String, java.lang.String, java.lang.String, boolean)

getServiceRegistrationQuery

protected Function<javax.persistence.EntityManager,Optional<ServiceRegistrationJpaImpl>> getServiceRegistrationQuery(String serviceType,
 String host)

setOnlineStatus

protected ServiceRegistration setOnlineStatus(String serviceType,
 String baseUrl,
 String path,
 boolean online,
 Boolean jobProducer)
                                       throws ServiceRegistryException

Sets the online status of a service registration.

Parameters:

serviceType - The job type

baseUrl - the host URL

online - whether the service is online or off

jobProducer - whether this service produces jobs for long running operations

Returns:

the service registration

Throws:

ServiceRegistryException

unRegisterService

public void unRegisterService(String serviceType,
 String baseUrl)
                       throws ServiceRegistryException

Unregisters a host from handling a specific type of job

Specified by:

unRegisterService in interface ServiceRegistry

Parameters:

serviceType - The service type

baseUrl - The base URL where the service that can handle this job type can be found

Throws:

ServiceRegistryException - if communication with the service registry fails

See Also:

• ServiceRegistry.unRegisterService(java.lang.String, java.lang.String)

setMaintenanceStatus

public void setMaintenanceStatus(String baseUrl,
 boolean maintenance)
                          throws NotFoundException

Sets a registered host's maintenance status

Specified by:

setMaintenanceStatus in interface ServiceRegistry

Parameters:

baseUrl - The base URL where the service that can handle this service type can be found

maintenance - the new maintenance status for this service

Throws:

NotFoundException - if the host does not exist

See Also:

• ServiceRegistry.setMaintenanceStatus(java.lang.String, boolean)

getServiceRegistrations

public List<ServiceRegistration> getServiceRegistrations()

Finds all service registrations, including offline services and those in maintenance mode.

Specified by:

getServiceRegistrations in interface ServiceRegistry

Returns:

A list of service registrations

See Also:

• ServiceRegistry.getServiceRegistrations()

incident

public Incidents incident()

Description copied from interface: ServiceRegistry

Return a facility to record job incidents.

Specified by:

incident in interface ServiceRegistry

See Also:

• Incident

getServiceRegistrationsQuery

protected Function<javax.persistence.EntityManager,List<ServiceRegistration>> getServiceRegistrationsQuery()

Gets all service registrations.

Returns:

the list of service registrations

getHostRegistrations

public List<HostRegistration> getHostRegistrations()

Gets all host registrations

Specified by:

getHostRegistrations in interface ServiceRegistry

Returns:

the list of host registrations

getHostStatistics

public HostStatistics getHostStatistics()

Description copied from interface: ServiceRegistry

Get statistics about jobs active on hosts.

Specified by:

getHostStatistics in interface ServiceRegistry

Returns:

Host statistics

getHostRegistrationsQuery

protected Function<javax.persistence.EntityManager,List<HostRegistration>> getHostRegistrationsQuery()

Gets all host registrations

Returns:

the list of host registrations

getHostRegistration

public HostRegistration getHostRegistration(String hostname)
                                     throws ServiceRegistryException

Description copied from interface: ServiceRegistry

Finds host registration for the given hostname.

Specified by:

getHostRegistration in interface ServiceRegistry

Parameters:

hostname - to lookup

Returns:

host registrations

Throws:

ServiceRegistryException - if there is a problem accessing the service registry or the hostname is not found

getHostRegistrationQuery

protected Function<javax.persistence.EntityManager,HostRegistration> getHostRegistrationQuery(String hostname)

getChildJobs

public List<Job> getChildJobs(long id)
                       throws ServiceRegistryException

Get all child jobs from a job

Specified by:

getChildJobs in interface ServiceRegistry

Parameters:

id - the parent job id

Returns:

a list of the child jobs ordered by execution

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.getChildJobs(long)

getJobs

public List<Job> getJobs(String type,
 Job.Status status)
                  throws ServiceRegistryException

Gets the list of jobs that match the specified parameters.

Specified by:

getJobs in interface ServiceRegistry

Parameters:

type - The jobs run by this type of service. If null, jobs from all hosts will be returned.

status - The status of the jobs. If null, jobs in all status will be returned.

Returns:

the jobs matching these criteria

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.getJobs(java.lang.String, Status)

getJobPayloads

public List<String> getJobPayloads(String operation)
                            throws ServiceRegistryException

Description copied from interface: ServiceRegistry

Return the payload of all jobs for a specified operation type.

Specified by:

getJobPayloads in interface ServiceRegistry

Parameters:

operation - Operation type to get payload for

Returns:

Serialized workflows

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

getJobPayloads

public List<String> getJobPayloads(String operation,
 int limit,
 int offset)
                            throws ServiceRegistryException

Description copied from interface: ServiceRegistry

Return the payload of a specified number of jobs for a specified operation type.

Specified by:

getJobPayloads in interface ServiceRegistry

Parameters:

operation - Operation type to get payload for

limit - How many results to return

offset - Offset for the set of returned results

Returns:

Serialized workflows

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

getJobCount

public int getJobCount(String operation)
                throws ServiceRegistryException

Description copied from interface: ServiceRegistry

Return the number of jobs for a specified operation type.

Specified by:

getJobCount in interface ServiceRegistry

Parameters:

operation - Operation type to check for

Returns:

Number of jobs for the specified operation type.

Throws:

ServiceRegistryException

getActiveJobs

public List<Job> getActiveJobs()
                        throws ServiceRegistryException

Get the list of active jobs.

Specified by:

getActiveJobs in interface ServiceRegistry

Returns:

list of active jobs

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.getActiveJobs()

getJobsByStatusQuery

public Function<javax.persistence.EntityManager,List<JpaJob>> getJobsByStatusQuery(Job.Status... statuses)

Get the list of jobs with status from the given statuses.

Parameters:

statuses - variable sized array of status values to test on jobs

Returns:

list of jobs with status from statuses

countActiveByOrganizationAndHost

public Map<String,Map<String,Long>> countActiveByOrganizationAndHost()

Description copied from interface: ServiceRegistry

Count active jobs and group them by organization and host.

Specified by:

countActiveByOrganizationAndHost in interface ServiceRegistry

Returns:

Map of organizations, hosts and the number of jobs.

countActiveTypeByOrganization

public Map<String,Long> countActiveTypeByOrganization(String operation)

Description copied from interface: ServiceRegistry

Count active jobs of a given operation type and group them by organization.

Specified by:

countActiveTypeByOrganization in interface ServiceRegistry

Returns:

Map of organizations and the number of jobs.

getDispatchableJobsWithStatusQuery

protected Function<javax.persistence.EntityManager,List<JpaJob>> getDispatchableJobsWithStatusQuery(int offset,
 int limit,
 Job.Status... statuses)

Gets jobs of all types that are in the given state.

Parameters:

offset - apply offset to the db query if offset > 0

limit - apply limit to the db query if limit > 0

statuses - the job status should be one from the given statuses

Returns:

the list of jobs waiting for dispatch

count

public long count(String serviceType,
 Job.Status status)
           throws ServiceRegistryException

Count the number of jobs that match the specified parameters.

Specified by:

count in interface ServiceRegistry

Parameters:

serviceType - The jobs run by this type of service. If null, the returned count will refer to all types of jobs.

status - The status of the receipts. If null, the returned count will refer to jobs in any status.

Returns:

the number of jobs

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.count(java.lang.String, Status)

countByHost

public long countByHost(String serviceType,
 String host,
 Job.Status status)
                 throws ServiceRegistryException

Count the number of jobs in this Job.Status on this host

Specified by:

countByHost in interface ServiceRegistry

Parameters:

serviceType - The jobs run by this type of service

host - The server that created and will be handling the job

status - The status of the jobs

Returns:

the number of jobs

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.countByHost(java.lang.String, java.lang.String, Status)

countByOperation

public long countByOperation(String serviceType,
 String operation,
 Job.Status status)
                      throws ServiceRegistryException

Count the number of jobs running the given operation in this Job.Status.

Specified by:

countByOperation in interface ServiceRegistry

Parameters:

serviceType - The jobs run by this type of service

operation - the operation

status - The status of the jobs

Returns:

the number of jobs

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.countByOperation(java.lang.String, java.lang.String, Status)

count

public long count(String serviceType,
 String host,
 String operation,
 Job.Status status)
           throws ServiceRegistryException

Count the number of jobs executing the given operation in this Job.Status on this host.

Specified by:

count in interface ServiceRegistry

Parameters:

serviceType - The jobs run by this type of service

host - The server that created and will be handling the job

operation - the operation

status - The status of the jobs

Returns:

the number of jobs

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.count(java.lang.String, java.lang.String, java.lang.String, Status)

getServiceStatistics

public List<ServiceStatistics> getServiceStatistics()
                                             throws ServiceRegistryException

Gets performance and runtime statistics for each known service registration.

Specified by:

getServiceStatistics in interface ServiceRegistry

Returns:

the service statistics

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.getServiceStatistics()

getServiceRegistrationsByLoad

public List<ServiceRegistration> getServiceRegistrationsByLoad(String serviceType)
                                                        throws ServiceRegistryException

Do not look at this, it will burn your eyes! This is due to JPA's inability to do a left outer join with join conditions. Finds the service registrations for this kind of job, ordered by load (lightest to heaviest).

Specified by:

getServiceRegistrationsByLoad in interface ServiceRegistry

Parameters:

serviceType - The type of service that must be handled by the hosts

Returns:

A list of hosts that handle this job type, in order of their running and queued job load

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.getServiceRegistrationsByLoad(java.lang.String)

getCurrentHostLoads

public SystemLoad getCurrentHostLoads()

Gets a map of hosts to the number of jobs currently loading that host

Specified by:

getCurrentHostLoads in interface ServiceRegistry

Returns:

the map of hosts to job counts

See Also:

• ServiceRegistry.getCurrentHostLoads()

getServiceRegistrationsByType

public List<ServiceRegistration> getServiceRegistrationsByType(String serviceType)
                                                        throws ServiceRegistryException

Finds the service registrations for this kind of job, including offline services and those in maintenance mode.

Specified by:

getServiceRegistrationsByType in interface ServiceRegistry

Parameters:

serviceType - The type of service that must be handled by the hosts

Returns:

A list of hosts that handle this job type

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.getServiceRegistrationsByType(java.lang.String)

getServiceRegistrationsByHost

public List<ServiceRegistration> getServiceRegistrationsByHost(String host)
                                                        throws ServiceRegistryException

Finds the service registrations on the given host, including offline services and those in maintenance mode.

Specified by:

getServiceRegistrationsByHost in interface ServiceRegistry

Parameters:

host - The host

Returns:

A list of service registrations on a single host

Throws:

ServiceRegistryException - if there is a problem accessing the service registry

See Also:

• ServiceRegistry.getServiceRegistrationsByHost(java.lang.String)

getServiceRegistration

public ServiceRegistration getServiceRegistration(String serviceType,
 String host)

Finds a single service registration by host and type, even if the service is offline or in maintenance mode.

Specified by:

getServiceRegistration in interface ServiceRegistry

Parameters:

serviceType - The type of service

host - the base URL of the host

Returns:

The service registration, or null

See Also:

• ServiceRegistry.getServiceRegistration(java.lang.String, java.lang.String)

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setIncidentService

public void setIncidentService(IncidentService incidentService)

OSGi DI.

unsetIncidentService

public void unsetIncidentService(IncidentService incidentService)

sanitize

public void sanitize(String serviceType,
 String host)
              throws NotFoundException

Sets the given service to NORMAL state

Specified by:

sanitize in interface ServiceRegistry

Parameters:

serviceType - the service type

host - the host

Throws:

NotFoundException - if the service does not exist

See Also:

• ServiceRegistry.sanitize(java.lang.String, java.lang.String)

getServiceRegistrationsWithCapacity

protected List<ServiceRegistration> getServiceRegistrationsWithCapacity(String jobType,
 List<ServiceRegistration> serviceRegistrations,
 List<HostRegistration> hostRegistrations,
 SystemLoad systemLoad)

Returns a filtered list of service registrations, containing only those that are online, not in maintenance mode, and with a specific service type that are running on a host which is not already maxed out.

Parameters:

jobType - the job type for which the services registrations are filtered

serviceRegistrations - the complete list of service registrations

hostRegistrations - the complete list of available host registrations

systemLoad - the map of hosts to the number of running jobs

getServiceRegistrationsByLoad

protected List<ServiceRegistration> getServiceRegistrationsByLoad(String jobType,
 List<ServiceRegistration> serviceRegistrations,
 List<HostRegistration> hostRegistrations,
 SystemLoad systemLoad)

Returns a filtered list of service registrations, containing only those that are online, not in maintenance mode, and with a specific service type, ordered by load.

Parameters:

jobType - the job type for which the services registrations are filtered

serviceRegistrations - the complete list of service registrations

hostRegistrations - the complete list of available host registrations

systemLoad -

getMaxLoads

public SystemLoad getMaxLoads()
                       throws ServiceRegistryException

Returns the maximum load that can be handled by the currently registered hosts. Note that this load is *not* 1-to-1 equivalent with number of jobs. A job may take up more than one load.

Specified by:

getMaxLoads in interface ServiceRegistry

Returns:

the total load that can be processed concurrently

Throws:

ServiceRegistryException - if communication with the service registry fails

See Also:

• ServiceRegistry.getMaxLoads()

getMaxLoadOnNode

public SystemLoad.NodeLoad getMaxLoadOnNode(String host)
                                     throws ServiceRegistryException,
NotFoundException

Returns the maximum load that can be handled by a given node. Note that this load is *not* 1-to-1 equivalent with number of jobs. A job may take up more than one load.

Specified by:

getMaxLoadOnNode in interface ServiceRegistry

Parameters:

host - The base URL for this server

Returns:

the total load that can be processed concurrently on that node

Throws:

ServiceRegistryException - if communication with the service registry fails

NotFoundException

See Also:

• ServiceRegistry.getMaxLoadOnNode(java.lang.String)