atg.endeca.eacclient

Class ScriptRunner

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.eacclient.ScriptRunner

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

Direct Known Subclasses:

ScriptIndexable

public class ScriptRunner
extends GenericService

A Nucleus service that can execute an Endeac EAC script. Generally used for kicking off baseline or partial indexing tasks.

Created: November 14 2011

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static int	DEFAULT_SLEEP_TIME Our default sleep time when polling for status.
static java.lang.String	PROVISIONING_SERVICE_SUFFIX URL suffix for our end point.
static java.lang.String	SERVICE_SUFFIX URL suffix for our end point.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
ScriptRunner()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	calculateEndpointAddress() Calculate our endepoint address from serviceProtocol, eacHost, eacPort and SERVICE_SUFFIX.
protected java.lang.String	calculateProvisioningEndpointAddress() Calculate our endepoint address from serviceProtocol, eacHost, eacPort and PROVISIONING_SERVICE_SUFFIX.
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
com.endeca.eac.client.StateType	exec(java.lang.String pAppId, java.lang.String pScriptId) execute EAC script for given application id and script id.
void	externalExec(java.lang.String pAppId, java.lang.String pScriptId) Execute the specified script.
com.endeca.eac.client.ApplicationType	getApplication(java.lang.String pAppName) Return the ApplicationType object representing the specified application.
protected com.endeca.eac.client.ScriptControlServiceLocator	getControlLocator() Return the script control service locator given our current configuration.
protected com.endeca.eac.client.ScriptControlPort	getControlPort() Return the control port based on our current configuration.
java.lang.String	getEACHost() Returns property EACHost.
int	getEACPort() Returns property EACPort.
long	getEACScriptTimeout() Returns property EACScriptTimeout in milliseconds.
atg.endeca.index.configuration.IndexingApplicationConfiguration	getIndexingApplicationConfiguration() Returns property indexingApplicationConfiguration.
protected com.endeca.eac.client.ProvisioningServiceLocator	getProvisioningLocator() Return the provisioning locator.
protected com.endeca.eac.client.ProvisioningPort	getProvisioningPort() Return the provisioning port.
java.lang.String[]	getScriptIdsForApplication(java.lang.String pAppName)
java.lang.String	getServiceProtocol() Returns property serviceProtocol.
int	getSleepTime() Returns property sleepTime.
void	setEACHost(java.lang.String pEACHost) Sets property EACHost.
void	setEACPort(int pEACPort) Sets property EACPort.
void	setEACScriptTimeout(long pEACScriptTimeout) Sets property EACScriptTimeout in milliseconds.
void	setIndexingApplicationConfiguration(atg.endeca.index.configuration.IndexingApplicationConfiguration pIndexingApplicationConfiguration) Sets property indexingApplicationConfiguration.
void	setServiceProtocol(java.lang.String pServiceProtocol) Sets property serviceProtocol.
void	setSleepTime(int pSleepTime) Sets property sleepTime.
com.endeca.eac.client.ScriptControlPort	startScript(java.lang.String pAppId, java.lang.String pScriptId) Start EAC script for given application id and script id.
com.endeca.eac.client.ScriptControlPort	stopScript(java.lang.String pAppId, java.lang.String pScriptId) Stop/cancel EAC script for given application id and script id.
void	testExec() Test BaselineUpdate script directly Not used anymore
void	testStartWait() Test BaselineUpdate script directly using startScript and waitForScript Not used anymore
com.endeca.eac.client.StateType	waitForScript(com.endeca.eac.client.ScriptControlPort pScriptControlPort, java.lang.String pAppId, java.lang.String pScriptId, boolean pThrowExceptionIfFailed) Wait for the specified EAC script to finish.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

DEFAULT_SLEEP_TIME

public static final int DEFAULT_SLEEP_TIME

Our default sleep time when polling for status.

See Also:

Constant Field Values

SERVICE_SUFFIX

public static final java.lang.String SERVICE_SUFFIX

URL suffix for our end point.

See Also:

Constant Field Values

PROVISIONING_SERVICE_SUFFIX

public static final java.lang.String PROVISIONING_SERVICE_SUFFIX

URL suffix for our end point.

See Also:

Constant Field Values

Constructor Detail

ScriptRunner

public ScriptRunner()

Method Detail

setEACHost

public void setEACHost(java.lang.String pEACHost)

Sets property EACHost. The hostname or IP of EAC.

getEACHost

public java.lang.String getEACHost()

Returns property EACHost. The hostname or IP of EAC.

setEACPort

public void setEACPort(int pEACPort)

Sets property EACPort. The port used by EAC service.

getEACPort

public int getEACPort()

Returns property EACPort. The port used by EAC service.

setEACScriptTimeout

public void setEACScriptTimeout(long pEACScriptTimeout)

Sets property EACScriptTimeout in milliseconds. It is timeout for executing EAC script

getEACScriptTimeout

public long getEACScriptTimeout()

Returns property EACScriptTimeout in milliseconds. It is timeout for executing EAC script

setSleepTime

public void setSleepTime(int pSleepTime)

Sets property sleepTime. Number of milliseconds to sleep while polling.

getSleepTime

public int getSleepTime()

Returns property sleepTime. Number of milliseconds to sleep while polling.

