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

Class LocalKadminImpl

java.lang.Object

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

All Implemented Interfaces:

Kadmin, LocalKadmin

public class LocalKadminImpl
extends Object
implements LocalKadmin

The implementation of admin side admin facilities for local mode.

Constructor Summary

Constructors

Constructor and Description
LocalKadminImpl(File confDir) Construct with prepared conf dir.
LocalKadminImpl(KdcConfig kdcConfig, org.apache.kerby.kerberos.kerb.identity.backend.BackendConfig backendConfig) Construct with prepared AdminServerConfig and BackendConfig.
LocalKadminImpl(KdcSetting kdcSetting, org.apache.kerby.kerberos.kerb.identity.backend.IdentityBackend backend) Construct with prepared AdminServerSetting and Backend.
LocalKadminImpl(ServerSetting serverSetting)

Method Summary

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	checkBuiltinPrincipals() Check the built-in principals, will throw KrbException if not exist.
void	createBuiltinPrincipals() Create build-in principals.
void	deleteBuiltinPrincipals() Delete build-in principals.
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.
org.apache.kerby.kerberos.kerb.identity.backend.BackendConfig	getBackendConfig() Get backend config.
org.apache.kerby.kerberos.kerb.identity.backend.IdentityBackend	getIdentityBackend() Get identity backend.
String	getKadminPrincipal() Get the kadmin principal name.
KdcConfig	getKdcConfig() Get kdc config.
org.apache.kerby.kerberos.kerb.request.KrbIdentity	getPrincipal(String principalName) Get the identity from backend.
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.
int	size() get size of principal
void	updateKeys(String principal) Update the random keys of specified principal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalKadminImpl

public LocalKadminImpl(KdcConfig kdcConfig,
                       org.apache.kerby.kerberos.kerb.identity.backend.BackendConfig backendConfig)
                throws KrbException

Construct with prepared AdminServerConfig and BackendConfig.

Parameters:

kdcConfig - The kdc config

backendConfig - The backend config

Throws:

KrbException - e

LocalKadminImpl

public LocalKadminImpl(ServerSetting serverSetting)
                throws KrbException

Throws:

KrbException

LocalKadminImpl

public LocalKadminImpl(File confDir)
                throws KrbException

Construct with prepared conf dir.

Parameters:

confDir - The path of conf dir

Throws:

KrbException - e

LocalKadminImpl

public LocalKadminImpl(KdcSetting kdcSetting,
                       org.apache.kerby.kerberos.kerb.identity.backend.IdentityBackend backend)

Construct with prepared AdminServerSetting and Backend.

Parameters:

kdcSetting - The kdc setting

backend - The identity backend

Method Detail

getKadminPrincipal

public String getKadminPrincipal()

Description copied from interface: Kadmin

Get the kadmin principal name.

Specified by:

getKadminPrincipal in interface Kadmin

Returns:

The kadmin principal name.

checkBuiltinPrincipals

public void checkBuiltinPrincipals()
                            throws KrbException

Description copied from interface: LocalKadmin

Check the built-in principals, will throw KrbException if not exist.

Specified by:

checkBuiltinPrincipals in interface LocalKadmin

Throws:

KrbException - e

createBuiltinPrincipals

public void createBuiltinPrincipals()
                             throws KrbException

Description copied from interface: LocalKadmin

Create build-in principals.

Specified by:

createBuiltinPrincipals in interface LocalKadmin

Throws:

KrbException - e

deleteBuiltinPrincipals

public void deleteBuiltinPrincipals()
                             throws KrbException

Description copied from interface: LocalKadmin

Delete build-in principals.

Specified by:

deleteBuiltinPrincipals in interface LocalKadmin

Throws:

KrbException - e

getKdcConfig

public KdcConfig getKdcConfig()

Description copied from interface: LocalKadmin

Get kdc config.

Specified by:

getKdcConfig in interface LocalKadmin

Returns:

The kdc config.

getBackendConfig

public org.apache.kerby.kerberos.kerb.identity.backend.BackendConfig getBackendConfig()

Description copied from interface: LocalKadmin

Get backend config.

Specified by:

getBackendConfig in interface LocalKadmin

Returns:

The backend config.

getIdentityBackend

public org.apache.kerby.kerberos.kerb.identity.backend.IdentityBackend getIdentityBackend()

Description copied from interface: LocalKadmin

Get identity backend.

Specified by:

getIdentityBackend in interface LocalKadmin

Returns:

IdentityBackend

addPrincipal

public void addPrincipal(String principal)
                  throws KrbException

Description copied from interface: Kadmin

Add principal to backend.

Specified by:

addPrincipal in interface Kadmin

Parameters:

principal - The principal to be added into backend

Throws:

KrbException - e

addPrincipal

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

Description copied from interface: Kadmin

Add principal to backend.

Specified by:

addPrincipal in interface Kadmin

Parameters:

principal - The principal to be added into backend

