org.sakaiproject.entitybroker.util

Class AbstractEntityProvider

java.lang.Object

org.sakaiproject.entitybroker.util.AbstractEntityProvider

All Implemented Interfaces:

org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public abstract class AbstractEntityProvider
extends Object
implements org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

WARNING: Requires Spring 1.2.8 or newer libraries in the classpath
Makes it easier to write EntityProviders in webapps
A class to extend that gets rid of some of the redundant code that has to be written over and over, causes this provider to be registered when it is created and unregistered when it is destroyed, also includes the DeveloperHelperService as a protected variable, pairs with the parent bean (org.sakaiproject.entitybroker.entityprovider.AbstractEntityProvider)
Create your spring bean like so (class is your provider, set whatever properties you are using): <bean parent="org.sakaiproject.entitybroker.entityprovider.AbstractEntityProvider" class="org.sakaiproject.entitybroker.entitywebapp.WebappEntityProvider"> <property name="dao" ref="MemoryDao" /> </bean>

Author:

Aaron Zeckoski (aaron@caret.cam.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sakaiproject.entitybroker.DeveloperHelperService	developerHelperService

Constructor Summary

Constructors

Constructor and Description
AbstractEntityProvider()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
void	setDeveloperHelperService(org.sakaiproject.entitybroker.DeveloperHelperService developerHelperService)
void	setEntityProviderManager(org.sakaiproject.entitybroker.entityprovider.EntityProviderManager entityProviderManager)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getEntityPrefix

Field Detail

developerHelperService

protected org.sakaiproject.entitybroker.DeveloperHelperService developerHelperService

Constructor Detail

AbstractEntityProvider

public AbstractEntityProvider()

Method Detail

setEntityProviderManager

public void setEntityProviderManager(org.sakaiproject.entitybroker.entityprovider.EntityProviderManager entityProviderManager)

setDeveloperHelperService

public void setDeveloperHelperService(org.sakaiproject.entitybroker.DeveloperHelperService developerHelperService)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception