Class QExec

java.lang.Object

org.jpos.q2.QBeanSupport

org.jpos.q2.qbean.QExec

All Implemented Interfaces:

Configurable, QBean, QExecMBean, QBeanSupportMBean, QPersist

public class QExec
extends QBeanSupport
implements QExecMBean

QBean for starting and stopping scripts or programs.

Example xml:
 <exec class="org.jpos.q2.qbean.QExec">
   <attr name="startScript">YOUR PATH TO PROGRAM</attr>
   <attr name="shutdownScript">YOUR PATH TO PROGRAM</attr>
 </exec>

Field Summary

Fields inherited from class QBeanSupport

cfg, log, scheduledThreadPoolExecutor

Modifier and Type	Field	Description
protected Configuration	cfg	Configuration applied to this bean by the container.
protected Log	log	Logger associated with this bean.
protected ScheduledThreadPoolExecutor	scheduledThreadPoolExecutor	Lazily-allocated scheduler shared with subclasses; see QBeanSupport.getScheduledThreadPoolExecutor().

Fields inherited from interface QBean

DESTROYED, FAILED, STARTED, STARTING, stateString, STOPPED, STOPPING

Modifier and Type	Field	Description
static final int	DESTROYED	QBean has been destroyed.
static final int	FAILED	QBean has failed.
static final int	STARTED	QBean is running.
static final int	STARTING	QBean is in the process of starting.
static final String[]	stateString	Human-readable names for each QBean state, indexed by state constant.
static final int	STOPPED	QBean is stopped.
static final int	STOPPING	QBean is in the process of stopping.

Constructor Summary

Constructors

Constructor	Description
QExec()	Default constructor; no instance state to initialise.

Method Summary

Modifier and Type	Method	Description
String	getShutdownScript()	Returns the configured shutdown-script path.
String	getStartScript()	Returns the configured start-script path.
static List<String>	parseCommandLine(String commandLine)	Tokenises a command line, honouring double-quoted segments and backslash-escaped characters.
void	setShutdownScript(String scriptPath)	Sets the path to the script executed when the bean shuts down.
void	setStartScript(String scriptPath)	Sets the path to the script executed when the bean starts.
protected void	startService()	Called during the start lifecycle phase; subclasses may override.
protected void	stopService()	Called during the stop lifecycle phase; subclasses may override.

Methods inherited from class QBeanSupport

addAttr, close, createElement, defaultRealm, destroy, destroyService, getAttrs, getAttrs, getConfiguration, getDump, getFactory, getLoader, getLoaderURLS, getLog, getLogger, getName, getPersist, getProperties, getProperty, getRealm, getScheduledThreadPoolExecutor, getServer, getState, getStateAsString, init, initService, isModified, running, setAttr, setConfiguration, setLogger, setModified, setName, setPersist, setProperty, setRealm, setServer, setState, start, stop

Modifier and Type	Method	Description
protected void	addAttr(org.jdom2.Element e, String name, Object obj, String type)	Appends an <attr> child element with name/type/value to e.
protected void	close(Closeable... closeables)	Closes a sequence of Closeable resources, logging any failures as a warning.
protected org.jdom2.Element	createElement(String name, Class mbeanClass)	Builds a JDOM Element reflecting the bean's persistent attributes, driven by the JavaBean introspection of mbeanClass.
protected String	defaultRealm()	Returns the default realm for this bean; subclasses may override.
void	destroy()	destroy the service
protected void	destroyService()	Called during the destroy lifecycle phase; subclasses may override.
protected Iterator	getAttrs()	Iterates over top-level <attr> children of the persisted element.
protected Iterator	getAttrs(String parent)	Iterates over <attr> children nested under the given parent element name.
Configuration	getConfiguration()	Returns the configuration applied to this bean.
String	getDump()	Returns a textual dump of this bean's state.
QFactory	getFactory()	Returns the QFactory associated with the hosting Q2 server.
QClassLoader	getLoader()	Returns the QClassLoader for this bean.
URL[]	getLoaderURLS()	Returns the URLs registered with the class loader.
Log	getLog()	Returns the Log used by this bean.
String	getLogger()	Returns the logger name.
String	getName()	Returns the bean name.
org.jdom2.Element	getPersist()	Returns the persistent configuration element for this QBean.
protected Iterator	getProperties(String parent)	Iterates over <property> children nested under the given parent element name.
protected String	getProperty(Iterator props, String name)	Returns the value of the named property from an iterator of <property> elements.
String	getRealm()	Returns the logging realm.
protected ScheduledThreadPoolExecutor	getScheduledThreadPoolExecutor()	Lazily creates and returns a ScheduledThreadPoolExecutor for use by subclasses.
Q2	getServer()	Returns the Q2 server instance.
int	getState()	Returns the current state of this QBean.
String	getStateAsString()	Returns the current state as a human-readable string.
void	init()	init the service
protected void	initService()	Called during the init lifecycle phase; subclasses may override.
boolean	isModified()	Returns true if this QBean's configuration has been modified since last save.
boolean	running()	Indicates whether this bean is currently starting or running.
protected void	setAttr(Iterator attrs, String name, Object obj)	Updates the value of the named attribute within an iterator of <attr> elements.
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.
void	setLogger(String loggerName)	Sets the logger by name.
void	setModified(boolean modified)	Marks this bean's persistent state as modified or in sync.
void	setName(String name)	Sets the bean name.
void	setPersist(org.jdom2.Element persist)	Sets the persistent configuration element.
protected void	setProperty(Iterator props, String name, String value)	Updates the value attribute of the named property within an iterator of <property> elements.
void	setRealm(String realm)	Sets the logging realm.
void	setServer(Q2 server)	Sets the Q2 server instance for this QBean.
void	setState(int state)	Sets the lifecycle state of this bean.
void	start()	start the service
void	stop()	stop the service

Methods inherited from class Object

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

Constructor Details

QExec

public QExec()

Default constructor; no instance state to initialise.

Method Details

startService

protected void startService()
                     throws Exception

Description copied from class: QBeanSupport

Called during the start lifecycle phase; subclasses may override.

Overrides:

startService in class QBeanSupport

Throws:

Exception - on error

stopService

protected void stopService()
                    throws Exception

Description copied from class: QBeanSupport

Called during the stop lifecycle phase; subclasses may override.

Overrides:

stopService in class QBeanSupport

Throws:

Exception - on error

setStartScript

public void setStartScript(String scriptPath)

Description copied from interface: QExecMBean

Sets the path to the script executed when the bean starts.

Specified by:

setStartScript in interface QExecMBean

Parameters:

scriptPath - path to the start script

getStartScript

public String getStartScript()

Description copied from interface: QExecMBean

Returns the configured start-script path.

Specified by:

getStartScript in interface QExecMBean

Returns:

start-script path

setShutdownScript

public void setShutdownScript(String scriptPath)

Description copied from interface: QExecMBean

Sets the path to the script executed when the bean shuts down.

Specified by:

setShutdownScript in interface QExecMBean

Parameters:

scriptPath - path to the shutdown script

getShutdownScript

public String getShutdownScript()

Description copied from interface: QExecMBean

Returns the configured shutdown-script path.

Specified by:

getShutdownScript in interface QExecMBean

Returns:

shutdown-script path

parseCommandLine

public static List<String> parseCommandLine(String commandLine)

Tokenises a command line, honouring double-quoted segments and backslash-escaped characters.

Parameters:

commandLine - the command-line string

Returns:

the parsed argument list

Throws:

IllegalArgumentException - if commandLine is null or empty