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

Class AdminServer

java.lang.Object

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

public class AdminServer
extends Object

The implemented Kerberos remote admin server API. We add the KdcConfig as a member variable to AdminServer, In order to make it easy to use LocalKadminImpl. The Kdc Config of corresponding KDC can be read from ConfDir.

Constructor Summary

Constructors

Constructor and Description
AdminServer() Default constructor.
AdminServer(AdminServerConfig adminServerConfig, BackendConfig backendConfig, KdcConfig kdcConfig) Constructor passing adminServerConfig, kdcConfig and backendConfig.
AdminServer(File confDir) Constructor given confDir where 'adminServer.conf', 'kdc.conf' and 'backend.conf' should be available.

Method Summary

Modifier and Type	Method and Description
void	enableDebug() Allow to debug so have more logs.
AdminServerConfig	getAdminServerConfig() Get the Admin config.
AdminServerSetting	getAdminServerSetting() Get Admin setting from startup options and configs.
BackendConfig	getBackendConfig() Get backend config.
IdentityBackend	getIdentityService() Get identity service.
void	init() Initialize.
void	setAdminHost(String adminHost) Set Admin host.
void	setAdminServerPort(int adminPort) Set Admin port.
void	setAdminServerRealm(String realm) Set Admin realm for ticket request
void	setAdminTcpPort(int adminTcpPort) Set Admin tcp port.
void	setAdminUdpPort(int adminUdpPort) Set Admin udp port.
void	setAllowTcp(boolean allowTcp) Set to allow TCP or not.
void	setAllowUdp(boolean allowUdp) Set to allow UDP or not.
void	setInnerAdminServerImpl(InternalAdminServer innerAdminServerImpl) Allow to hook customized admin implementation.
void	setWorkDir(File workDir) Set runtime folder.
void	start() Start the Admin admin.
void	stop() Stop the Admin admin.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminServer

public AdminServer(AdminServerConfig adminServerConfig,
                   BackendConfig backendConfig,
                   KdcConfig kdcConfig)
            throws KrbException

Constructor passing adminServerConfig, kdcConfig and backendConfig.

Parameters:

adminServerConfig - The admin server config

backendConfig - The backend config

kdcConfig - The kdc config

Throws:

KrbException - e

AdminServer

public AdminServer(File confDir)
            throws KrbException

Constructor given confDir where 'adminServer.conf', 'kdc.conf' and 'backend.conf' should be available. adminServer.conf that contains adminServer related items. kdc.conf, that contains kdc related items. backend.conf, that contains identity backend related items.

Parameters:

confDir - The conf dir

Throws:

KrbException - e

AdminServer

public AdminServer()

Default constructor.

Method Detail

setAdminServerRealm

public void setAdminServerRealm(String realm)

Set Admin realm for ticket request

Parameters:

realm - The kdc realm

setAdminHost

public void setAdminHost(String adminHost)

Set Admin host.

Parameters:

adminHost - The kdc host

setAdminServerPort

public void setAdminServerPort(int adminPort)

Set Admin port.

Parameters:

adminPort - The admin port

setAdminTcpPort

public void setAdminTcpPort(int adminTcpPort)

Set Admin tcp port.

Parameters:

adminTcpPort - The admin 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 udp port. Only makes sense when allowUdp is set.

Parameters:

adminUdpPort - The admin udp port

setWorkDir

public void setWorkDir(File workDir)

Set runtime folder.

Parameters:

workDir - The work dir

enableDebug

public void enableDebug()

Allow to debug so have more logs.

setInnerAdminServerImpl

public void setInnerAdminServerImpl(InternalAdminServer innerAdminServerImpl)

Allow to hook customized admin implementation.

Parameters:

innerAdminServerImpl - The inner admin implementation

getAdminServerSetting

public AdminServerSetting getAdminServerSetting()

Get Admin setting from startup options and configs.

Returns:

setting

getAdminServerConfig

public AdminServerConfig getAdminServerConfig()

Get the Admin config.

Returns:

AdminServerConfig

getBackendConfig

public BackendConfig getBackendConfig()

Get backend config.

Returns:

backend configuration

getIdentityService

public IdentityBackend getIdentityService()

Get identity service.

Returns:

IdentityService

init

public void init()
          throws KrbException

Initialize.

Throws:

KrbException - e.

start

public void start()
           throws KrbException

Start the Admin admin.

Throws:

KrbException - e.

stop

public void stop()
          throws KrbException

Stop the Admin admin.

Throws:

KrbException - e.