org.opencastproject.rest

Class OsgiAbstractJobProducerEndpoint<A>

java.lang.Object

org.opencastproject.rest.AbstractJobProducerEndpoint

org.opencastproject.rest.OsgiAbstractJobProducerEndpoint<A>

public abstract class OsgiAbstractJobProducerEndpoint<A>
extends AbstractJobProducerEndpoint

Refined implementation of AbstractJobProducerEndpoint suitable for use in an OSGi environment.

OSGi dependency injection methods are provided to reduce the amount of boilerplate code needed per service implementation.

Declare as type variable the job producing service on which the endpoint depends.

Example: The endpoint for the WorkflowService can be declared like this:

   public final class WorkflowServiceEndpoint extends OsgiAbstractJobProducerEndpoint<WorkflowServiceImpl>
 

Implementation note: Type variable A cannot have upper bound JobProducer. Even though this may seem reasonable it will cause trouble with OSGi dependency injection. The dependency will most likely be declared on the service's interface and not the concrete implementation. But only the concrete implementation is a JobProducer. With A having an upper bound of JobProducer the signature of setService(Object) will be fixed to that bound: setService(JobProducer). Now the service cannot be injected anymore.

Constructor Summary

Constructors

Constructor and Description
OsgiAbstractJobProducerEndpoint()

Method Summary

Modifier and Type	Method and Description
JobProducer	getService() Returns the job producer that is backing this REST endpoint.
ServiceRegistry	getServiceRegistry() Return the service registry.
A	getSvc()
void	setService(A service)
void	setServiceRegistry(ServiceRegistry serviceRegistry)

Methods inherited from class org.opencastproject.rest.AbstractJobProducerEndpoint

checkHeartbeat, dispatchJob

Methods inherited from class java.lang.Object

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

Constructor Detail

OsgiAbstractJobProducerEndpoint

public OsgiAbstractJobProducerEndpoint()

Method Detail

getService

public JobProducer getService()

Description copied from class: AbstractJobProducerEndpoint

Returns the job producer that is backing this REST endpoint.

Specified by:

getService in class AbstractJobProducerEndpoint

Returns:

the job producer

setService

public void setService(A service)

getSvc

public A getSvc()

getServiceRegistry

public ServiceRegistry getServiceRegistry()

Description copied from class: AbstractJobProducerEndpoint

Return the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducerEndpoint

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)