kOptions - The KOptions with principal info

Throws:

KrbException - e

addPrincipal

public void addPrincipal(String principal,
                         String password)
                  throws KrbException

Description copied from interface: Kadmin

Add principal to backend.

Specified by:

addPrincipal in interface Kadmin

Parameters:

principal - The principal to be added into backend

password - The password to create encryption key

Throws:

KrbException - e

addPrincipal

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

Description copied from interface: Kadmin

Add principal to backend.

Specified by:

addPrincipal in interface Kadmin

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

public void exportKeytab(File keytabFile,
                         String principal)
                  throws KrbException

Description copied from interface: Kadmin

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

Specified by:

exportKeytab in interface Kadmin

Parameters:

keytabFile - The keytab file

principal - The principal name

Throws:

KrbException - e

exportKeytab

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

Description copied from interface: Kadmin

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

Specified by:

exportKeytab in interface Kadmin

Parameters:

keytabFile - The keytab file

principals - The principal names

Throws:

KrbException - e

exportKeytab

public void exportKeytab(File keytabFile)
                  throws KrbException

Description copied from interface: Kadmin

Export all identity keys to the specified keytab file.

Specified by:

exportKeytab in interface Kadmin

Parameters:

keytabFile - The keytab file

Throws:

KrbException - e

removeKeytabEntriesOf

public void removeKeytabEntriesOf(File keytabFile,
                                  String principal)
                           throws KrbException

Description copied from interface: Kadmin

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

Specified by:

removeKeytabEntriesOf in interface Kadmin

Parameters:

keytabFile - The keytab file

principal - The principal name

Throws:

KrbException - e

removeKeytabEntriesOf

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

Description copied from interface: Kadmin

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

Specified by:

removeKeytabEntriesOf in interface Kadmin

Parameters:

keytabFile - The keytab file

principal - The principal name

kvno - The kvno

Throws:

KrbException - e

removeOldKeytabEntriesOf

public void removeOldKeytabEntriesOf(File keytabFile,
                                     String principal)
                              throws KrbException

Description copied from interface: Kadmin

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

Specified by:

removeOldKeytabEntriesOf in interface Kadmin

Parameters:

keytabFile - The keytab file

principal - The principal name

Throws:

KrbException - e

deletePrincipal

public void deletePrincipal(String principal)
                     throws KrbException

Description copied from interface: Kadmin

Delete the principal in backend.

Specified by:

deletePrincipal in interface Kadmin

Parameters:

principal - The principal to be deleted from backend

Throws:

KrbException - e

modifyPrincipal

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

Description copied from interface: Kadmin

Modify the principal with KOptions.

Specified by:

modifyPrincipal in interface Kadmin

Parameters:

principal - The principal to be modified

kOptions - The KOptions with changed principal info

Throws:

KrbException - e

renamePrincipal

public void renamePrincipal(String oldPrincipalName,
                            String newPrincipalName)
                     throws KrbException

Description copied from interface: Kadmin

Rename the principal.

Specified by:

renamePrincipal in interface Kadmin

Parameters:

oldPrincipalName - The original principal name

newPrincipalName - The new principal name

Throws:

KrbException - e

getPrincipal

public org.apache.kerby.kerberos.kerb.request.KrbIdentity getPrincipal(String principalName)
                                                                throws KrbException

Description copied from interface: LocalKadmin

Get the identity from backend.

Specified by:

getPrincipal in interface LocalKadmin

Parameters:

principalName - The principal name

Returns:

identity

Throws:

KrbException - e

getPrincipals

public List<String> getPrincipals()
                           throws KrbException

Description copied from interface: Kadmin

Get all the principal names from backend.

Specified by:

getPrincipals in interface Kadmin

Returns:

principal list

Throws:

KrbException - e

getPrincipals

public List<String> getPrincipals(String globString)
                           throws KrbException

Description copied from interface: Kadmin

Get all the principal names that meets the pattern

Specified by:

getPrincipals in interface Kadmin

Parameters:

globString - The glob string for matching

Returns:

Principal names

Throws:

KrbException - e

changePassword

public void changePassword(String principal,
                           String newPassword)
                    throws KrbException

Description copied from interface: Kadmin

Change the password of specified principal.

Specified by:

changePassword in interface Kadmin

Parameters:

principal - The principal to be updated password

newPassword - The new password

Throws:

KrbException - e

updateKeys

public void updateKeys(String principal)
                throws KrbException

Description copied from interface: Kadmin

Update the random keys of specified principal.

Specified by:

updateKeys in interface Kadmin

Parameters:

principal - The principal to be updated keys

Throws:

KrbException - e

release

public void release()
             throws KrbException

Description copied from interface: Kadmin

Release any resources associated.

Specified by:

release in interface Kadmin

Throws:

KrbException - e

size

public int size()
         throws KrbException

get size of principal

Specified by:

size in interface LocalKadmin

Throws:

KrbException