org.codice.ddf.admin.application.service.impl

Class ApplicationServiceImpl

java.lang.Object

org.codice.ddf.admin.application.service.impl.ApplicationServiceImpl

All Implemented Interfaces:

EventListener, ApplicationService, org.osgi.framework.ServiceListener

public class ApplicationServiceImpl
extends Object
implements ApplicationService, org.osgi.framework.ServiceListener

Implementation of the ApplicationService. Uses the karaf features service and bundle state service to determine current state of items in karaf.

Constructor Summary

Constructors

Constructor and Description
ApplicationServiceImpl(List<org.apache.karaf.bundle.core.BundleStateService> bundleStateServices) Creates a new instance of Application Service.

Method Summary

Modifier and Type	Method and Description
void	addApplication(URI applicationURL) Adds a new application to the application list.
List<FeatureDetails>	findApplicationFeatures(String applicationName) Returns List of FeatureDtos with repository and status information by Application
Application	findFeature(org.apache.karaf.features.Feature feature) Determine which application contains a certain feature.
protected Application	findFeature(org.apache.karaf.features.Feature feature, Set<Application> applications) Locates a given feature within the specified set of applications.
List<FeatureDetails>	getAllFeatures() Returns List of FeatureDtos with repository and status information
Application	getApplication(String applicationName) Returns the application that has the given name
Set<Application>	getApplications() Retrieve a set of applications are currently installed in the system.
ApplicationStatus	getApplicationStatus(Application application) Retrieve the status for the given application.
Set<ApplicationNode>	getApplicationTree() Creates a hierarchy tree of application nodes that show the relationship between applications.
protected org.osgi.framework.BundleContext	getContext()
List<org.apache.karaf.features.Feature>	getInstallationProfiles() Gets the application Profile features on the system.
boolean	isApplicationStarted(Application application) Determine if an application is currently started.
boolean	isPermittedToViewFeature(String featureName)
void	removeApplication(Application application) Removes the given application.
void	removeApplication(String applicationName) Removes an application that has the given name.
void	removeApplication(URI applicationURL) Removes an application that has the given URI.
void	serviceChanged(org.osgi.framework.ServiceEvent serviceEvent)
void	setConfigFileName(String configFileName) Sets the configuration file used for initial installation and starts the installation.
void	setIgnoredApplications(List<String> applicationNames) Sets the names of applications that this service should ignore when checking status.
void	startApplication(Application application) Starts an application, including any defined dependencies in the application.
void	startApplication(String application) Starts an application, including any defined dependencies in the application.
void	stopApplication(Application application) Stops an application, does not include any external transitive dependencies as they may be needed by other applications.
void	stopApplication(String application) Stops an application, does not include any external transitive dependencies as they may be needed by other applications.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationServiceImpl

public ApplicationServiceImpl(List<org.apache.karaf.bundle.core.BundleStateService> bundleStateServices)

Creates a new instance of Application Service.

Parameters:

bundleStateServices - List of BundleStateServices that allow fine-grained information about bundle status for deployment services (like blueprint and spring).

Method Detail

getApplications

public Set<Application> getApplications()

Description copied from interface: ApplicationService

Retrieve a set of applications are currently installed in the system.

Specified by:

getApplications in interface ApplicationService

Returns:

Set of applications.

getApplication

public Application getApplication(String applicationName)

Description copied from interface: ApplicationService

Returns the application that has the given name

Specified by:

getApplication in interface ApplicationService

Parameters:

applicationName - Name of the application to retrieve. Is case-insensitive.

Returns:

The application that matches the name or null if no application matched.

isApplicationStarted

public boolean isApplicationStarted(Application application)

Description copied from interface: ApplicationService

Determine if an application is currently started.

Specified by:

isApplicationStarted in interface ApplicationService

Parameters:

application - Application to check if started.

Returns:

true if application is ACTIVE, false if it is FAILED, INACTIVE, or UNKNOWN.

See Also:

ApplicationStatus.ApplicationState

getApplicationStatus

public ApplicationStatus getApplicationStatus(Application application)

Description copied from interface: ApplicationService

Retrieve the status for the given application.

Specified by:

getApplicationStatus in interface ApplicationService

Parameters:

application - Application to obtain status for.

Returns:

Status for the application.

setIgnoredApplications

public void setIgnoredApplications(List<String> applicationNames)

Sets the names of applications that this service should ignore when checking status.

Parameters:

applicationNames - List of application names, these names must exactly match the name of the application to ignore.

setConfigFileName

public void setConfigFileName(String configFileName)

Sets the configuration file used for initial installation and starts the installation.

Parameters:

configFileName - Absolute path name of the file containing the application list.

getContext

protected org.osgi.framework.BundleContext getContext()

getApplicationTree

public Set<ApplicationNode> getApplicationTree()

Description copied from interface: ApplicationService

Creates a hierarchy tree of application nodes that show the relationship between applications.

