com.cognifide.gradle.aem.common.instance.service.osgi

Class OsgiFramework

InstanceService

com.cognifide.gradle.aem.common.instance.service.osgi.OsgiFramework

public class OsgiFramework
extends InstanceService

Controls OSGi framework using Apache Felix Web Console endpoints.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OsgiFramework.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLES_LIST_JSON
static java.lang.String	BUNDLES_PATH
static java.lang.String	COMPONENTS_LIST_JSON
static java.lang.String	COMPONENTS_PATH
static java.lang.String	CONFIGURATION_PATH
static OsgiFramework.Companion	Companion
static java.lang.String	EVENTS_LIST_JSON
static java.lang.String	VMSTAT_PATH

Constructor Summary

Constructors

Constructor and Description
OsgiFramework(InstanceSync sync) Controls OSGi framework using Apache Felix Web Console endpoints.

Method Summary

Modifier and Type	Method and Description
void	configure(java.lang.String pid, java.util.Map<java.lang.String,? extends java.lang.Object> properties) Set properties for existing OSGi configuration.
void	deleteConfiguration(java.lang.String pid) Delete existing OSGi configuration.
void	deleteConfiguration(java.lang.String pid, java.lang.String service) Delete existing OSGi configuration.
BundleState	determineBundleState() Determine all OSGi bundle states.
ComponentState	determineComponentState() Determine OSGi components state.
ConfigurationState	determineConfigurationState() Determine all OSGi configuration PIDs.
EventState	determineEventState() Determine OSGi events for current moment.
void	disableComponent(java.lang.String pid) Disable OSGi component. Does nothing if already disabled.
void	enableComponent(java.lang.String pid) Enable OSGi component. Does nothing if already enabled.
Bundle	findBundle(java.lang.String symbolicName) Find OSGi bundle by symbolic name.
Component	findComponent(java.lang.String pid) Find OSGi component by PID.
Configuration	findConfiguration(java.lang.String pid, boolean metatypeChecking) Find OSGi configuration by PID. Also ensures that for given configuration there is metatype service available (to reduce typo errors).
Bundle	getBundle(java.lang.String symbolicName) Get OSGi bundle by symbolic name. Fail if not found.
java.util.List<com.cognifide.gradle.aem.common.instance.service.osgi.Bundle>	getBundles() Get all OSGi bundles.
Component	getComponent(java.lang.String pid) Get OSGi component by PID. Fail if not found.
java.util.List<com.cognifide.gradle.aem.common.instance.service.osgi.Component>	getComponents() Get all OSGi components.
Configuration	getConfiguration(java.lang.String pid) Get OSGi configuration by PID. Fail if not found.
kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.osgi.Configuration>	getConfigurations() Get all OSGi configurations.
kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.osgi.Configuration>	getConfigurations(java.lang.String fpid) Get all OSGi configurations for specified factory PID.
java.util.List<com.cognifide.gradle.aem.common.instance.service.osgi.Event>	getEvents() Get OSGi events for current moment.
void	refreshBundle(java.lang.String symbolicName) Refresh OSGi bundle by symbolic name.
void	restart() Restart OSGi framework (Apache Felix)
void	restartBundle(java.lang.String symbolicName) Stop then start again OSGi bundle. Works correctly even it is already stopped.
void	restartComponent(java.lang.String pid) Disable then enable again OSGi component. Works correctly even it is already disabled.
void	saveConfiguration(java.lang.String pid, java.util.Map<java.lang.String,? extends java.lang.Object> properties) Set properties for existing OSGi configuration or create new.
void	saveConfiguration(java.lang.String pid, java.lang.String service, java.util.Map<java.lang.String,? extends java.lang.Object> properties) Set properties for existing OSGi configuration or create new.
void	startBundle(java.lang.String symbolicName) Start OSGi bundle. Does nothing if already started.
void	stop() Stop OSGi framework (Apache Felix)
void	stopBundle(java.lang.String symbolicName) Stop OSGi bundle. Does nothing if already stopped.
void	updateBundle(java.lang.String symbolicName) Update OSGi bundle by symbolic name.
void	updateConfiguration(java.lang.String pid, java.util.Map<java.lang.String,? extends java.lang.Object> properties) Set properties for existing OSGi configuration.
void	updateConfiguration(java.lang.String pid, java.lang.String service, java.util.Map<java.lang.String,? extends java.lang.Object> properties) Set properties for existing OSGi configuration.

Methods inherited from class com.cognifide.gradle.aem.common.instance.InstanceService

getAem, getInstance, getProject, getSync

Field Detail

BUNDLES_PATH

@NotNull
public static java.lang.String BUNDLES_PATH

See Also:

Constant Field Values

BUNDLES_LIST_JSON

@NotNull
public static java.lang.String BUNDLES_LIST_JSON

See Also:

Constant Field Values

COMPONENTS_PATH

@NotNull
public static java.lang.String COMPONENTS_PATH

See Also:

Constant Field Values

COMPONENTS_LIST_JSON

@NotNull
public static java.lang.String COMPONENTS_LIST_JSON

See Also:

Constant Field Values

EVENTS_LIST_JSON

