org.sakaiproject.entitybroker.access

Interface EntityViewAccessProviderManager

public interface EntityViewAccessProviderManager

Manages all the access providers for the entity views in the system
Use this to register yourself as handling the entity views for a set of entites (based on the prefix) This will be used by the entity broker to determine if anyone is handling entity views for an entity type

Author:

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

Method Summary

Modifier and Type	Method and Description
EntityViewAccessProvider	getProvider(String prefix) Get an entity view access provider for a prefix if one exists
void	registerProvider(String prefix, EntityViewAccessProvider provider) Register a provider as handling entity view requests and delivering responses
void	unregisterProvider(String prefix) Removes the provider from the registered set for this prefix

Method Detail

registerProvider

void registerProvider(String prefix,
                      EntityViewAccessProvider provider)

Register a provider as handling entity view requests and delivering responses

Parameters:

prefix - the unique entity prefix that defines the entity type handled by this provider

provider - the actual provider bean

unregisterProvider

void unregisterProvider(String prefix)

Removes the provider from the registered set for this prefix

Parameters:

prefix - the unique entity prefix that defines the entity type handled by this provider

getProvider

EntityViewAccessProvider getProvider(String prefix)

Get an entity view access provider for a prefix if one exists

Parameters:

prefix - the unique entity prefix that defines the entity type handled

Returns:

the provider related to this prefix or null if no provider can be found