aem-plugin / com.cognifide.gradle.aem.common.instance.service.osgi / OsgiFramework

OsgiFramework

class OsgiFramework : InstanceService

Controls OSGi framework using Apache Felix Web Console endpoints.

Constructors

<init>

Controls OSGi framework using Apache Felix Web Console endpoints.

OsgiFramework(sync: InstanceSync)

Properties

bundles

Get all OSGi bundles.

val bundles: List<Bundle>

components

Get all OSGi components.

val components: List<Component>

configurations

Get all OSGi configurations.

val configurations: Sequence<Configuration>

events

Get OSGi events for current moment.

val events: List<Event>

Functions

configure

Set properties for existing OSGi configuration.

fun configure(pid: String, properties: Map<String, Any?>): Unit

deleteConfiguration

Delete existing OSGi configuration.

fun deleteConfiguration(pid: String): Unit
fun deleteConfiguration(pid: String, service: String): Unit

determineBundleState

Determine all OSGi bundle states.

fun determineBundleState(): BundleState

determineComponentState

Determine OSGi components state.

fun determineComponentState(): ComponentState

determineConfigurationState

Determine all OSGi configuration PIDs.

fun determineConfigurationState(): ConfigurationState

determineEventState

Determine OSGi events for current moment.

fun determineEventState(): EventState

disableComponent

Disable OSGi component. Does nothing if already disabled.

fun disableComponent(pid: String): Unit

enableComponent

Enable OSGi component. Does nothing if already enabled.

fun enableComponent(pid: String): Unit

findBundle

Find OSGi bundle by symbolic name.

fun findBundle(symbolicName: String): Bundle?

findComponent

Find OSGi component by PID.

fun findComponent(pid: String): Component?

findConfiguration

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

fun findConfiguration(pid: String, metatypeChecking: Boolean = true): Configuration?

getBundle

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

fun getBundle(symbolicName: String): Bundle

getComponent

Get OSGi component by PID. Fail if not found.

fun getComponent(pid: String): Component

getConfiguration

Get OSGi configuration by PID. Fail if not found.

fun getConfiguration(pid: String): Configuration

getConfigurations

Get all OSGi configurations for specified factory PID.

fun getConfigurations(fpid: String): Sequence<Configuration>

installBundle

Install OSGi bundle JAR.

fun installBundle(bundle: File, start: Boolean = true, startLevel: Int = 20, refreshPackages: Boolean = true, retry: Retry = aem.retry()): Unit

refreshBundle

Refresh OSGi bundle by symbolic name.

fun refreshBundle(symbolicName: String): Unit

restart

Restart OSGi framework (Apache Felix)

fun restart(): Unit

restartBundle

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

fun restartBundle(symbolicName: String): Unit

restartComponent

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

fun restartComponent(pid: String): Unit

saveConfiguration

Set properties for existing OSGi configuration or create new.

fun saveConfiguration(pid: String, properties: Map<String, Any?>): Unit
fun saveConfiguration(pid: String, service: String, properties: Map<String, Any>): Unit

startBundle

Start OSGi bundle. Does nothing if already started.

fun startBundle(symbolicName: String): Unit

stop

Stop OSGi framework (Apache Felix)

fun stop(): Unit

stopBundle

Stop OSGi bundle. Does nothing if already stopped.

fun stopBundle(symbolicName: String): Unit

uninstallBundle

Uninstall OSGi bundle JAR.

fun uninstallBundle(bundle: File): Unit

Uninstall OSGi bundle by symbolic name.

fun uninstallBundle(symbolicName: String): Unit

updateBundle

Update OSGi bundle by symbolic name.

fun updateBundle(symbolicName: String): Unit

updateConfiguration

Set properties for existing OSGi configuration.

fun updateConfiguration(pid: String, properties: Map<String, Any?>): Unit
fun updateConfiguration(pid: String, service: String, properties: Map<String, Any>): Unit

Companion Object Properties

BUNDLES_LIST_JSON

const val BUNDLES_LIST_JSON: String

BUNDLES_PATH

const val BUNDLES_PATH: String

COMPONENTS_LIST_JSON

const val COMPONENTS_LIST_JSON: String

COMPONENTS_PATH

const val COMPONENTS_PATH: String

CONFIGURATION_PATH

const val CONFIGURATION_PATH: String

CONFIGURATIONS_REGEX

val CONFIGURATIONS_REGEX: Regex

EVENTS_LIST_JSON

const val EVENTS_LIST_JSON: String

VMSTAT_PATH

const val VMSTAT_PATH: String