Specified by:

getApplicationTree in interface ApplicationService

Returns:

set of the root application nodes that will contain all other applications as their children.

findFeature

public Application findFeature(org.apache.karaf.features.Feature feature)

Description copied from interface: ApplicationService

Determine which application contains a certain feature.

Specified by:

findFeature in interface ApplicationService

Parameters:

feature - The feature to search for.

Returns:

The application which contains that feature.

getInstallationProfiles

public List<org.apache.karaf.features.Feature> getInstallationProfiles()

Description copied from interface: ApplicationService

Gets the application Profile features on the system.

Specified by:

getInstallationProfiles in interface ApplicationService

Returns:

the inatllation profiles.

findFeature

protected Application findFeature(org.apache.karaf.features.Feature feature,
                                  Set<Application> applications)

Locates a given feature within the specified set of applications.

Parameters:

feature - Feature to look for.

applications - Set of applications to check for the feature.

Returns:

The first application that contains the feature or null if no application contains the feature.

startApplication

public void startApplication(Application application)
                      throws ApplicationServiceException

Description copied from interface: ApplicationService

Starts an application, including any defined dependencies in the application. The main feature of the application is started before other auto-install features.

TODO DDF-3076 Re-evaluate the implementation of the ApplicationService

Specified by:

startApplication in interface ApplicationService

Parameters:

application - Application instance to start.

Throws:

ApplicationServiceException - If the application cannot start due to an error, the exception will be thrown with the error message.

startApplication

public void startApplication(String application)
                      throws ApplicationServiceException

Description copied from interface: ApplicationService

Starts an application, including any defined dependencies in the application. The main feature of the application is started before other auto-install features.

TODO DDF-3076 Re-evaluate the implementation of the ApplicationService

Specified by:

startApplication in interface ApplicationService

Parameters:

application - Name of the application to start.

Throws:

ApplicationServiceException - If the application cannot start due to an error, the exception will be thrown with the error message.

stopApplication

public void stopApplication(Application application)
                     throws ApplicationServiceException

Description copied from interface: ApplicationService

Stops an application, does not include any external transitive dependencies as they may be needed by other applications.

Specified by:

stopApplication in interface ApplicationService

Parameters:

application - Application instance to stop.

Throws:

ApplicationServiceException - If the application cannot stop due to an error (or it is not started), the exception will be thrown with the error message.

stopApplication

public void stopApplication(String application)
                     throws ApplicationServiceException

Description copied from interface: ApplicationService

Stops an application, does not include any external transitive dependencies as they may be needed by other applications.

Specified by:

stopApplication in interface ApplicationService

Parameters:

application - Name of the application to stop.

Throws:

ApplicationServiceException - If the application cannot stop due to an error (or it is not started), the exception will be thrown with the error message.

addApplication

public void addApplication(URI applicationURL)
                    throws ApplicationServiceException

Description copied from interface: ApplicationService

Adds a new application to the application list.

NOTE: This does NOT start the application

Specified by:

addApplication in interface ApplicationService

Parameters:

applicationURL - URL location of the application. Currently must be a features repository.

Throws:

ApplicationServiceException - If there is an error trying to add the application.

removeApplication

public void removeApplication(URI applicationURL)
                       throws ApplicationServiceException

Description copied from interface: ApplicationService

Removes an application that has the given URI.

Specified by:

removeApplication in interface ApplicationService

Parameters:

applicationURL - URL location of the application. Currently must be a features repository.

Throws:

ApplicationServiceException - If there is an error trying to remove the application.

removeApplication

public void removeApplication(Application application)
                       throws ApplicationServiceException

Description copied from interface: ApplicationService

Removes the given application.

Specified by:

removeApplication in interface ApplicationService

Parameters:

application - Application instance to remove.

Throws:

ApplicationServiceException - If there is an error trying to remove the application.

removeApplication

public void removeApplication(String applicationName)
                       throws ApplicationServiceException

Description copied from interface: ApplicationService

Removes an application that has the given name.

Specified by:

removeApplication in interface ApplicationService

Parameters:

applicationName - Name of the application to remove.

Throws:

ApplicationServiceException - If there is an error trying to remove the application.

getAllFeatures

public List<FeatureDetails> getAllFeatures()

Description copied from interface: ApplicationService

Returns List of FeatureDtos with repository and status information

Specified by:

getAllFeatures in interface ApplicationService

Returns:

findApplicationFeatures

public List<FeatureDetails> findApplicationFeatures(String applicationName)

Description copied from interface: ApplicationService

Returns List of FeatureDtos with repository and status information by Application

Specified by:

findApplicationFeatures in interface ApplicationService

Returns:

serviceChanged

public void serviceChanged(org.osgi.framework.ServiceEvent serviceEvent)

Specified by:

serviceChanged in interface org.osgi.framework.ServiceListener

isPermittedToViewFeature

public boolean isPermittedToViewFeature(String featureName)