net.corda.core.node / CordaPluginRegistry

CordaPluginRegistry

abstract class CordaPluginRegistry

Implement this interface on a class advertised in a META-INF/services/net.corda.core.node.CordaPluginRegistry file to extend a Corda node with additional application services.



Constructors

<init> CordaPluginRegistry()

Implement this interface on a class advertised in a META-INF/services/net.corda.core.node.CordaPluginRegistry file to extend a Corda node with additional application services.

Properties

requiredProtocols open val requiredProtocols: Map<String, Set<String>>

A Map with an entry for each consumed protocol used by the webAPIs. The key of each map entry should contain the ProtocolLogic class name. The associated map values are the union of all concrete class names passed to the protocol constructor. Standard java.lang.* and kotlin.* types do not need to be included explicitly. This is used to extend the white listed protocols that can be initiated from the ServiceHub invokeProtocolAsync method.

servicePlugins open val servicePlugins: List<Class<*>>

List of additional long lived services to be hosted within the node. They are expected to have a single parameter constructor that takes a PluginServiceHub as input. The PluginServiceHub will be fully constructed before the plugin service is created and will allow access to the protocol factory and protocol initiation entry points there.

staticServeDirs open val staticServeDirs: Map<String, String>

Map of static serving endpoints to the matching resource directory. All endpoints will be prefixed with "/web" and postfixed with "\*. Resource directories can be either on disk directories (especially when debugging) in the form "a/b/c". Serving from a JAR can be specified with: javaClass.getResource("<folder-in-jar>").toExternalForm()

webApis open val webApis: List<Class<*>>

List of JAX-RS classes inside the contract jar. They are expected to have a single parameter constructor that takes a ServiceHub as input. These are listed as Class<*>, because in the future they will be instantiated inside a ClassLoader so that Cordapp code can be loaded dynamically.

Inheritors

Plugin class Plugin : CordaPluginRegistry
Plugin class Plugin : CordaPluginRegistry