\hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin}{}\doxysection{org.\+libelektra.\+plugin.\+Native\+Plugin Class Reference}
\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin}\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}


This class can be used to load native \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} plugins to be used by Java directly.  




Inheritance diagram for org.\+libelektra.\+plugin.\+Native\+Plugin\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=230pt]{classorg_1_1libelektra_1_1plugin_1_1NativePlugin__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for org.\+libelektra.\+plugin.\+Native\+Plugin\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=230pt]{classorg_1_1libelektra_1_1plugin_1_1NativePlugin__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_ad228084d20bd57c561e49ee755e9c751}{Native\+Plugin}} (String plugin\+Name, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} error\+Key, \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} modules)  throws Installation\+Exception  
\begin{DoxyCompactList}\small\item\em Constructor for loading an \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} plugin. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_af9c78565029ed2ae38241759549e4b5a}{get\+Config}} ()
\begin{DoxyCompactList}\small\item\em Gets the config which was used to configure the plugin. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a81510de92e0d65784e877bf53b89756a}{open}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} conf, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} error\+Key)
\begin{DoxyCompactList}\small\item\em Calls the open function of the plugin. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a232c37208b79734c6be8a9f426efa56a}{kdb\+Open}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} error\+Key)
\begin{DoxyCompactList}\small\item\em Opens the session with the Key\+Database. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_acd6f4e0e81a11a1eba64dfa164c67a1f}{close}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} error\+Key)
\begin{DoxyCompactList}\small\item\em Closes the session with the \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} database. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a9faeb1e6eb90a4c90681eeeb097eeb53}{set}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} error\+Key)  throws KDBException  
\begin{DoxyCompactList}\small\item\em Lets the plugin transform the given \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a766870e5f26cab4d497ed7c2fbc4abd9}{get}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} error\+Key)  throws KDBException  
\begin{DoxyCompactList}\small\item\em Writes into the given \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} in the parameter. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a54c2753b1d17e14be39526a6ff02e34d}{error}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} error\+Key)
\begin{DoxyCompactList}\small\item\em Called in case an error happened. \end{DoxyCompactList}\item 
String \mbox{\hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a606fc8f54bc810d874176103859976ab}{get\+Name}} ()
\begin{DoxyCompactList}\small\item\em Returns the plugin name. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This class can be used to load native \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} plugins to be used by Java directly. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_ad228084d20bd57c561e49ee755e9c751}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_ad228084d20bd57c561e49ee755e9c751}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!NativePlugin@{NativePlugin}}
\index{NativePlugin@{NativePlugin}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{NativePlugin()}{NativePlugin()}}
{\footnotesize\ttfamily org.\+libelektra.\+plugin.\+Native\+Plugin.\+Native\+Plugin (\begin{DoxyParamCaption}\item[{String}]{plugin\+Name,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{error\+Key,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{modules }\end{DoxyParamCaption}) throws Installation\+Exception\hspace{0.3cm}{\ttfamily [inline]}}



Constructor for loading an \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} plugin. 


\begin{DoxyParams}{Parameters}
{\em plugin\+Name} & The plugin name \\
\hline
{\em error\+Key} & The error\+Key \\
\hline
{\em modules} & \#3754 add parameter description and update other \\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em Installation\+Exception} & if the plugin does not exist \\
\hline
\end{DoxyExceptions}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_acd6f4e0e81a11a1eba64dfa164c67a1f}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_acd6f4e0e81a11a1eba64dfa164c67a1f}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!close@{close}}
\index{close@{close}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{close()}{close()}}
{\footnotesize\ttfamily int org.\+libelektra.\+plugin.\+Native\+Plugin.\+close (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{error\+Key }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Closes the session with the \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} database. 


\begin{DoxyParams}{Parameters}
{\em error\+Key} & must be a valid key, e.\+g. created with \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_af407cf43625618af4e7fb2576037fcfc}{Key.\+create()}} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if success or -\/1 otherwise 
\end{DoxyReturn}


Implements \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_aa5d4abf6ffd0d477d6972b13bed05d41}{org.\+libelektra.\+Plugin}}.

\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a54c2753b1d17e14be39526a6ff02e34d}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a54c2753b1d17e14be39526a6ff02e34d}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!error@{error}}
\index{error@{error}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{error()}{error()}}
{\footnotesize\ttfamily int org.\+libelektra.\+plugin.\+Native\+Plugin.\+error (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{key\+Set,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{error\+Key }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Called in case an error happened. 


\begin{DoxyParams}{Parameters}
{\em key\+Set} & The affected \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \\
\hline
{\em error\+Key} & must be a valid key, e.\+g. created with \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_af407cf43625618af4e7fb2576037fcfc}{Key.\+create()}} and contains error information \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if success or -\/1 otherwise 
\end{DoxyReturn}


Implements \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_aa91370570c862ebe9eb83094a4731b9a}{org.\+libelektra.\+Plugin}}.

