org.sakaiproject.entitybroker.rest

Class EntityRESTProviderBase

java.lang.Object

org.sakaiproject.entitybroker.rest.EntityRESTProviderBase

All Implemented Interfaces:

org.sakaiproject.entitybroker.providers.EntityRESTProvider

public class EntityRESTProviderBase
extends Object
implements org.sakaiproject.entitybroker.providers.EntityRESTProvider

This is the standard entity REST provider which will be created and set in the entity broker manager, it will register itself with the entitybrokermanager on startup or construction, it should also be unregistered correctly

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityRESTProviderBase()
	EntityRESTProviderBase(org.sakaiproject.entitybroker.EntityBrokerManager entityBrokerManager, EntityActionsManager entityActionsManager, EntityEncodingManager entityEncodingManager, EntityHandlerImpl entityRequestHandler)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	decodeData(String data, String format)
void	destroy()
String	encodeData(Object data, String format, String name, Map<String,Object> properties)
void	formatAndOutputEntity(org.sakaiproject.entitybroker.EntityReference ref, String format, List<org.sakaiproject.entitybroker.entityprovider.extension.EntityData> entities, OutputStream outputStream, Map<String,Object> params)
org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn	handleCustomActionExecution(org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable actionProvider, org.sakaiproject.entitybroker.EntityReference ref, String action, Map<String,Object> actionParams, OutputStream outputStream, org.sakaiproject.entitybroker.EntityView view, Map<String,Object> searchParams)
org.sakaiproject.entitybroker.util.EntityResponse	handleEntityRequest(String reference, String viewKey, String format, Map<String,String> params, Object entity)
void	init()
void	setEntityActionsManager(EntityActionsManager entityActionsManager)
void	setEntityBrokerManager(org.sakaiproject.entitybroker.EntityBrokerManager entityBrokerManager)
void	setEntityEncodingManager(EntityEncodingManager entityEncodingManager)
void	setEntityRequestHandler(EntityHandlerImpl entityRequestHandler)
Object	translateInputToEntity(org.sakaiproject.entitybroker.EntityReference ref, String format, InputStream inputStream, Map<String,Object> params)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityRESTProviderBase

protected EntityRESTProviderBase()

EntityRESTProviderBase

public EntityRESTProviderBase(org.sakaiproject.entitybroker.EntityBrokerManager entityBrokerManager,
                      EntityActionsManager entityActionsManager,
                      EntityEncodingManager entityEncodingManager,
                      EntityHandlerImpl entityRequestHandler)

Method Detail

setEntityBrokerManager

public void setEntityBrokerManager(org.sakaiproject.entitybroker.EntityBrokerManager entityBrokerManager)

setEntityActionsManager

public void setEntityActionsManager(EntityActionsManager entityActionsManager)

setEntityEncodingManager

public void setEntityEncodingManager(EntityEncodingManager entityEncodingManager)

setEntityRequestHandler

public void setEntityRequestHandler(EntityHandlerImpl entityRequestHandler)

init

public void init()

destroy

public void destroy()

decodeData

public Map<String,Object> decodeData(String data,
                            String format)

Specified by:

decodeData in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider

encodeData

public String encodeData(Object data,
                String format,
                String name,
                Map<String,Object> properties)

Specified by:

encodeData in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider

formatAndOutputEntity

public void formatAndOutputEntity(org.sakaiproject.entitybroker.EntityReference ref,
                         String format,
                         List<org.sakaiproject.entitybroker.entityprovider.extension.EntityData> entities,
                         OutputStream outputStream,
                         Map<String,Object> params)

Specified by:

formatAndOutputEntity in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider

handleCustomActionExecution

public org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn handleCustomActionExecution(org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable actionProvider,
                                                                                              org.sakaiproject.entitybroker.EntityReference ref,
                                                                                              String action,
                                                                                              Map<String,Object> actionParams,
                                                                                              OutputStream outputStream,
                                                                                              org.sakaiproject.entitybroker.EntityView view,
                                                                                              Map<String,Object> searchParams)

Specified by:

handleCustomActionExecution in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider

translateInputToEntity

public Object translateInputToEntity(org.sakaiproject.entitybroker.EntityReference ref,
                            String format,
                            InputStream inputStream,
                            Map<String,Object> params)

Specified by:

translateInputToEntity in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider

handleEntityRequest

public org.sakaiproject.entitybroker.util.EntityResponse handleEntityRequest(String reference,
                                                                    String viewKey,
                                                                    String format,
                                                                    Map<String,String> params,
                                                                    Object entity)

Specified by:

handleEntityRequest in interface org.sakaiproject.entitybroker.providers.EntityRESTProvider