org.wso2.carbon.analytics.spark.admin

Class AnalyticsProcessorAdminService

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.analytics.spark.admin.AnalyticsProcessorAdminService

public class AnalyticsProcessorAdminService
extends org.wso2.carbon.core.AbstractAdmin

Admin service exposed to do the AnalyticsProcessor Service to do spark scripts and execution operations.

Field Summary

Fields inherited from class org.wso2.carbon.core.AbstractAdmin

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor and Description
AnalyticsProcessorAdminService()

Method Summary

Modifier and Type	Method and Description
void	deleteScript(String scriptName) Delete the script with provided name.
AnalyticsQueryResultDto[]	execute(String scriptContent) Execute the given script content.
void	executeInBackground(String scriptContent) Execute the given script content in a different background thread.
AnalyticsQueryResultDto	executeQuery(String query) Execute the provided query and return the result for the query.
AnalyticsQueryResultDto[]	executeScript(String scriptName) Execute the script with given script name and return the Array of Results returned.
void	executeScriptInBackground(String scriptName) Execute the script with given script name in a different thread in background.
AnalyticsScriptDto[]	getAllScripts() Get all the script names.
AnalyticsScheduledScriptDto[]	getScheduledTaskStatuses() get all statuses of scheduled scripts.
AnalyticsScriptDto	getScript(String name) Get the analytics script information for the given name.
boolean	isAnalyticsExecutionEnabled() Checks and returns whether analytics execution is enabled for this node.
boolean	isAnalyticsScriptExecuting(String scriptName) Checks and returns whether particular analytics script is running in background
boolean	isAnalyticsTaskExecuting(String scriptName) Checks and returns whether scheduled analytics task executing already
void	pauseAllScripts() Pause all spark scripts from the provided tenant space.
void	resumeAllScripts() Resume all spark scripts from the provided tenant space.
void	saveScript(String scriptName, String scriptContent, String cronExpression) Saving the script with given details.
void	saveScriptContent(String scriptName, String scriptContent) Saving the script with provided content and this script will not have any scheduling information.
void	updateScript(String scriptName, String scriptContent, String cronExpression) Update the script with provided information.
void	updateScriptContent(String scriptName, String scriptContent) Update the script content of the provided script name.
void	updateScriptTask(String scriptName, String cronExpression) Update the task information of the script.

Methods inherited from class org.wso2.carbon.core.AbstractAdmin

getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnalyticsProcessorAdminService

public AnalyticsProcessorAdminService()

Method Detail

saveScript

public void saveScript(String scriptName,
                       String scriptContent,
                       String cronExpression)
                throws AnalyticsProcessorAdminException

Saving the script with given details.

Parameters:

scriptName - Name of the script.

scriptContent - content of the script.

cronExpression - cron expression.

Throws:

AnalyticsProcessorAdminException

pauseAllScripts

public void pauseAllScripts()
                     throws AnalyticsProcessorAdminException

Pause all spark scripts from the provided tenant space.

Throws:

AnalyticsProcessorAdminException

resumeAllScripts

public void resumeAllScripts()
                      throws AnalyticsProcessorAdminException

Resume all spark scripts from the provided tenant space.

Throws:

AnalyticsProcessorAdminException

getScheduledTaskStatuses

public AnalyticsScheduledScriptDto[] getScheduledTaskStatuses()
                                                       throws AnalyticsProcessorAdminException

get all statuses of scheduled scripts.

Returns:

Return the list of scheduled scripts existing with their statuses.

Throws:

AnalyticsProcessorAdminException

saveScriptContent

public void saveScriptContent(String scriptName,
                              String scriptContent)
                       throws AnalyticsProcessorAdminException

Saving the script with provided content and this script will not have any scheduling information.

Parameters:

scriptName - Name of the script.

scriptContent - Queries content of the script.

Throws:

AnalyticsProcessorAdminException

deleteScript

public void deleteScript(String scriptName)
                  throws AnalyticsProcessorAdminException

Delete the script with provided name.

Parameters:

scriptName - Name of the script.

Throws:

AnalyticsProcessorAdminException

updateScriptContent

public void updateScriptContent(String scriptName,
                                String scriptContent)
                         throws AnalyticsProcessorAdminException

Update the script content of the provided script name.

Parameters:

scriptName - Name of the script.

scriptContent - queries content of the script.

Throws:

AnalyticsProcessorAdminException

updateScriptTask

public void updateScriptTask(String scriptName,
                             String cronExpression)
                      throws AnalyticsProcessorAdminException

Update the task information of the script.

Parameters:

scriptName - Name of the script.

cronExpression - New cron expression of the task.

Throws:

AnalyticsProcessorAdminException

updateScript

public void updateScript(String scriptName,
                         String scriptContent,
                         String cronExpression)
                  throws AnalyticsProcessorAdminException

Update the script with provided information.

Parameters:

scriptName - Name of the script.

scriptContent - Queries content of the script.

cronExpression - Cron expression of the script.

Throws:

AnalyticsProcessorAdminException

getAllScripts

public AnalyticsScriptDto[] getAllScripts()
                                   throws AnalyticsProcessorAdminException

Get all the script names.

Returns:

Return the list of scripts existing.

Throws:

AnalyticsProcessorAdminException

getScript

public AnalyticsScriptDto getScript(String name)
                             throws AnalyticsProcessorAdminException

Get the analytics script information for the given name.

Parameters:

name - Name of the script.

Returns:

DTO of the Analytics Script.

Throws:

AnalyticsProcessorAdminException

executeScript

public AnalyticsQueryResultDto[] executeScript(String scriptName)
                                        throws AnalyticsProcessorAdminException

Execute the script with given script name and return the Array of Results returned.

Parameters:

scriptName - Name of the script.

Returns:

Arrays of result from the execution.

Throws:

AnalyticsProcessorAdminException

executeScriptInBackground

public void executeScriptInBackground(String scriptName)
                               throws AnalyticsProcessorAdminException

Execute the script with given script name in a different thread in background.

Parameters:

scriptName - Name of the script.

Throws:

AnalyticsProcessorAdminException

execute

public AnalyticsQueryResultDto[] execute(String scriptContent)
                                  throws AnalyticsProcessorAdminException

Execute the given script content.

Parameters:

scriptContent - queries content to be executed.

Returns:

Result returned from the execution.

Throws:

AnalyticsProcessorAdminException

executeInBackground

public void executeInBackground(String scriptContent)
                         throws AnalyticsProcessorAdminException

Execute the given script content in a different background thread.

Parameters:

scriptContent - queries content to be executed.

Throws:

AnalyticsProcessorAdminException

executeQuery

public AnalyticsQueryResultDto executeQuery(String query)
                                     throws AnalyticsProcessorAdminException

Execute the provided query and return the result for the query.

Parameters:

query - Query which needs to be executed.

Returns:

Result for the query execution.

Throws:

AnalyticsProcessorAdminException

isAnalyticsExecutionEnabled

public boolean isAnalyticsExecutionEnabled()

Checks and returns whether analytics execution is enabled for this node.

Returns:

isAnalyticsScriptExecuting

public boolean isAnalyticsScriptExecuting(String scriptName)

Checks and returns whether particular analytics script is running in background

Parameters:

scriptName -

Returns:

isAnalyticsTaskExecuting

public boolean isAnalyticsTaskExecuting(String scriptName)
                                 throws AnalyticsProcessorAdminException

Checks and returns whether scheduled analytics task executing already

Returns:

Throws:

AnalyticsProcessorAdminException