\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a766870e5f26cab4d497ed7c2fbc4abd9}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a766870e5f26cab4d497ed7c2fbc4abd9}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!get@{get}}
\index{get@{get}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{get()}{get()}}
{\footnotesize\ttfamily int org.\+libelektra.\+plugin.\+Native\+Plugin.\+get (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{key\+Set,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{error\+Key }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classorg_1_1libelektra_1_1exception_1_1KDBException}{KDBException}}\hspace{0.3cm}{\ttfamily [inline]}}



Writes into the given \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} in the parameter. 


\begin{DoxyParams}{Parameters}
{\em key\+Set} & The \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} you want returned \\
\hline
{\em error\+Key} & must be a valid key, e.\+g. created with \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_af407cf43625618af4e7fb2576037fcfc}{Key.\+create()}} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if success or -\/1 otherwise 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em KDBException} & if return value was -\/1 \\
\hline
\end{DoxyExceptions}


Implements \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a9b8362549b7ab8ca5eff39cf6b7c8046}{org.\+libelektra.\+Plugin}}.

\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_af9c78565029ed2ae38241759549e4b5a}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_af9c78565029ed2ae38241759549e4b5a}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!getConfig@{getConfig}}
\index{getConfig@{getConfig}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{getConfig()}{getConfig()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+plugin.\+Native\+Plugin.\+get\+Config (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Gets the config which was used to configure the plugin. 

\begin{DoxyReturn}{Returns}
A \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} containing the configuration of the plugin 
\end{DoxyReturn}


Implements \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a95ee37a782d5bd32fd95478788652d44}{org.\+libelektra.\+Plugin}}.

\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a606fc8f54bc810d874176103859976ab}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a606fc8f54bc810d874176103859976ab}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!getName@{getName}}
\index{getName@{getName}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
{\footnotesize\ttfamily String org.\+libelektra.\+plugin.\+Native\+Plugin.\+get\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Returns the plugin name. 

\begin{DoxyReturn}{Returns}
plugin name 
\end{DoxyReturn}


Implements \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a51be1d6efdd3542c2ae503031bd16e04}{org.\+libelektra.\+Plugin}}.

\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a232c37208b79734c6be8a9f426efa56a}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a232c37208b79734c6be8a9f426efa56a}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!kdbOpen@{kdbOpen}}
\index{kdbOpen@{kdbOpen}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{kdbOpen()}{kdbOpen()}}
{\footnotesize\ttfamily int org.\+libelektra.\+plugin.\+Native\+Plugin.\+kdb\+Open (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{error\+Key }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Opens the session with the Key\+Database. 


\begin{DoxyParams}{Parameters}
{\em error\+Key} & must be a valid key, e.\+g. created with \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_af407cf43625618af4e7fb2576037fcfc}{Key.\+create()}} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if success or -\/1 otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a81510de92e0d65784e877bf53b89756a}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a81510de92e0d65784e877bf53b89756a}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!open@{open}}
\index{open@{open}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{open()}{open()}}
{\footnotesize\ttfamily int org.\+libelektra.\+plugin.\+Native\+Plugin.\+open (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{conf,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{error\+Key }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Calls the open function of the plugin. 


\begin{DoxyParams}{Parameters}
{\em conf} & a configuration keyset \\
\hline
{\em error\+Key} & a key \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the plugin\textquotesingle{}s return value for open 
\end{DoxyReturn}


Implements \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a740f0602ea62e7a28c86fc801add8907}{org.\+libelektra.\+Plugin}}.

\mbox{\Hypertarget{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a9faeb1e6eb90a4c90681eeeb097eeb53}\label{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a9faeb1e6eb90a4c90681eeeb097eeb53}} 
\index{org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}!set@{set}}
\index{set@{set}!org.libelektra.plugin.NativePlugin@{org.libelektra.plugin.NativePlugin}}
\doxysubsubsection{\texorpdfstring{set()}{set()}}
{\footnotesize\ttfamily int org.\+libelektra.\+plugin.\+Native\+Plugin.\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{key\+Set,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{error\+Key }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classorg_1_1libelektra_1_1exception_1_1KDBException}{KDBException}}\hspace{0.3cm}{\ttfamily [inline]}}



Lets the plugin transform the given \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}. 


\begin{DoxyParams}{Parameters}
{\em key\+Set} & The \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} to transform \\
\hline
{\em error\+Key} & must be a valid key, e.\+g. created with \mbox{\hyperlink{classorg_1_1libelektra_1_1Key_af407cf43625618af4e7fb2576037fcfc}{Key.\+create()}} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if success or -\/1 otherwise 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em KDBException} & if return value was -\/1 \\
\hline
\end{DoxyExceptions}


Implements \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a650ce789086f5becf21c5f91fad4c42e}{org.\+libelektra.\+Plugin}}.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
Native\+Plugin.\+java\end{DoxyCompactItemize}
