org.openbase.bco.registry.lib.launch

Class AbstractLauncher<L extends org.openbase.jul.iface.Launchable>

java.lang.Object

org.openbase.jul.extension.rsb.com.RSBCommunicationService<M,MB>

org.openbase.jul.extension.rsb.com.AbstractIdentifiableController<rst.domotic.state.ActivationStateType.ActivationState,rst.domotic.state.ActivationStateType.ActivationState.Builder>

org.openbase.bco.registry.lib.launch.AbstractLauncher<L>

Type Parameters:

L - the launchable to launch by this launcher.

All Implemented Interfaces:

org.openbase.jul.extension.protobuf.iface.DataBuilderProvider<rst.domotic.state.ActivationStateType.ActivationState,rst.domotic.state.ActivationStateType.ActivationState.Builder>, org.openbase.jul.extension.protobuf.MessageController<rst.domotic.state.ActivationStateType.ActivationState,rst.domotic.state.ActivationStateType.ActivationState.Builder>, org.openbase.jul.extension.rst.iface.ScopeProvider, org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Changeable, org.openbase.jul.iface.DefaultInitializable, org.openbase.jul.iface.DefaultInitializableImpl<Void>, org.openbase.jul.iface.Identifiable<String>, org.openbase.jul.iface.Initializable<Void>, org.openbase.jul.iface.Pingable, org.openbase.jul.iface.provider.DefaultConfigProvider<Void>, org.openbase.jul.iface.provider.NameProvider, org.openbase.jul.iface.Requestable<rst.domotic.state.ActivationStateType.ActivationState>, org.openbase.jul.iface.Shutdownable, org.openbase.jul.iface.VoidInitializable, org.openbase.jul.pattern.Controller<rst.domotic.state.ActivationStateType.ActivationState>, org.openbase.jul.pattern.IdentifiableController<String,rst.domotic.state.ActivationStateType.ActivationState>, org.openbase.jul.pattern.Launcher, org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.ActivationStateType.ActivationState>

Direct Known Subclasses:

AbstractRegistryLauncher

public abstract class AbstractLauncher<L extends org.openbase.jul.iface.Launchable>
extends org.openbase.jul.extension.rsb.com.AbstractIdentifiableController<rst.domotic.state.ActivationStateType.ActivationState,rst.domotic.state.ActivationStateType.ActivationState.Builder>
implements org.openbase.jul.pattern.Launcher, org.openbase.jul.iface.VoidInitializable, org.openbase.jul.iface.provider.NameProvider

Author:

Divine Threepwood

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractLauncher.LauncherState

Nested classes/interfaces inherited from interface org.openbase.jul.pattern.Controller

org.openbase.jul.pattern.Controller.ControllerAvailabilityState

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields

Modifier and Type	Field and Description
static long	LAUNCHER_TIMEOUT
protected org.slf4j.Logger	logger
static String	SCOPE_PREFIX_LAUNCHER

Fields inherited from class org.openbase.jul.extension.rsb.com.RSBCommunicationService

informer, informerWatchDog, RPC_REQUEST_STATUS, scope, SCOPE_SUFFIX_CONTROL, SCOPE_SUFFIX_STATUS, server, serverWatchDog

Fields inherited from interface org.openbase.jul.iface.provider.NameProvider

TYPE_FIELD_NAME

Fields inherited from interface org.openbase.jul.iface.Identifiable

TYPE_FIELD_ID

Constructor Summary

Constructors

Constructor and Description
AbstractLauncher(Class applicationClass, Class<L> launchableClass) Constructor prepares the launcher and registers already a shutdown hook.

Method Summary

Modifier and Type	Method and Description
L	getLaunchable()
long	getLaunchTime()
String	getName() Method returns the application name.
long	getUpTime()
org.openbase.jul.exception.VerificationFailedException	getVerificationFailedCause()
void	init()
protected L	instantiateLaunchable() Method creates a launchable instance without any arguments..
boolean	isVerified()
void	launch()
protected abstract void	loadProperties()
static void	main(String[] args, Class application, Class<? extends AbstractLauncher>... launchers)
void	registerMethods(org.openbase.jul.extension.rsb.iface.RSBLocalServer server)
void	relaunch()
void	shutdown()
void	stop()
protected void	verify() Method verifies a running application.

Methods inherited from class org.openbase.jul.extension.rsb.com.AbstractIdentifiableController

getId

Methods inherited from class org.openbase.jul.extension.rsb.com.RSBCommunicationService

