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

Class AdminClient

java.lang.Object

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

public class AdminClient
extends Object

A Admin client API for applications to interact with Admin Server

Constructor Summary

Constructors

Constructor and Description
AdminClient() Default constructor.
AdminClient(AdminClient krbClient) Constructor with prepared AdminClient.
AdminClient(AdminConfig adminConfig) Construct with prepared AdminConfig.
AdminClient(File confDir) Constructor with conf dir

Method Summary

Methods

Modifier and Type	Method and Description
AdminConfig	getAdminConfig()
AdminSetting	getSetting() Get krb client settings from options and configs.
void	init() Init the client.
void	requestAddPrincipal(String principal)
void	requestAddPrincipal(String principal, String password)
void	requestDeletePrincipal(String principal)
List<String>	requestGetprincs()
List<String>	requestGetprincsWithExp(String exp)
void	requestRenamePrincipal(String oldPrincipal, String newPrincipal)
void	setAdminRealm(String realm) Set KDC realm for ticket request
void	setAdminTcpPort(int kdcTcpPort) Set Admin Server tcp port.
void	setAdminUdpPort(int adminUdpPort) Set Admin Server udp port.
void	setAllowTcp(boolean allowTcp) Set to allow TCP or not.
void	setAllowUdp(boolean allowUdp) Set to allow UDP or not.
void	setKdcHost(String kdcHost) Set Admin Server host.
void	setKeyTabFile(File file)
void	setTimeout(int timeout) Set time out for connection

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminClient

public AdminClient()
            throws KrbException

Default constructor.

Throws:

KrbException - e

AdminClient

public AdminClient(AdminConfig adminConfig)

Construct with prepared AdminConfig.

Parameters:

adminConfig - The krb config

AdminClient

public AdminClient(File confDir)
            throws KrbException

Constructor with conf dir

Parameters:

confDir - The conf dir

Throws:

KrbException - e

AdminClient

public AdminClient(AdminClient krbClient)

Constructor with prepared AdminClient.

Parameters:

krbClient - The krb client

Method Detail

setAdminRealm

public void setAdminRealm(String realm)

Set KDC realm for ticket request

Parameters:

realm - The realm

setKeyTabFile

public void setKeyTabFile(File file)

setKdcHost

public void setKdcHost(String kdcHost)

Set Admin Server host.

Parameters:

kdcHost - The kdc host

setAdminTcpPort

public void setAdminTcpPort(int kdcTcpPort)

Set Admin Server tcp port.

Parameters:

kdcTcpPort - The kdc tcp port

setAllowUdp

public void setAllowUdp(boolean allowUdp)

Set to allow UDP or not.

Parameters:

allowUdp - true if allow udp

setAllowTcp

public void setAllowTcp(boolean allowTcp)

Set to allow TCP or not.

Parameters:

allowTcp - true if allow tcp

setAdminUdpPort

public void setAdminUdpPort(int adminUdpPort)

Set Admin Server udp port. Only makes sense when allowUdp is set.

Parameters:

adminUdpPort - The kdc udp port

setTimeout

public void setTimeout(int timeout)

Set time out for connection

Parameters:

timeout - in seconds

init

public void init()
          throws KrbException

Init the client.

Throws:

KrbException - e

getSetting

public AdminSetting getSetting()

Get krb client settings from options and configs.

Returns:

setting

getAdminConfig

public AdminConfig getAdminConfig()

requestAddPrincipal

public void requestAddPrincipal(String principal)
                         throws KrbException

Throws:

KrbException

requestAddPrincipal

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

Throws:

KrbException

requestDeletePrincipal

public void requestDeletePrincipal(String principal)
                            throws KrbException

Throws:

KrbException

requestRenamePrincipal

public void requestRenamePrincipal(String oldPrincipal,
                          String newPrincipal)
                            throws KrbException

Throws:

KrbException

requestGetprincs

public List<String> requestGetprincs()
                              throws KrbException

Throws:

KrbException

requestGetprincsWithExp

public List<String> requestGetprincsWithExp(String exp)
                                     throws KrbException

Throws:

KrbException