com.highqsoft.interfaces.fwk

Interface FwkServiceControlManagerInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, FwkApplicationInterface, FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPrintableInterface, FwkPropertyChangeInterface, FwkThreadInterface, FwkTransferableInterface, FwkVetoableChangeInterface, javax.infobus.InfoBusMember, java.awt.print.Pageable, java.awt.print.Printable, java.lang.Runnable, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

FwkServiceControlManager

public interface FwkServiceControlManagerInterface
extends FwkApplicationInterface

The FwkServiceControlManagerInterface describes which functionality a component must implement to become a service that is managable by the operation system Service Control Manager.

Version:

$Revision: 1.12 $

Author:

HighQSoft GmbH

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_ERROR
static int	SERVICE_CONTINUE_PENDING
static int	SERVICE_CONTROL_CONTINUE
static int	SERVICE_CONTROL_INTERROGATE
static int	SERVICE_CONTROL_PAUSE
static int	SERVICE_CONTROL_SHUTDOWN
static int	SERVICE_CONTROL_STOP
static int	SERVICE_NOT_INITIALIZED
static int	SERVICE_PAUSE_PENDING
static int	SERVICE_PAUSED
static int	SERVICE_RUNNING
static int	SERVICE_SHUTTING_DOWN
static int	SERVICE_START_PENDING
static int	SERVICE_STOP_PENDING
static int	SERVICE_STOPPED

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Method Summary

Methods

Modifier and Type	Method and Description
FwkApplicationInterface	getApplication() Get the application that is controlled by the Service Control Manager.
int	getCheckPoint() Get the checkpoint counter which indicates that the application is still alive.
int	getState() Get the current state.
void	incrementCheckPoint() Increment the checkpoint counter to indicate that the application is still alive.
boolean	isContinueRequested() Check if continue is requested.
boolean	isPauseRequested() Check if pause is requested.
boolean	isShutdownRequested() Check if shutdown is requested.
boolean	isStopRequested() Check if stop is requested.
boolean	reportStatus(int exitCode, int specificExitCode, int checkPoint, int waitHint) Send a status message to Service Control Manager.
void	serviceCtrlHandler(int controlCode) The Service Control Handler receives commands from the Service Control Manager via control codes.
void	setApplication(FwkApplicationInterface application) Set the application that shall be controlled by the Service Control Manager.
void	setNativeMode(boolean nativeMode) Set the operation mode of this Service Control Manager.
void	setState(int newState) As a reaction to the control codes, a controlled application must be able to set its current state.
void	setWaitHint(int waitHint) The controlled application should set the wait hint - that is the number of milliseconds the Service Control Manager shall wait for any progress indication.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkApplicationInterface

addExecuteStateListener, exit, fireExecuteStateEvent, getFwkPort, getPanel, getStatusPanel, hasFwkPort, init, isEternal, isRegistered, register, register, register, removeExecuteStateListener, setArguments, setEternal, setPanel, setServiceControlManager, unregister

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusMemberInterface

getInfoBusName, getMemberName, isConnected, setInfoBusName, setMemberName

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDOMHandlerInterface

getCompany, readConstructor, readFromDOM, readingDOM, readingDOM, writeConstructor, writeToDOM, writeToXML

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPrintableInterface

getPrintJobName, setPageFormat

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPersistenceInterface

getCommands, getPersistentObjectNames

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkVetoableChangeInterface

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface java.awt.print.Printable

print

Methods inherited from interface java.awt.print.Pageable

getNumberOfPages, getPageFormat, getPrintable

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkThreadInterface

getPriority, isInterrupted, setPriority, start, stop

Methods inherited from interface java.lang.Runnable

run

Field Detail

SERVICE_CONTROL_STOP

static final int SERVICE_CONTROL_STOP

See Also:

Constant Field Values

SERVICE_CONTROL_PAUSE

static final int SERVICE_CONTROL_PAUSE

See Also:

Constant Field Values

SERVICE_CONTROL_CONTINUE

static final int SERVICE_CONTROL_CONTINUE

See Also:

Constant Field Values

SERVICE_CONTROL_INTERROGATE

static final int SERVICE_CONTROL_INTERROGATE

See Also:

Constant Field Values

SERVICE_CONTROL_SHUTDOWN

static final int SERVICE_CONTROL_SHUTDOWN

See Also:

Constant Field Values

SERVICE_SHUTTING_DOWN

static final int SERVICE_SHUTTING_DOWN

See Also:

Constant Field Values

SERVICE_NOT_INITIALIZED

