public class ReportingGatewayHook extends AbstractGatewayModuleHook
Modifier and Type | Class and Description |
---|---|
class |
ReportingGatewayHook.RPC |
Constructor and Description |
---|
ReportingGatewayHook() |
Modifier and Type | Method and Description |
---|---|
static ReportingGatewayHook |
get()
Statically retrieves the hook from within a wicket request cycle
|
static ReportingGatewayHook |
get(GatewayContext context)
Grabs the Reporting Module's Gateway hook instance from the gateway context
|
java.lang.String |
getLicenseEdition() |
LicenseState |
getLicenseState() |
int |
getLimitedReportCount() |
java.util.Optional<java.lang.String> |
getMountedResourceFolder() |
java.util.Optional<java.lang.String> |
getMountPathAlias()
Used by the mounting underneath /main/res/module-id/* and /main/data/module-id/* as an alternate mounting path
instead of your module id, if present.
|
java.lang.String |
getProjectNameFromId(long id) |
static java.lang.String |
getProjectNameFromId(long id,
GatewayContext context) |
GatewayDataSourceRegistry |
getRegistry() |
ReportExecutionData |
getReportData(long projectId,
java.lang.String reportPath,
ReportDataConfiguration dataConfig,
java.util.Map<java.lang.String,java.lang.Object> parameters,
boolean sampleData,
ReportExecutionContext execContext) |
ReportExecutionData |
getReportData(long projectId,
java.lang.String reportPath,
ReportDataConfiguration dataConfig,
java.util.Map<java.lang.String,java.lang.Object> parameters,
java.util.Map<java.lang.String,java.lang.Object> extraConfigs,
boolean sampleData,
ReportExecutionContext execContext) |
java.lang.Object |
getRPCHandler(ClientReqSession session,
java.lang.Long projectId)
A class whose functions will become exposed automatically through reflection to the Designer
and the Client
through RPC
|
ReportStatusManager |
getStatusManager() |
java.util.Optional<OverviewContributor> |
getStatusOverviewContributor()
Implement this method to contribute meta data to the Status section's Systems / Overview page.
|
java.util.List<? extends INamedTab> |
getStatusPanels()
A list (may be null or empty) of panels to display in the status section
|
void |
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.
|
boolean |
isTrialExpired() |
boolean |
isTrialMode() |
void |
mountRouteHandlers(RouteGroup routes)
Provides a chance for the module to mount any route handlers it wants.
|
void |
notifyLicenseStateChanged(LicenseState licenseState)
Notify module hook when the license state has changed.
|
void |
setup(GatewayContext context)
Called to before startup.
|
void |
shutdown()
Called to shutdown this module.
|
void |
startup(LicenseState licenseState)
Called to initialize the module.
|
configureDeserializer, configureFunctionFactory, configureSerializer, getHomepagePanels
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getConfigCategories, getConfigOverviewContributor, getConfigPanels, isFreeModule, updateSystemMap
public static ReportingGatewayHook get(GatewayContext context)
public static ReportingGatewayHook get()
public void setup(GatewayContext context)
GatewayModuleHook
public void startup(LicenseState licenseState)
GatewayModuleHook
public void shutdown()
GatewayModuleHook
public java.lang.String getProjectNameFromId(long id)
public static java.lang.String getProjectNameFromId(long id, GatewayContext context)
public GatewayDataSourceRegistry getRegistry()
public java.lang.Object getRPCHandler(ClientReqSession session, java.lang.Long projectId)
GatewayModuleHook
getRPCHandler
in interface GatewayModuleHook
getRPCHandler
in class AbstractGatewayModuleHook
public ReportExecutionData getReportData(long projectId, java.lang.String reportPath, ReportDataConfiguration dataConfig, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean sampleData, ReportExecutionContext execContext) throws java.lang.Exception
java.lang.Exception
public ReportExecutionData getReportData(long projectId, java.lang.String reportPath, ReportDataConfiguration dataConfig, java.util.Map<java.lang.String,java.lang.Object> parameters, java.util.Map<java.lang.String,java.lang.Object> extraConfigs, boolean sampleData, ReportExecutionContext execContext) throws java.lang.Exception
java.lang.Exception
public void initializeScriptManager(ScriptManager manager)
GatewayModuleHook
ScriptManager
instance. Usually this will involve calling
ScriptManager.addScriptModule(String, Object)
, which reflectively loads the public
(instance and static) java functions from the given object into the scripting environment, at
the provided path.
This function may be called before GatewayModuleHook.startup(LicenseState)
, but never before
GatewayModuleHook.setup(GatewayContext)
.
initializeScriptManager
in interface GatewayModuleHook
initializeScriptManager
in class AbstractGatewayModuleHook
public ReportStatusManager getStatusManager()
public void mountRouteHandlers(RouteGroup routes)
GatewayModuleHook
RouteGroup
for details.
Will be called after startup().public java.util.Optional<java.lang.String> getMountPathAlias()
GatewayModuleHook
public java.util.Optional<java.lang.String> getMountedResourceFolder()
public java.util.Optional<OverviewContributor> getStatusOverviewContributor()
GatewayModuleHook
public java.util.List<? extends INamedTab> getStatusPanels()
GatewayModuleHook
getStatusPanels
in interface GatewayModuleHook
getStatusPanels
in class AbstractGatewayModuleHook
public void notifyLicenseStateChanged(LicenseState licenseState)
GatewayModuleHook
notifyLicenseStateChanged
in interface GatewayModuleHook
notifyLicenseStateChanged
in class AbstractGatewayModuleHook
public java.lang.String getLicenseEdition()
public int getLimitedReportCount()
public LicenseState getLicenseState()
public boolean isTrialMode()
public boolean isTrialExpired()