com.acsinet_solutions.cetia4.controller.rest
Interface RestModule

All Known Implementing Classes:

CommentsModule, MainServlet, RestModuleSupport, RestServlet, SinglePageCatalogModule, Topics10Servlet, Topics11Servlet, Topics12Servlet, Topics13Servlet, Topics14Servlet, Topics15Servlet, Topics16Servlet, Topics1Servlet, Topics2Servlet, Topics3Servlet, Topics4Servlet, Topics5Servlet, Topics6Servlet, Topics7Servlet, Topics8Servlet, Topics9Servlet, TopicsModule

public interface RestModule

Interface for nestable rest modules, implemented by both servlets and modules.

Author:

Santiago Arriaga

Method Summary

Configuration	getConfiguration() Get a reference to the configuration instance for the current module.
ServiceLocator	getLocator() Get the service locator reference, if any was configured.
org.apache.commons.logging.Log	getLogger() Get the logger for the current servlet.
java.lang.String	getModuleName() Get the REST module name; this will be used in mappings and path-info to identify if a request belongs or not to the current module.
int	getNestedIndex() Get the nested index of available path-info params between this module and the previous one.
java.util.List<RestModule>	getNestedModules() Get the not-null maybe empty list of nested modules inside this instance.
RestModule	getParentModule() Get the parent module; servlets have no parent module and return null; other components always return not null.
RestModule	getRootModule() Convenience method to obtain the root module.

Method Detail

getNestedModules

java.util.List<RestModule> getNestedModules()

Get the not-null maybe empty list of nested modules inside this instance.

getParentModule

RestModule getParentModule()

Get the parent module; servlets have no parent module and return null; other components always return not null.

getRootModule

RestModule getRootModule()

Convenience method to obtain the root module.

getNestedIndex

int getNestedIndex()

Get the nested index of available path-info params between this module and the previous one. This method is irrelevant for servlets, and must be nonnegative for other components.

getModuleName

java.lang.String getModuleName()

Get the REST module name; this will be used in mappings and path-info to identify if a request belongs or not to the current module.

getLogger

org.apache.commons.logging.Log getLogger()

Get the logger for the current servlet. The advantage of this logger is that is related to the final class that extends this abstract class.

getLocator

ServiceLocator getLocator()

Get the service locator reference, if any was configured.

getConfiguration

Configuration getConfiguration()

Get a reference to the configuration instance for the current module.