Package org.opencastproject.assetmanager.impl.endpoint

Class AbstractAssetManagerRestEndpoint

java.lang.Object

org.opencastproject.rest.AbstractJobProducerEndpoint

org.opencastproject.assetmanager.impl.endpoint.AbstractAssetManagerRestEndpoint

Direct Known Subclasses:

AbstractTieredStorageAssetManagerRestEndpoint

public abstract class AbstractAssetManagerRestEndpoint
extends org.opencastproject.rest.AbstractJobProducerEndpoint

A base REST endpoint for the AssetManager.

The endpoint provides assets over http (see HttpAssetProvider).

No @Path annotation here since this class cannot be created by JAX-RS. Put it on the concrete implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
AbstractAssetManagerRestEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	add(org.opencastproject.mediapackage.MediaPackageImpl mediaPackage)	Deprecated. use snapshot(org.opencastproject.mediapackage.MediaPackageImpl) instead
javax.ws.rs.core.Response	delete(String mediaPackageId)
javax.ws.rs.core.Response	getAsset(String mediaPackageID, String mediaPackageElementID, String version, String fileName, String ifNoneMatch)
abstract org.opencastproject.assetmanager.api.AssetManager	getAssetManager()
javax.ws.rs.core.Response	getMediaPackage(String mediaPackageId)
javax.ws.rs.core.Response	getProperties(String mediaPackageId, String namespace)
javax.ws.rs.core.Response	getWorkflowProperties(String mediaPackageId)
static javax.ws.rs.core.Response	handleException(Exception e)	Unify exception handling.
javax.ws.rs.core.Response	indexUpdate(String id)
javax.ws.rs.core.Response	setWorkflowProperties(String mediaPackageId, String propertiesJSON)
javax.ws.rs.core.Response	snapshot(org.opencastproject.mediapackage.MediaPackageImpl mediaPackage)

Methods inherited from class org.opencastproject.rest.AbstractJobProducerEndpoint

checkHeartbeat, dispatchJob, getService, getServiceRegistry

Methods inherited from class java.lang.Object

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

Field Details

logger

protected static final org.slf4j.Logger logger

Constructor Details

AbstractAssetManagerRestEndpoint

public AbstractAssetManagerRestEndpoint()

Method Details

getAssetManager

public abstract org.opencastproject.assetmanager.api.AssetManager getAssetManager()

add

@POST
@Path("add")
@Deprecated
public javax.ws.rs.core.Response add(@FormParam("mediapackage")
 org.opencastproject.mediapackage.MediaPackageImpl mediaPackage)

Deprecated.

use snapshot(org.opencastproject.mediapackage.MediaPackageImpl) instead

snapshot

@POST
@Path("snapshot")
public javax.ws.rs.core.Response snapshot(@FormParam("mediapackage")
 org.opencastproject.mediapackage.MediaPackageImpl mediaPackage)

indexUpdate

@POST
@Path("updateIndex")
public javax.ws.rs.core.Response indexUpdate(@FormParam("id")
 String id)

delete

@DELETE
@Path("delete/{id}")
public javax.ws.rs.core.Response delete(@PathParam("id")
 String mediaPackageId)

getMediaPackage

@GET
@Produces("text/xml")
@Path("episode/{mediaPackageID}")
public javax.ws.rs.core.Response getMediaPackage(@PathParam("mediaPackageID")
 String mediaPackageId)

getAsset

@GET
@Path("assets/{mediaPackageID}/{mediaPackageElementID}/{version}/{filename}")
public javax.ws.rs.core.Response getAsset(@PathParam("mediaPackageID")
 String mediaPackageID,
 @PathParam("mediaPackageElementID")
 String mediaPackageElementID,
 @PathParam("version")
 String version,
 @PathParam("filename")
 String fileName,
 @HeaderParam("If-None-Match")
 String ifNoneMatch)

getProperties

@GET
@Produces("application/json")
@Path("{mediaPackageID}/properties.json")
public javax.ws.rs.core.Response getProperties(@PathParam("mediaPackageID")
 String mediaPackageId,
 @FormParam("namespace")
 String namespace)

getWorkflowProperties

@GET
@Produces("application/json")
@Path("{mediaPackageID}/workflowProperties.json")
public javax.ws.rs.core.Response getWorkflowProperties(@PathParam("mediaPackageID")
 String mediaPackageId)

setWorkflowProperties

@POST
@Path("{mediaPackageID}/workflowProperties")
public javax.ws.rs.core.Response setWorkflowProperties(@PathParam("mediaPackageID")
 String mediaPackageId,
 @FormParam("properties")
 String propertiesJSON)

handleException

public static javax.ws.rs.core.Response handleException(Exception e)

Unify exception handling.