static final int SERVICE_NOT_INITIALIZED

See Also:

Constant Field Values

SERVICE_STOPPED

static final int SERVICE_STOPPED

See Also:

Constant Field Values

SERVICE_START_PENDING

static final int SERVICE_START_PENDING

See Also:

Constant Field Values

SERVICE_STOP_PENDING

static final int SERVICE_STOP_PENDING

See Also:

Constant Field Values

SERVICE_RUNNING

static final int SERVICE_RUNNING

See Also:

Constant Field Values

SERVICE_CONTINUE_PENDING

static final int SERVICE_CONTINUE_PENDING

See Also:

Constant Field Values

SERVICE_PAUSE_PENDING

static final int SERVICE_PAUSE_PENDING

See Also:

Constant Field Values

SERVICE_PAUSED

static final int SERVICE_PAUSED

See Also:

Constant Field Values

NO_ERROR

static final int NO_ERROR

See Also:

Constant Field Values

Method Detail

getApplication

FwkApplicationInterface getApplication()

Get the application that is controlled by the Service Control Manager.

Returns:

The controlled application.

getCheckPoint

int getCheckPoint()

Get the checkpoint counter which indicates that the application is still alive.

Returns:

The current checkpoint counter.

See Also:

setWaitHint(), incrementCheckPoint()

getState

int getState()

Get the current state.

Returns:

The current state.

incrementCheckPoint

void incrementCheckPoint()

Increment the checkpoint counter to indicate that the application is still alive. It is up to the controlled application to increment on a regular base. The application should also set the wait hint - that is the number of milliseconds the Service Control Manager shall wait for any progress indication.

See Also:

setWaitHint()

isPauseRequested

boolean isPauseRequested()

Check if pause is requested.

Returns:

True if pause requested.

isShutdownRequested

boolean isShutdownRequested()

Check if shutdown is requested.

Returns:

True if shutdown requested.

isContinueRequested

boolean isContinueRequested()

Check if continue is requested.

Returns:

True if continue requested.

isStopRequested

boolean isStopRequested()

Check if stop is requested.

Returns:

True if stop requested.

reportStatus

boolean reportStatus(int exitCode,
                   int specificExitCode,
                   int checkPoint,
                   int waitHint)

Send a status message to Service Control Manager. A Java implementation of this method is for testing purposes only. The native method of the operating systems Service Control Manager must be called in real applications.

Parameters:

exitCode - Error code.

specificExitCode - Application specific error code.

checkPoint - An is-alive indicator to be incremented on each call.

waitHint - The estimated remaining time to completion in ms.

serviceCtrlHandler

void serviceCtrlHandler(int controlCode)

The Service Control Handler receives commands from the Service Control Manager via control codes. The following control codes are currently supported: SERVICE_CONTROL_STOP = 1 SERVICE_CONTROL_PAUSE = 2 SERVICE_CONTROL_CONTINUE = 3 SERVICE_CONTROL_INTERROGATE = 4 SERVICE_CONTROL_SHUTDOWN = 5 The codes have been taken from winsvc.h in the MS Visual Studio directory tree. Messages to the Service Control Manager are sent via the native method sendStatusToSCM.

Parameters:

controlCode - One of the control codes specified above.

setApplication

void setApplication(FwkApplicationInterface application)

Set the application that shall be controlled by the Service Control Manager. This method makes the Java Service Control Manager independent of the application that is controlled. In other word, an implementation of the ServiceControlManager Interface may control any application hat is able to understand the control codes.

Parameters:

application - The application to be controlled.

setNativeMode

void setNativeMode(boolean nativeMode)

Set the operation mode of this Service Control Manager. If nativeMode is true (the default) the messages are send to the OS Service Control Manager. Otherwise the messages are printed to standard output. If the native call fails for any reason, nativeMode is automatically set to false.

Parameters:

nativeCode - The native code.

setState

void setState(int newState)

As a reaction to the control codes, a controlled application must be able to set its current state. The following status codes can be set by the application: SERVICE_STOPPED SERVICE_PAUSED SERVICE_RUNNING The control manager implementation will set the following codes as required: SERVICE_STOP_PENDING SERVICE_START_PENDING SERVICE_CONTINUE_PENDING SERVICE_PAUSE_PENDING

Parameters:

newState - The new state of the application.

setWaitHint

void setWaitHint(int waitHint)

The controlled application should set the wait hint - that is the number of milliseconds the Service Control Manager shall wait for any progress indication.

Parameters:

waitHint - The expected wait time in milliseconds.

See Also:

incrementCheckPoint()