org.fabric3.spi.management

Interface ManagementExtension

public interface ManagementExtension

Exposes a component to a management protocol such as JMX or REST.

Method Summary

Modifier and Type	Method and Description
void	export(java.lang.String name, java.lang.String group, java.lang.String description, java.lang.Object instance) Exposes an instance for management as a system resource.
void	export(java.net.URI componentUri, org.fabric3.api.model.type.java.ManagementInfo info, java.util.function.Supplier<?> supplier) Exposes a component for management.
java.lang.String	getType() Returns the unique extension identifier.
void	remove(java.lang.String name, java.lang.String group) Removes an instance from the underlying management framework.
void	remove(java.net.URI componentUri, org.fabric3.api.model.type.java.ManagementInfo info) Removes a component from the underlying management framework.

Method Detail

getType

java.lang.String getType()

Returns the unique extension identifier.

Returns:

the unique extension identifier

export

void export(java.net.URI componentUri,
            org.fabric3.api.model.type.java.ManagementInfo info,
            java.util.function.Supplier<?> supplier)
     throws org.fabric3.api.host.Fabric3Exception

Exposes a component for management.

Parameters:

componentUri - the component URI

info - the management metadata

supplier - the Supplier responsible for returning the managed component instance

Throws:

org.fabric3.api.host.Fabric3Exception - if an error exposing the component is encountered

export

void export(java.lang.String name,
            java.lang.String group,
            java.lang.String description,
            java.lang.Object instance)
     throws org.fabric3.api.host.Fabric3Exception

Exposes an instance for management as a system resource.

Parameters:

name - the management name

group - the management group

description - the instance description

instance - the instance

Throws:

org.fabric3.api.host.Fabric3Exception - if an error exposing the instance is encountered

remove

void remove(java.net.URI componentUri,
            org.fabric3.api.model.type.java.ManagementInfo info)
     throws org.fabric3.api.host.Fabric3Exception

Removes a component from the underlying management framework.

Parameters:

componentUri - the component URI

info - the management metadata

Throws:

org.fabric3.api.host.Fabric3Exception - if an error removing the component is encountered

remove

void remove(java.lang.String name,
            java.lang.String group)
     throws org.fabric3.api.host.Fabric3Exception

Removes an instance from the underlying management framework.

Parameters:

name - the management name

group - the management group

Throws:

org.fabric3.api.host.Fabric3Exception - if an error removing the component is encountered