org.gecko.runtime.application.internal

Class GeckoApplicationContainer

java.lang.Object

org.gecko.runtime.application.internal.GeckoApplicationContainer

All Implemented Interfaces:

ApplicationManager, ApplicationScheduler

public class GeckoApplicationContainer
extends java.lang.Object
implements ApplicationScheduler, ApplicationManager

Gecko application container

Since:

23.03.2018

Constructor Summary

Constructors

Constructor and Description
GeckoApplicationContainer()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context, java.util.Map<java.lang.String,java.lang.Object> properties)
void	addApplicationDescriptor(ApplicationDescriptor descriptor) Adds an ApplicationDescriptor to the registry
void	deactivate()
java.util.Set<java.lang.String>	getActiveApplications() Returns all id's of active application descriptors or an empty Set
java.util.Set<java.lang.String>	getAllApplications() Returns all id's of application descriptors or an empty Set
boolean	lockApplication(java.lang.String applicationId) Locks the application with the given id
void	removeApplicationDescriptor(ApplicationDescriptor descriptor) Removes an ApplicationDescriptor from the registry
ScheduledApplication	schedule(ApplicationDescriptor descriptor, java.lang.String scheduleId, java.util.Map<java.lang.String,java.lang.Object> arguments, java.lang.String topic, java.lang.String eventFilter, boolean recurring) Schedules an application
ScheduledApplication	scheduleApplication(java.lang.String applicationId, java.util.Map<java.lang.String,java.lang.Object> launchProperties, Filter scheduleFilter) Uses the virtual timer of the system to schedule an application
boolean	startApplication(java.lang.String applicationId, java.util.Map<java.lang.String,java.lang.Object> launchProperties) Starts the application with the given id
boolean	stopApplication(java.lang.String applicationId) Starts the application with the given id
boolean	unlockApplication(java.lang.String applicationId) Un-locks the application with the given id
void	unschedule(java.lang.String scheduleId) Un-schedules an application for the schedule id
boolean	unscheduleApplication(java.lang.String applicationId) Revokes the scheduling of an application

Methods inherited from class java.lang.Object

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

Constructor Detail

GeckoApplicationContainer

public GeckoApplicationContainer()

Method Detail

activate

public void activate(ComponentContext context,
                     java.util.Map<java.lang.String,java.lang.Object> properties)

deactivate

public void deactivate()

addApplicationDescriptor

public void addApplicationDescriptor(ApplicationDescriptor descriptor)

Adds an ApplicationDescriptor to the registry

Parameters:

descriptor - the descriptor to be added

removeApplicationDescriptor

public void removeApplicationDescriptor(ApplicationDescriptor descriptor)

Removes an ApplicationDescriptor from the registry

Parameters:

descriptor - the descriptor to be removed

schedule

public ScheduledApplication schedule(ApplicationDescriptor descriptor,
                                     java.lang.String scheduleId,
                                     java.util.Map<java.lang.String,java.lang.Object> arguments,
                                     java.lang.String topic,
                                     java.lang.String eventFilter,
                                     boolean recurring)
                              throws InvalidSyntaxException,
                                     ApplicationException

Description copied from interface: ApplicationScheduler

Schedules an application

Specified by:

schedule in interface ApplicationScheduler

Parameters:

descriptor - the application descriptor

scheduleId - the schedule id

arguments - the handle arguments

topic - the event trigger topic

eventFilter - the optional event filter

recurring - true, if the event occurs recurring on each event

Returns:

the ScheduledApplication instance

Throws:

InvalidSyntaxException

ApplicationException

unschedule

public void unschedule(java.lang.String scheduleId)
                throws InvalidSyntaxException,
                       ApplicationException

Description copied from interface: ApplicationScheduler

Un-schedules an application for the schedule id

Specified by:

unschedule in interface ApplicationScheduler

Parameters:

scheduleId - the id of the application to be removed

Throws:

InvalidSyntaxException

ApplicationException

getAllApplications

public java.util.Set<java.lang.String> getAllApplications()

Description copied from interface: ApplicationManager

Returns all id's of application descriptors or an empty Set

Specified by:

getAllApplications in interface ApplicationManager

Returns:

all id's of application descriptors or an empty Set

getActiveApplications

public java.util.Set<java.lang.String> getActiveApplications()

Description copied from interface: ApplicationManager

Returns all id's of active application descriptors or an empty Set

Specified by:

getActiveApplications in interface ApplicationManager

Returns:

all id's of active application descriptors or an empty Set

lockApplication

public boolean lockApplication(java.lang.String applicationId)

Description copied from interface: ApplicationManager

Locks the application with the given id

Specified by:

lockApplication in interface ApplicationManager

Parameters:

applicationId - the application to lock

Returns:

true on success

unlockApplication

public boolean unlockApplication(java.lang.String applicationId)

Description copied from interface: ApplicationManager

Un-locks the application with the given id

Specified by:

unlockApplication in interface ApplicationManager

Parameters:

applicationId - the application to lock

Returns:

true on success

startApplication

public boolean startApplication(java.lang.String applicationId,
                                java.util.Map<java.lang.String,java.lang.Object> launchProperties)

Description copied from interface: ApplicationManager

Starts the application with the given id

Specified by:

startApplication in interface ApplicationManager

Parameters:

applicationId - the application to start

launchProperties - optional launch properties

Returns:

true on success

stopApplication

public boolean stopApplication(java.lang.String applicationId)

Description copied from interface: ApplicationManager

Starts the application with the given id

Specified by:

stopApplication in interface ApplicationManager

Parameters:

applicationId - the application to start

Returns:

true on success

scheduleApplication

public ScheduledApplication scheduleApplication(java.lang.String applicationId,
                                                java.util.Map<java.lang.String,java.lang.Object> launchProperties,
                                                Filter scheduleFilter)

Description copied from interface: ApplicationManager

Uses the virtual timer of the system to schedule an application

Specified by:

scheduleApplication in interface ApplicationManager

Parameters:

applicationId - the application to be run

launchProperties - the launch properties

scheduleFilter - the time based filter

Returns:

the scheduled application instance

unscheduleApplication

public boolean unscheduleApplication(java.lang.String applicationId)

Description copied from interface: ApplicationManager

Revokes the scheduling of an application

Specified by:

unscheduleApplication in interface ApplicationManager

Parameters:

applicationId - the application to be run

Returns:

true on success