org.libelektra.plugin.NativePlugin Class Reference

This class can be used to load native Elektra plugins to be used by Java directly. More...

Inheritance diagram for org.libelektra.plugin.NativePlugin:

Collaboration diagram for org.libelektra.plugin.NativePlugin:

Public Member Functions
	NativePlugin (String pluginName, Key errorKey, KeySet modules) throws InstallationException
	Constructor for loading an Elektra plugin. More...
KeySet	getConfig ()
	Gets the config which was used to configure the plugin. More...
int	open (KeySet conf, Key errorKey)
	Calls the open function of the plugin. More...
int	kdbOpen (Key errorKey)
	Opens the session with the KeyDatabase. More...
int	close (Key errorKey)
	Closes the session with the Key database. More...
int	set (KeySet keySet, Key errorKey) throws KDBException
	Lets the plugin transform the given KeySet. More...
int	get (KeySet keySet, Key errorKey) throws KDBException
	Writes into the given KeySet in the parameter. More...
int	error (KeySet keySet, Key errorKey)
	Called in case an error happened. More...
String	getName ()
	Returns the plugin name. More...

Detailed Description

This class can be used to load native Elektra plugins to be used by Java directly.

Constructor & Destructor Documentation

NativePlugin()

org.libelektra.plugin.NativePlugin.NativePlugin ( String  pluginName, Key  errorKey, KeySet  modules  ) throws InstallationException

inline

Constructor for loading an Elektra plugin.

Parameters

pluginName	The plugin name
errorKey	The errorKey
modules	#3754 add parameter description and update other

Exceptions

InstallationException

if the plugin does not exist

Member Function Documentation

close()

int org.libelektra.plugin.NativePlugin.close ( Key  errorKey )

inline

Closes the session with the Key database.

Parameters

errorKey

must be a valid key, e.g. created with Key.create()

Returns

0 if success or -1 otherwise

Implements org.libelektra.Plugin.

error()

int org.libelektra.plugin.NativePlugin.error ( KeySet  keySet, Key  errorKey  )

inline

Called in case an error happened.

Parameters

keySet	The affected KeySet
errorKey	must be a valid key, e.g. created with Key.create() and contains error information

Returns

0 if success or -1 otherwise

Implements org.libelektra.Plugin.

get()

int org.libelektra.plugin.NativePlugin.get ( KeySet  keySet, Key  errorKey  ) throws KDBException

inline

Writes into the given KeySet in the parameter.

Parameters

keySet	The KeySet you want returned
errorKey	must be a valid key, e.g. created with Key.create()

Returns

0 if success or -1 otherwise

Exceptions

KDBException

if return value was -1

Implements org.libelektra.Plugin.

getConfig()

KeySet org.libelektra.plugin.NativePlugin.getConfig ( )

inline

Gets the config which was used to configure the plugin.

Returns

A KeySet containing the configuration of the plugin

Implements org.libelektra.Plugin.

getName()

String org.libelektra.plugin.NativePlugin.getName ( )

inline

Returns the plugin name.

Returns

plugin name

Implements org.libelektra.Plugin.

kdbOpen()

int org.libelektra.plugin.NativePlugin.kdbOpen ( Key  errorKey )

inline

Opens the session with the KeyDatabase.

Parameters

errorKey

must be a valid key, e.g. created with Key.create()

Returns

0 if success or -1 otherwise

open()

int org.libelektra.plugin.NativePlugin.open ( KeySet  conf, Key  errorKey  )

inline

Calls the open function of the plugin.

Parameters

conf	a configuration keyset
errorKey	a key

Returns

the plugin's return value for open

Implements org.libelektra.Plugin.

set()

int org.libelektra.plugin.NativePlugin.set ( KeySet  keySet, Key  errorKey  ) throws KDBException

inline

Lets the plugin transform the given KeySet.

Parameters

keySet	The KeySet to transform
errorKey	must be a valid key, e.g. created with Key.create()

Returns

0 if success or -1 otherwise

Exceptions

KDBException

if return value was -1

Implements org.libelektra.Plugin.

---

The documentation for this class was generated from the following file:

• NativePlugin.java