setServiceProtocol

public void setServiceProtocol(java.lang.String pServiceProtocol)

Sets property serviceProtocol. The protocol to use to contact the EAC server. Defaults to "http"

getServiceProtocol

public java.lang.String getServiceProtocol()

Returns property serviceProtocol. The protocol to use to contact the EAC server. Defaults to "http"

setIndexingApplicationConfiguration

public void setIndexingApplicationConfiguration(atg.endeca.index.configuration.IndexingApplicationConfiguration pIndexingApplicationConfiguration)

Sets property indexingApplicationConfiguration. The Endeca host and application configuration.

getIndexingApplicationConfiguration

@NotNull
public atg.endeca.index.configuration.IndexingApplicationConfiguration getIndexingApplicationConfiguration()

Returns property indexingApplicationConfiguration. The Endeca host and application configuration.

doStartService

public void doStartService()
                    throws ServiceException

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

externalExec

public void externalExec(java.lang.String pAppId,
                         java.lang.String pScriptId)
                  throws IndexingException

Execute the specified script.

Parameters:

pAppId - the specified Endeca application ID.

pScriptId - the specified script ID.

Throws:

IndexingException - if execution failed

exec

public com.endeca.eac.client.StateType exec(java.lang.String pAppId,
                                            java.lang.String pScriptId)
                                     throws IndexingException

execute EAC script for given application id and script id.

Parameters:

pAppId - the Endeca application ID.

pScriptId - the Endeca script name.

Returns:

the state (status).

Throws:

IndexingException - if execution failed

calculateEndpointAddress

protected java.lang.String calculateEndpointAddress()

Calculate our endepoint address from serviceProtocol, eacHost, eacPort and SERVICE_SUFFIX.

calculateProvisioningEndpointAddress

protected java.lang.String calculateProvisioningEndpointAddress()

Calculate our endepoint address from serviceProtocol, eacHost, eacPort and PROVISIONING_SERVICE_SUFFIX.

startScript

public com.endeca.eac.client.ScriptControlPort startScript(java.lang.String pAppId,
                                                           java.lang.String pScriptId)
                                                    throws IndexingException

Start EAC script for given application id and script id.

Parameters:

pAppId - the Endeca applicaiton ID

pScriptId - the Endeca script ID.

Throws:

IndexingException - if script failed to start

stopScript

public com.endeca.eac.client.ScriptControlPort stopScript(java.lang.String pAppId,
                                                          java.lang.String pScriptId)
                                                   throws IndexingException

Stop/cancel EAC script for given application id and script id.

Parameters:

pAppId - the Endeca applicaiton ID

pScriptId - the Endeca script ID.

Throws:

IndexingException - if script stop did not succeed

getControlLocator

protected com.endeca.eac.client.ScriptControlServiceLocator getControlLocator()
                                                                       throws javax.xml.rpc.ServiceException

Return the script control service locator given our current configuration.

Returns:

new scriptControlLocator.

Throws:

ServiceException - if unable to retrieve script service locator

javax.xml.rpc.ServiceException

getControlPort

protected com.endeca.eac.client.ScriptControlPort getControlPort()
                                                          throws javax.xml.rpc.ServiceException

Return the control port based on our current configuration.

Throws:

ServiceException - if unable to retrieve script control port

javax.xml.rpc.ServiceException

getProvisioningLocator

protected com.endeca.eac.client.ProvisioningServiceLocator getProvisioningLocator()
                                                                           throws javax.xml.rpc.ServiceException

Return the provisioning locator.

Throws:

javax.xml.rpc.ServiceException

getProvisioningPort

protected com.endeca.eac.client.ProvisioningPort getProvisioningPort()
                                                              throws javax.xml.rpc.ServiceException

Return the provisioning port.

Throws:

javax.xml.rpc.ServiceException

getApplication

public com.endeca.eac.client.ApplicationType getApplication(java.lang.String pAppName)
                                                     throws javax.xml.rpc.ServiceException,
                                                            java.rmi.RemoteException

Return the ApplicationType object representing the specified application.

Parameters:

pAppName - the application name.

Returns:

the ApplicationType for that application.

Throws:

javax.xml.rpc.ServiceException

java.rmi.RemoteException

getScriptIdsForApplication

public java.lang.String[] getScriptIdsForApplication(java.lang.String pAppName)
                                              throws javax.xml.rpc.ServiceException,
                                                     java.rmi.RemoteException

Throws:

javax.xml.rpc.ServiceException

java.rmi.RemoteException

waitForScript

public com.endeca.eac.client.StateType waitForScript(com.endeca.eac.client.ScriptControlPort pScriptControlPort,
                                                     java.lang.String pAppId,
                                                     java.lang.String pScriptId,
                                                     boolean pThrowExceptionIfFailed)
                                              throws IndexingException

Wait for the specified EAC script to finish.

Parameters:

pScriptControlPort - the control port

pAppId - the Endeca application ID

pScriptId - the Endeca script ID.

Throws:

IndexingException - if script execution failed

testExec

public void testExec()

Test BaselineUpdate script directly Not used anymore

testStartWait

public void testStartWait()

Test BaselineUpdate script directly using startScript and waitForScript Not used anymore