@NotNull
public static java.lang.String EVENTS_LIST_JSON

See Also:

Constant Field Values

VMSTAT_PATH

@NotNull
public static java.lang.String VMSTAT_PATH

See Also:

Constant Field Values

CONFIGURATION_PATH

@NotNull
public static java.lang.String CONFIGURATION_PATH

See Also:

Constant Field Values

Companion

public static OsgiFramework.Companion Companion

Constructor Detail

OsgiFramework

public OsgiFramework(@NotNull
                     InstanceSync sync)

Controls OSGi framework using Apache Felix Web Console endpoints.

Method Detail

getBundles

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.service.osgi.Bundle> getBundles()

Get all OSGi bundles.

determineBundleState

@NotNull
public BundleState determineBundleState()

Determine all OSGi bundle states.

findBundle

@Nullable
public Bundle findBundle(@NotNull
                                    java.lang.String symbolicName)

Find OSGi bundle by symbolic name.

getBundle

@NotNull
public Bundle getBundle(@NotNull
                                  java.lang.String symbolicName)

Get OSGi bundle by symbolic name. Fail if not found.

startBundle

public void startBundle(@NotNull
                        java.lang.String symbolicName)

Start OSGi bundle. Does nothing if already started.

stopBundle

public void stopBundle(@NotNull
                       java.lang.String symbolicName)

Stop OSGi bundle. Does nothing if already stopped.

restartBundle

public void restartBundle(@NotNull
                          java.lang.String symbolicName)

Stop then start again OSGi bundle. Works correctly even it is already stopped.

refreshBundle

public void refreshBundle(@NotNull
                          java.lang.String symbolicName)

Refresh OSGi bundle by symbolic name.

updateBundle

public void updateBundle(@NotNull
                         java.lang.String symbolicName)

Update OSGi bundle by symbolic name.

getComponents

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.service.osgi.Component> getComponents()

Get all OSGi components.

determineComponentState

@NotNull
public ComponentState determineComponentState()

Determine OSGi components state.

findComponent

@Nullable
public Component findComponent(@NotNull
                                          java.lang.String pid)

Find OSGi component by PID.

getComponent

@NotNull
public Component getComponent(@NotNull
                                        java.lang.String pid)

Get OSGi component by PID. Fail if not found.

enableComponent

public void enableComponent(@NotNull
                            java.lang.String pid)

Enable OSGi component. Does nothing if already enabled.

disableComponent

public void disableComponent(@NotNull
                             java.lang.String pid)

Disable OSGi component. Does nothing if already disabled.

restartComponent

public void restartComponent(@NotNull
                             java.lang.String pid)

Disable then enable again OSGi component. Works correctly even it is already disabled.

configure

public void configure(@NotNull
                      java.lang.String pid,
                      @NotNull
                      java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Set properties for existing OSGi configuration.

getConfigurations

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.osgi.Configuration> getConfigurations()

Get all OSGi configurations.

determineConfigurationState

@NotNull
public ConfigurationState determineConfigurationState()

Determine all OSGi configuration PIDs.

findConfiguration

@Nullable
public Configuration findConfiguration(@NotNull
                                                  java.lang.String pid,
                                                  boolean metatypeChecking)

Find OSGi configuration by PID. Also ensures that for given configuration there is metatype service available (to reduce typo errors).

getConfiguration

@NotNull
public Configuration getConfiguration(@NotNull
                                                java.lang.String pid)

Get OSGi configuration by PID. Fail if not found.

getConfigurations

@NotNull
public kotlin.sequences.Sequence<com.cognifide.gradle.aem.common.instance.service.osgi.Configuration> getConfigurations(@NotNull
                                                                                                                                  java.lang.String fpid)

Get all OSGi configurations for specified factory PID.

updateConfiguration

public void updateConfiguration(@NotNull
                                java.lang.String pid,
                                @NotNull
                                java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Set properties for existing OSGi configuration.

updateConfiguration

public void updateConfiguration(@NotNull
                                java.lang.String pid,
                                @NotNull
                                java.lang.String service,
                                @NotNull
                                java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Set properties for existing OSGi configuration.

saveConfiguration

public void saveConfiguration(@NotNull
                              java.lang.String pid,
                              @NotNull
                              java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Set properties for existing OSGi configuration or create new.

saveConfiguration

public void saveConfiguration(@NotNull
                              java.lang.String pid,
                              @NotNull
                              java.lang.String service,
                              @NotNull
                              java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Set properties for existing OSGi configuration or create new.

deleteConfiguration

public void deleteConfiguration(@NotNull
                                java.lang.String pid)

Delete existing OSGi configuration.

deleteConfiguration

public void deleteConfiguration(@NotNull
                                java.lang.String pid,
                                @NotNull
                                java.lang.String service)

Delete existing OSGi configuration.

getEvents

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.service.osgi.Event> getEvents()

Get OSGi events for current moment.

determineEventState

@NotNull
public EventState determineEventState()

Determine OSGi events for current moment.

restart

public void restart()

Restart OSGi framework (Apache Felix)

stop

public void stop()

Stop OSGi framework (Apache Felix)

Warning! After executing instance will be no longer available.