App Framework Reference

Module Controller API

class ModuleController

The ModuleController class is an abstract controller class. Subclass ModuleController to create a module controller.

ModuleController is intended to have a subset of the functionality of other Splunk controllers. Module controllers have the following limitations:

  • Module controller methods do not have access to decorators such as @route.
  • By design, module controllers can only handle GET requests, not POST.
  • Module controllers cannot return generators.

Language Binding

Python

Implementation Location

$SPLUNK_HOME\etc\apps\<appName>\appserver\modules\<moduleName>

Inheritance

object -> BaseController -> ModuleController

Constructor

Methods

configModule() [Override base class method] Provides module configuration information requested by a GET request.
renderJobStatusMessage() Renders status information for the current job in response to a GET request.
renderModule() Generates module HTML content in response to a GET request.

See Also

class ModuleHandler