com.sage.orion.sdata.servlet
Interface ResourceKind

All Known Implementing Classes:

ActiveApplicationResourceKind, AdhocQueryFileCategoryResourceKind, AdhocQueryFileDefaultResouceKind, AdhocQueryFileResourceKind, ASSessions, ASUsers, ASWhoAmI, BaseResourceKind, EchoResourceKind, ExportResource, FiscalYearResourceKind, FullSchemaKind, IntermediateResourceKind, JDBCResourceKind, LandingPageResourceKind, LicenseStatusResourceKind, MissingSessionKind, MockJDBCResourceKind, OrgsResourceKind, PagesResourceKind, PortletCategoriesResourceKind, PortletResourceKind, PortletsAndCategoriesResourceKind, ResourceListResourceKind, ServiceResourceKind, ShortCutsResourceKind, SystemResourceKind, TestJDBCResourceKindImpl, UICommonInfo, UIContentResourceKind, UIDefinitionResourceKind, ViewResourceKind

public interface ResourceKind

The base interface for a resource kind. The main purpose of the resource kind is to handle a request (through the handleRequest(SDataRequest, AsyncStatusListener) method. The other methods are for the system to use for maintenance.

Method Summary

java.lang.String	getInstance()
java.lang.String	getName()
ResourceResponse	handleRequest(SDataRequest request, AsyncStatusListener listener) Handle the specified request, passing information to the listener if there is one.
void	shutdown() Shut down the resource kind.

Method Detail

shutdown

void shutdown()

Shut down the resource kind. Note that this may be called on a shutdown thread even though a different thread is executing handleRequest(SDataRequest, AsyncStatusListener).

getName

java.lang.String getName()

handleRequest

ResourceResponse handleRequest(SDataRequest request,
                               AsyncStatusListener listener)

Handle the specified request, passing information to the listener if there is one.

Note that even if an implementation is not thread-safe it must allow for the shutdown() call to execute in parallel.

Parameters:

request - the request to handle

listener - null or a listener than can be used for asynchronous tasks to monitor progress.

Returns:

a ResourceResponse to the request

getInstance

java.lang.String getInstance()