add new function ovsec_kadm_flush

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@7964 dc483132-0cff-0310-8789-dd5450dbe970

diff --git a/doc/kadm5/api-funcspec.tex b/doc/kadm5/api-funcspec.tex
index 59a787e7a7e01abfbefebe7a395805f20392aab3..febcac79324868f56b88f4311d41f9cda9faae67 100644 (file)
--- a/doc/kadm5/api-funcspec.tex
+++ b/doc/kadm5/api-funcspec.tex
@@ -591,6 +591,8 @@ library using a password to obtain initial credentials. \\
 init_with_skey & none & Open a connection with the ovsec_kadm library
 using the keytab entry to obtain initial credentials. \\
 destroy & none & Close the connection with the ovsec_kadm library. \\
+flush & none & Flush all database changes to disk; no-op when called
+remotely. \\
 create_principal & add & Create a new principal. \\
 delete_principal & delete & Delete a principal. \\
 modify_principal & modify & Modify the attributes of an existing
@@ -739,6 +741,30 @@ not found in database'' for these required principals.
 
 \end{description}
 
+\subsection{ovsec_kadm_flush}
+
+\begin{verbatim}
+ovsec_kadm_ret_t ovsec_kadm_flush(void *server_handle)
+\end{verbatim}
+
+AUTHORIZATION REQUIRED: none
+
+Flush all changes to the Kerberos databases, leaving the connection to
+the Admin API open.  This function behaves differently when called by
+local and remote clients.
+
+For local clients, the function closes and reopens the Kerberos
+database with krb5_db_fini() and krb5_db_init(), and closes and
+reopens the Admin policy database with adb_policy_close() and
+adb_policy_open().  Although it is unlikely, any other these functions
+could return errors; in that case, this function calls
+ovsec_kadm_destroy and returns the error code.  Therefore, if
+ovsec_kadm_flush does not return OVSEC_KADM_OK, the connection to the
+Admin server has been terminated and, in principle, the databases
+might be corrupt.
+
+For remote clients, the function is a no-op.
+
 \subsection{ovsec_kadm_destroy}
 
 \begin{verbatim}