com.sage.orion.sdata.servlet
Interface SDataProvider

All Known Implementing Classes:

Provider, Provider, SystemProvider

public interface SDataProvider

This is the interface that all SData providers must implement.

Method Summary

Authenticator	getAuthenticator(javax.servlet.http.HttpServletRequest request, java.lang.String dataset, javax.servlet.http.HttpServletResponse response) Gets the SData Authenticator for this SData provider.
ResourceKindPool	getPool(SDataRequest request, java.lang.String authToken) Gets the ResourcePool for this SData provider.
java.util.Collection<SDataResourceKindInfo>	getResourceKindInfo() Gets the resource information for this SData provider.
void	initialize() Handles any initialization routines required by the Provider
void	shutdown() Clear up the SData service provider as the application server is closing the context

Method Detail

getAuthenticator

Authenticator getAuthenticator(javax.servlet.http.HttpServletRequest request,
                               java.lang.String dataset,
                               javax.servlet.http.HttpServletResponse response)

Gets the SData Authenticator for this SData provider.

Parameters:

request - the incoming request

dataset - the data set that the request is on

response - the response, in case the method needs to add headers etc. to remember GUIDs and other things

Returns:

an Authenticator representing any authentication information in the request

getPool

ResourceKindPool getPool(SDataRequest request,
                         java.lang.String authToken)

Gets the ResourcePool for this SData provider.

Parameters:

request - the incoming SDataRequest

authToken - an Authenticator representing any authentication information for the request

Returns:

a ResourceKindPool suitable for processing the given request

getResourceKindInfo

java.util.Collection<SDataResourceKindInfo> getResourceKindInfo()

Gets the resource information for this SData provider.

Returns:

a Collection of the current SDataResourceKindInfo that the provider is using

initialize

void initialize()

Handles any initialization routines required by the Provider

shutdown

void shutdown()

Clear up the SData service provider as the application server is closing the context