activate, addDataObserver, cloneDataBuilder, deactivate, getBuilderSetup, getControllerAvailabilityState, getData, getDataBuilder, getDataClass, getDataField, getDataFieldDescriptor, getScope, hasDataField, init, init, init, init, init, init, isActive, isDataAvailable, notifyChange, ping, postInit, removeDataObserver, requestStatus, reset, setDataField, setDataField, supportsDataField, toString, validateInitialization, waitForAvailabilityState, waitForData, waitForData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbase.jul.iface.VoidInitializable

getDefaultConfig, init

Methods inherited from interface org.openbase.jul.pattern.Controller

getControllerAvailabilityState, getData, getDataClass, notifyChange, waitForAvailabilityState

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook

Methods inherited from interface org.openbase.jul.iface.Activatable

activate, deactivate, isActive

Methods inherited from interface org.openbase.jul.iface.Pingable

ping

Methods inherited from interface org.openbase.jul.iface.Requestable

requestStatus

Field Detail

logger

protected final org.slf4j.Logger logger

LAUNCHER_TIMEOUT

public static final long LAUNCHER_TIMEOUT

See Also:

Constant Field Values

SCOPE_PREFIX_LAUNCHER

public static final String SCOPE_PREFIX_LAUNCHER

See Also:

Constant Field Values

Constructor Detail

AbstractLauncher

public AbstractLauncher(Class applicationClass,
                        Class<L> launchableClass)
                 throws org.openbase.jul.exception.InstantiationException

Constructor prepares the launcher and registers already a shutdown hook. The launcher class is used to instantiate a new launcher instance if the instantiateLaunchable() method is not overwritten. After instantiation of this class the launcher must be initialized and activated before the RSB interface is provided.

Parameters:

launchableClass - the class to be launched.

applicationClass - the class representing this application. Those is used for scope generation if the getName() method is not overwritten.

Throws:

org.openbase.jul.exception.InstantiationException

Method Detail

init

public void init()
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Specified by:

init in interface org.openbase.jul.iface.DefaultInitializable

Specified by:

init in interface org.openbase.jul.iface.DefaultInitializableImpl<Void>

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

registerMethods

public void registerMethods(org.openbase.jul.extension.rsb.iface.RSBLocalServer server)
                     throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

registerMethods in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<rst.domotic.state.ActivationStateType.ActivationState,rst.domotic.state.ActivationStateType.ActivationState.Builder>

Throws:

org.openbase.jul.exception.CouldNotPerformException

getLaunchable

public L getLaunchable()

getName

public String getName()
               throws org.openbase.jul.exception.NotAvailableException

Method returns the application name. By default the application name is the name of the given application class name.

Specified by:

getName in interface org.openbase.jul.iface.provider.NameProvider

Returns:

the name as string.

Throws:

org.openbase.jul.exception.NotAvailableException

instantiateLaunchable

protected L instantiateLaunchable()
                           throws org.openbase.jul.exception.CouldNotPerformException

Method creates a launchable instance without any arguments.. In case the launchable needs arguments you can overwrite this method and instantiate the launchable by ourself.

Returns:

the new instantiated launchable.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown in case the launchable could not properly be instantiated.

loadProperties

protected abstract void loadProperties()

verify

protected void verify()
               throws org.openbase.jul.exception.VerificationFailedException,
                      InterruptedException

Method verifies a running application.

Throws:

org.openbase.jul.exception.VerificationFailedException - is thrown if the application is started with any restrictions.

InterruptedException - is thrown if the verification process is externally interrupted.

launch

public void launch()
            throws org.openbase.jul.exception.CouldNotPerformException,
                   InterruptedException

Specified by:

launch in interface org.openbase.jul.pattern.Launcher

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

relaunch

public void relaunch()
              throws org.openbase.jul.exception.CouldNotPerformException,
                     InterruptedException

Specified by:

relaunch in interface org.openbase.jul.pattern.Launcher

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

stop

public void stop()

Specified by:

stop in interface org.openbase.jul.pattern.Launcher

shutdown

public void shutdown()

Specified by:

shutdown in interface org.openbase.jul.iface.Shutdownable

Overrides:

shutdown in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<rst.domotic.state.ActivationStateType.ActivationState,rst.domotic.state.ActivationStateType.ActivationState.Builder>

getUpTime

public long getUpTime()

Specified by:

getUpTime in interface org.openbase.jul.pattern.Launcher

getLaunchTime

public long getLaunchTime()

Specified by:

getLaunchTime in interface org.openbase.jul.pattern.Launcher

isVerified

public boolean isVerified()

Specified by:

isVerified in interface org.openbase.jul.pattern.Launcher

getVerificationFailedCause

public org.openbase.jul.exception.VerificationFailedException getVerificationFailedCause()

main

public static void main(String[] args,
                        Class application,
                        Class<? extends AbstractLauncher>... launchers)