Package org.opencastproject.external.endpoint

Class EventsEndpoint

java.lang.Object

org.opencastproject.external.endpoint.EventsEndpoint

All Implemented Interfaces:

org.osgi.service.cm.ManagedService

@Path("/api/events")
@Produces({"application/json","application/v1.0.0+json","application/v1.1.0+json","application/v1.2.0+json","application/v1.3.0+json","application/v1.4.0+json","application/v1.5.0+json","application/v1.6.0+json","application/v1.7.0+json","application/v1.8.0+json","application/v1.9.0+json","application/v1.10.0+json","application/v1.11.0+json"})
public class EventsEndpoint
extends Object
implements org.osgi.service.cm.ManagedService

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Long	DEFAULT_URL_SIGNING_EXPIRE_DURATION	The default time before a piece of signed content expires. 2 Hours.
protected String	endpointBaseUrl	Base URL of this endpoint
protected static final String	URL_SIGNING_EXPIRES_DURATION_SECONDS_KEY

Constructor Summary

Constructors

Constructor	Description
EventsEndpoint()

Method Summary

Modifier and Type	Method	Description
void	addCatalogUIAdapter(EventCatalogUIAdapter catalogUIAdapter)	OSGi DI.
javax.ws.rs.core.Response	addEventAce(String acceptHeader, String id, String action, String role)
javax.ws.rs.core.Response	createNewEvent(String acceptHeader, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteEvent(String acceptHeader, String id)
javax.ws.rs.core.Response	deleteEventAce(String acceptHeader, String id, String action, String role)
javax.ws.rs.core.Response	deleteEventMetadataByType(String acceptHeader, String id, String type)
protected com.entwinemedia.fn.data.json.JValue	eventToJSON(Event event, Boolean withAcl, Boolean withMetadata, Boolean withScheduling, Boolean withPublications, Boolean includeInternalPublication, Boolean withSignedUrls, ApiVersion requestedVersion)	Transform an Event to Json
protected static AccessControlList	getAclFromEvent(Event event)	Get an AccessControlList from an Event.
CaptureAgentStateService	getAgentStateService()	OSGi DI
javax.ws.rs.core.Response	getAllEventMetadata(String acceptHeader, String id, String type)
javax.ws.rs.core.Response	getEvent(String acceptHeader, String id, boolean sign, Boolean withAcl, Boolean withMetadata, Boolean withScheduling, Boolean withPublications, Boolean includeInternalPublication)
javax.ws.rs.core.Response	getEventAcl(String acceptHeader, String id)
List<EventCatalogUIAdapter>	getEventCatalogUIAdapters(String organization)
javax.ws.rs.core.Response	getEventMedia(String acceptHeader, String id)
protected com.entwinemedia.fn.data.Opt<MetadataList>	getEventMetadata(Event event)
protected com.entwinemedia.fn.data.Opt<MetadataList>	getEventMetadataById(String id)
javax.ws.rs.core.Response	getEventPublication(String acceptHeader, String eventId, String publicationId, boolean sign)
javax.ws.rs.core.Response	getEventPublications(String acceptHeader, String id, boolean sign, boolean includeInternalPublication)
javax.ws.rs.core.Response	getEvents(String acceptHeader, String id, String reasonFilter, String resolutionFilter, List<String> filter, String sort, Integer offset, Integer limit, boolean sign, Boolean withAcl, Boolean withMetadata, Boolean withScheduling, Boolean onlyWithWriteAccess, Boolean withPublications, Boolean includeInternalPublication)
javax.ws.rs.core.Response	getEventScheduling(String acceptHeader, String id)
protected javax.ws.rs.core.Response	getJsonEvents(String acceptHeader, List<IndexObject> events, Boolean withAcl, Boolean withMetadata, Boolean withScheduling, Boolean withPublications, Boolean includeInternalPublication, Boolean withSignedUrls, ApiVersion requestedVersion)	Render a collection of Events into a json array.
com.entwinemedia.fn.data.json.JObject	getPublication(Publication publication, Boolean sign, ApiVersion requestedVersion)
SchedulerService	getSchedulerService()
SecurityService	getSecurityService()
static <T> boolean	isNullOrEmpty(List<String> list)
void	removeCatalogUIAdapter(EventCatalogUIAdapter catalogUIAdapter)	OSGi DI.
void	setAgentStateService(CaptureAgentStateService agentStateService)	OSGi DI
void	setAssetManager(AssetManager assetManager)	OSGi DI
void	setIndexService(IndexService indexService)	OSGi DI
void	setIngestService(IngestService ingestService)	OSGi DI
void	setSchedulerService(SchedulerService schedulerService)
void	setUrlSigningService(UrlSigningService urlSigningService)	OSGi DI
void	setWorkflowService(WorkflowService workflowService)	OSGi DI
void	updated(Dictionary<String,?> properties)	OSGi callback if properties file is present
javax.ws.rs.core.Response	updateEventAcl(String acceptHeader, String id, String acl)
javax.ws.rs.core.Response	updateEventMetadata(String acceptHeader, javax.servlet.http.HttpServletRequest request, String eventId)
javax.ws.rs.core.Response	updateEventMetadataByType(String acceptHeader, String id, String type, String metadataJSON)
javax.ws.rs.core.Response	updateEventScheduling(String acceptHeader, String id, String scheduling, boolean allowConflict)
javax.ws.rs.core.Response	updateFlavorWithTrack(String acceptHeader, String id, javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Details

URL_SIGNING_EXPIRES_DURATION_SECONDS_KEY

protected static final String URL_SIGNING_EXPIRES_DURATION_SECONDS_KEY

See Also:

• Constant Field Values

DEFAULT_URL_SIGNING_EXPIRE_DURATION

protected static final Long DEFAULT_URL_SIGNING_EXPIRE_DURATION

The default time before a piece of signed content expires. 2 Hours.

endpointBaseUrl

protected String endpointBaseUrl

Base URL of this endpoint

Constructor Details

EventsEndpoint

public EventsEndpoint()

Method Details

setAssetManager

public void setAssetManager(AssetManager assetManager)

OSGi DI

setIndexService

public void setIndexService(IndexService indexService)

OSGi DI

setIngestService

public void setIngestService(IngestService ingestService)

OSGi DI

setUrlSigningService

public void setUrlSigningService(UrlSigningService urlSigningService)

OSGi DI

getSecurityService

public SecurityService getSecurityService()

getSchedulerService

public SchedulerService getSchedulerService()

setSchedulerService

public void setSchedulerService(SchedulerService schedulerService)

addCatalogUIAdapter

public void addCatalogUIAdapter(EventCatalogUIAdapter catalogUIAdapter)

OSGi DI.

removeCatalogUIAdapter

public void removeCatalogUIAdapter(EventCatalogUIAdapter catalogUIAdapter)

OSGi DI.

getAgentStateService

public CaptureAgentStateService getAgentStateService()

OSGi DI

setAgentStateService

public void setAgentStateService(CaptureAgentStateService agentStateService)

OSGi DI

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

OSGi DI

getEventCatalogUIAdapters

public List<EventCatalogUIAdapter> getEventCatalogUIAdapters(String organization)

updated

public void updated(Dictionary<String,?> properties)
             throws org.osgi.service.cm.ConfigurationException

OSGi callback if properties file is present

Specified by:

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

Throws:

org.osgi.service.cm.ConfigurationException

isNullOrEmpty

public static <T> boolean isNullOrEmpty(List<String> list)

getEvent

@GET
@Path("{eventId}")
public javax.ws.rs.core.Response getEvent(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @QueryParam("sign")
 boolean sign,
 @QueryParam("withacl")
 Boolean withAcl,
 @QueryParam("withmetadata")
 Boolean withMetadata,
 @QueryParam("withscheduling")
 Boolean withScheduling,
 @QueryParam("withpublications")
 Boolean withPublications,
 @QueryParam("includeInternalPublication")
 Boolean includeInternalPublication)
                                   throws Exception

Throws:

Exception

getEventMedia

@GET
@Path("{eventId}/media")
public javax.ws.rs.core.Response getEventMedia(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id)
                                        throws Exception

Throws:

Exception

deleteEvent

@DELETE
@Path("{eventId}")
public javax.ws.rs.core.Response deleteEvent(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id)
                                      throws SearchIndexException,
UnauthorizedException

Throws:

SearchIndexException

UnauthorizedException

updateEventMetadata

@POST
@Path("{eventId}")
public javax.ws.rs.core.Response updateEventMetadata(@HeaderParam("Accept")
 String acceptHeader,
 @Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("eventId")
 String eventId)

createNewEvent

@POST
@Path("/")
@Consumes("multipart/form-data")
public javax.ws.rs.core.Response createNewEvent(@HeaderParam("Accept")
 String acceptHeader,
 @Context
 javax.servlet.http.HttpServletRequest request)

getEvents

@GET
@Path("/")
public javax.ws.rs.core.Response getEvents(@HeaderParam("Accept")
 String acceptHeader,
 @QueryParam("id")
 String id,
 @QueryParam("commentReason")
 String reasonFilter,
 @QueryParam("commentResolution")
 String resolutionFilter,
 @QueryParam("filter")
 List<String> filter,
 @QueryParam("sort")
 String sort,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("sign")
 boolean sign,
 @QueryParam("withacl")
 Boolean withAcl,
 @QueryParam("withmetadata")
 Boolean withMetadata,
 @QueryParam("withscheduling")
 Boolean withScheduling,
 @QueryParam("onlyWithWriteAccess")
 Boolean onlyWithWriteAccess,
 @QueryParam("withpublications")
 Boolean withPublications,
 @QueryParam("includeInternalPublication")
 Boolean includeInternalPublication)

getJsonEvents

protected javax.ws.rs.core.Response getJsonEvents(String acceptHeader,
 List<IndexObject> events,
 Boolean withAcl,
 Boolean withMetadata,
 Boolean withScheduling,
 Boolean withPublications,
 Boolean includeInternalPublication,
 Boolean withSignedUrls,
 ApiVersion requestedVersion)
                                           throws IndexServiceException,
UnauthorizedException,
SchedulerException

Render a collection of Events into a json array.

Parameters:

acceptHeader - The accept header to return to the client.

events - The List of Events to render into json.

withAcl - Whether to include the events' ACLs.

withMetadata - Whether to include the events' metadata.

withScheduling - Whether to include the events' scheduling information.

withPublications - Whether to include the events' publications.

withSignedUrls - Whether to sign the included urls.

Returns:

A Response with the accept header and body as the Json array of Events.

Throws:

IndexServiceException

SchedulerException

UnauthorizedException

eventToJSON

protected com.entwinemedia.fn.data.json.JValue eventToJSON(Event event,
 Boolean withAcl,
 Boolean withMetadata,
 Boolean withScheduling,
 Boolean withPublications,
 Boolean includeInternalPublication,
 Boolean withSignedUrls,
 ApiVersion requestedVersion)
                                                    throws IndexServiceException,
SchedulerException,
UnauthorizedException

Transform an Event to Json

Parameters:

event - The event to transform into json

withAcl - Whether to add the acl information for the event

withMetadata - Whether to add all the metadata for the event

withScheduling - Whether to add the scheduling information for the event

withPublications - Whether to add the publications

withSignedUrls - Whether to sign the urls if they are protected by stream security.

Returns:

The event in json format.

Throws:

IndexServiceException - Thrown if unable to get the metadata for the event.

SchedulerException

UnauthorizedException

getEventAcl

@GET
@Path("{eventId}/acl")
public javax.ws.rs.core.Response getEventAcl(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id)
                                      throws Exception

Throws:

Exception

updateEventAcl

@PUT
@Path("{eventId}/acl")
public javax.ws.rs.core.Response updateEventAcl(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @FormParam("acl")
 String acl)
                                         throws Exception

Throws:

Exception

addEventAce

@POST
@Path("{eventId}/acl/{action}")
public javax.ws.rs.core.Response addEventAce(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @PathParam("action")
 String action,
 @FormParam("role")
 String role)
                                      throws Exception

Throws:

Exception

deleteEventAce

@DELETE
@Path("{eventId}/acl/{action}/{role}")
public javax.ws.rs.core.Response deleteEventAce(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @PathParam("action")
 String action,
 @PathParam("role")
 String role)
                                         throws Exception

Throws:

Exception

getAllEventMetadata

@GET
@Path("{eventId}/metadata")
public javax.ws.rs.core.Response getAllEventMetadata(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @QueryParam("type")
 String type)
                                              throws Exception

Throws:

Exception

getEventMetadataById

protected com.entwinemedia.fn.data.Opt<MetadataList> getEventMetadataById(String id)
                                                                   throws IndexServiceException,
Exception

Throws:

IndexServiceException

Exception

getEventMetadata

protected com.entwinemedia.fn.data.Opt<MetadataList> getEventMetadata(Event event)
                                                               throws IndexServiceException,
Exception

Throws:

IndexServiceException

Exception

updateEventMetadataByType

@PUT
@Path("{eventId}/metadata")
public javax.ws.rs.core.Response updateEventMetadataByType(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @QueryParam("type")
 String type,
 @FormParam("metadata")
 String metadataJSON)
                                                    throws Exception

Throws:

Exception

deleteEventMetadataByType

@DELETE
@Path("{eventId}/metadata")
public javax.ws.rs.core.Response deleteEventMetadataByType(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @QueryParam("type")
 String type)
                                                    throws SearchIndexException

Throws:

SearchIndexException

getEventPublications

@GET
@Path("{eventId}/publications")
public javax.ws.rs.core.Response getEventPublications(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @QueryParam("sign")
 boolean sign,
 @QueryParam("includeInternalPublication")
 boolean includeInternalPublication)
                                               throws Exception

Throws:

Exception

getPublication

public com.entwinemedia.fn.data.json.JObject getPublication(Publication publication,
 Boolean sign,
 ApiVersion requestedVersion)

getEventPublication

@GET
@Path("{eventId}/publications/{publicationId}")
public javax.ws.rs.core.Response getEventPublication(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String eventId,
 @PathParam("publicationId")
 String publicationId,
 @QueryParam("sign")
 boolean sign)
                                              throws Exception

Throws:

Exception

getAclFromEvent

protected static AccessControlList getAclFromEvent(Event event)

Get an AccessControlList from an Event.

Parameters:

event - The Event to get the ACL from.

Returns:

The AccessControlList stored in the Event

getEventScheduling

@GET
@Path("{eventId}/scheduling")
@Produces({"application/json","application/v1.1.0+json","application/v1.2.0+json","application/v1.3.0+json","application/v1.4.0+json","application/v1.5.0+json","application/v1.6.0+json","application/v1.7.0+json","application/v1.8.0+json","application/v1.9.0+json","application/v1.10.0+json","application/v1.11.0+json"})
public javax.ws.rs.core.Response getEventScheduling(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id)
                                             throws Exception

Throws:

Exception

updateEventScheduling

@PUT
@Path("{eventId}/scheduling")
@Produces({"application/json","application/v1.1.0+json","application/v1.2.0+json","application/v1.3.0+json","application/v1.4.0+json","application/v1.5.0+json","application/v1.6.0+json","application/v1.7.0+json","application/v1.8.0+json","application/v1.9.0+json","application/v1.10.0+json","application/v1.11.0+json"})
public javax.ws.rs.core.Response updateEventScheduling(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @FormParam("scheduling")
 String scheduling,
 @FormParam("allowConflict") @DefaultValue("false")
 boolean allowConflict)
                                                throws Exception

Throws:

Exception

updateFlavorWithTrack

@POST
@Path("{eventId}/track")
@Consumes("multipart/form-data")
public javax.ws.rs.core.Response updateFlavorWithTrack(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String id,
 @Context
 javax.servlet.http.HttpServletRequest request)