org.apache.kerby.kerberos.kerb.admin.kadmin

Interface Kadmin

All Known Subinterfaces:

LocalKadmin

All Known Implementing Classes:

LocalKadminImpl, RemoteKadminImpl

public interface Kadmin

Server side admin facilities from remote, similar to MIT kadmin remote mode.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPrincipal(String principal) Add principal to backend.
void	addPrincipal(String principal, org.apache.kerby.KOptions kOptions) Add principal to backend.
void	addPrincipal(String principal, String password) Add principal to backend.
void	addPrincipal(String principal, String password, org.apache.kerby.KOptions kOptions) Add principal to backend.
void	changePassword(String principal, String newPassword) Change the password of specified principal.
void	deletePrincipal(String principal) Delete the principal in backend.
void	exportKeytab(File keytabFile) Export all identity keys to the specified keytab file.
void	exportKeytab(File keytabFile, List<String> principals) Export all the keys of the specified principals into the specified keytab file.
void	exportKeytab(File keytabFile, String principal) Export all the keys of the specified principal into the specified keytab file.
String	getKadminPrincipal() Get the kadmin principal name.
List<String>	getPrincipals() Get all the principal names from backend.
List<String>	getPrincipals(String globString) Get all the principal names that meets the pattern
void	modifyPrincipal(String principal, org.apache.kerby.KOptions kOptions) Modify the principal with KOptions.
void	release() Release any resources associated.
void	removeKeytabEntriesOf(File keytabFile, String principal) Remove all the keys of the specified principal in the specified keytab file.
void	removeKeytabEntriesOf(File keytabFile, String principal, int kvno) Remove all the keys of the specified principal with specified kvno in the specified keytab file.
void	removeOldKeytabEntriesOf(File keytabFile, String principal) Remove all the old keys of the specified principal in the specified keytab file.
void	renamePrincipal(String oldPrincipalName, String newPrincipalName) Rename the principal.
void	updateKeys(String principal) Update the random keys of specified principal.

Method Detail

getKadminPrincipal

String getKadminPrincipal()

Get the kadmin principal name.

Returns:

The kadmin principal name.

addPrincipal

void addPrincipal(String principal)
                  throws KrbException

Add principal to backend.

Parameters:

principal - The principal to be added into backend

Throws:

KrbException - e

addPrincipal

void addPrincipal(String principal,
                org.apache.kerby.KOptions kOptions)
                  throws KrbException

Add principal to backend.

Parameters:

principal - The principal to be added into backend

kOptions - The KOptions with principal info

Throws:

KrbException - e

addPrincipal

void addPrincipal(String principal,
                String password)
                  throws KrbException

Add principal to backend.

Parameters:

principal - The principal to be added into backend

password - The password to create encryption key

Throws:

KrbException - e

addPrincipal

void addPrincipal(String principal,
                String password,
                org.apache.kerby.KOptions kOptions)
                  throws KrbException

Add principal to backend.

Parameters:

principal - The principal to be added into backend

password - The password to create encryption key

kOptions - The KOptions with principal info

Throws:

KrbException - e

exportKeytab

void exportKeytab(File keytabFile,
                String principal)
                  throws KrbException

Export all the keys of the specified principal into the specified keytab file.

Parameters:

keytabFile - The keytab file

principal - The principal name

Throws:

KrbException - e

exportKeytab

void exportKeytab(File keytabFile,
                List<String> principals)
                  throws KrbException

Export all the keys of the specified principals into the specified keytab file.

Parameters:

keytabFile - The keytab file

principals - The principal names

Throws:

KrbException - e

exportKeytab

void exportKeytab(File keytabFile)
                  throws KrbException

Export all identity keys to the specified keytab file.

Parameters:

keytabFile - The keytab file

Throws:

KrbException - e

removeKeytabEntriesOf

void removeKeytabEntriesOf(File keytabFile,
                         String principal)
                           throws KrbException

Remove all the keys of the specified principal in the specified keytab file.

Parameters:

keytabFile - The keytab file

principal - The principal name

Throws:

KrbException - e

removeKeytabEntriesOf

void removeKeytabEntriesOf(File keytabFile,
                         String principal,
                         int kvno)
                           throws KrbException

Remove all the keys of the specified principal with specified kvno in the specified keytab file.

Parameters:

keytabFile - The keytab file

principal - The principal name

kvno - The kvno

Throws:

KrbException - e

removeOldKeytabEntriesOf

void removeOldKeytabEntriesOf(File keytabFile,
                            String principal)
                              throws KrbException

Remove all the old keys of the specified principal in the specified keytab file.

Parameters:

keytabFile - The keytab file

principal - The principal name

Throws:

KrbException - e

deletePrincipal

void deletePrincipal(String principal)
                     throws KrbException

Delete the principal in backend.

Parameters:

principal - The principal to be deleted from backend

Throws:

KrbException - e

modifyPrincipal

void modifyPrincipal(String principal,
                   org.apache.kerby.KOptions kOptions)
                     throws KrbException

Modify the principal with KOptions.

Parameters:

principal - The principal to be modified

kOptions - The KOptions with changed principal info

Throws:

KrbException - e

renamePrincipal

void renamePrincipal(String oldPrincipalName,
                   String newPrincipalName)
                     throws KrbException

Rename the principal.

Parameters:

oldPrincipalName - The original principal name

newPrincipalName - The new principal name

Throws:

KrbException - e

getPrincipals

List<String> getPrincipals()
                           throws KrbException

Get all the principal names from backend.

Returns:

principal list

Throws:

KrbException - e

getPrincipals

List<String> getPrincipals(String globString)
                           throws KrbException

Get all the principal names that meets the pattern

Parameters:

globString - The glob string for matching

Returns:

Principal names

Throws:

KrbException - e

changePassword

void changePassword(String principal,
                  String newPassword)
                    throws KrbException

Change the password of specified principal.

Parameters:

principal - The principal to be updated password

newPassword - The new password

Throws:

KrbException - e

updateKeys

void updateKeys(String principal)
                throws KrbException

Update the random keys of specified principal.

Parameters:

principal - The principal to be updated keys

Throws:

KrbException - e

release

void release()
             throws KrbException

Release any resources associated.

Throws:

KrbException - e