MiniKdc (Apache Hadoop MiniKDC 3.4.1.200-dep-1000 API)

java.lang.Object
- org.apache.hadoop.minikdc.MiniKdc

```
public class MiniKdc
extends java.lang.Object
```
Mini KDC based on Apache Directory Server that can be embedded in testcases or used from command line as a standalone KDC.
From within testcases:
MiniKdc sets one System property when started and un-set when stopped:
- sun.security.krb5.debug: set to the debug value provided in the configuration
Because of this, multiple MiniKdc instances cannot be started in parallel. For example, running testcases in parallel that start a KDC each. To accomplish this a single MiniKdc should be used for all testcases running in parallel.
MiniKdc default configuration values are:
- org.name=EXAMPLE (used to create the REALM)
- org.domain=COM (used to create the REALM)
- kdc.bind.address=localhost
- kdc.port=0 (ephemeral port)
- instance=DefaultKrbServer
- max.ticket.lifetime=86400000 (1 day)
- max.renewable.lifetime=604800000 (7 days)
- transport=TCP
- debug=false
The generated krb5.conf forces TCP connections.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`DEBUG`
`static java.lang.String`	`INSTANCE`
`static java.lang.String`	`JAVA_SECURITY_KRB5_CONF`
`static java.lang.String`	`KDC_BIND_ADDRESS`
`static java.lang.String`	`KDC_PORT`
`static java.lang.String`	`MAX_RENEWABLE_LIFETIME`
`static java.lang.String`	`MAX_TICKET_LIFETIME`
`static java.lang.String`	`MIN_TICKET_LIFETIME`
`static java.lang.String`	`ORG_DOMAIN`
`static java.lang.String`	`ORG_NAME`
`static java.lang.String`	`SUN_SECURITY_KRB5_DEBUG`
`static java.lang.String`	`TRANSPORT`

Constructor Summary

Constructors
Constructor Description

MiniKdc(java.util.Properties conf, java.io.File workDir)
Creates a MiniKdc.

Constructors
Constructor	Description
`MiniKdc(java.util.Properties conf, java.io.File workDir)`	Creates a MiniKdc.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static java.util.Properties`	`createConf()`	Convenience method that returns MiniKdc default configuration.
`void`	`createPrincipal(java.io.File keytabFile, java.lang.String... principals)`	Creates multiple principals in the KDC and adds them to a keytab file.
`void`	`createPrincipal(java.lang.String principal, java.lang.String password)`	Creates a principal in the KDC with the specified user and password.
`java.lang.String`	`getHost()`	Returns the host of the MiniKdc.
`java.io.File`	`getKrb5conf()`
`int`	`getPort()`	Returns the port of the MiniKdc.
`java.lang.String`	`getRealm()`	Returns the realm of the MiniKdc.
`static void`	`main(java.lang.String[] args)`
`void`	`setTransport(java.lang.String transport)`
`void`	`start()`	Starts the MiniKdc.
`void`	`stop()`	Stops the MiniKdc

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JAVA_SECURITY_KRB5_CONF
```
public static final java.lang.String JAVA_SECURITY_KRB5_CONF
```
    See Also:
    
    Constant Field Values
  - SUN_SECURITY_KRB5_DEBUG
```
public static final java.lang.String SUN_SECURITY_KRB5_DEBUG
```
    See Also:
    
    Constant Field Values
  - ORG_NAME
```
public static final java.lang.String ORG_NAME
```
    See Also:
    
    Constant Field Values
  - ORG_DOMAIN
```
public static final java.lang.String ORG_DOMAIN
```
    See Also:
    
    Constant Field Values
  - KDC_BIND_ADDRESS
```
public static final java.lang.String KDC_BIND_ADDRESS
```
    See Also:
    
    Constant Field Values
  - KDC_PORT
```
public static final java.lang.String KDC_PORT
```
    See Also:
    
    Constant Field Values
  - INSTANCE
```
public static final java.lang.String INSTANCE
```
    See Also:
    
    Constant Field Values
  - MAX_TICKET_LIFETIME
```
public static final java.lang.String MAX_TICKET_LIFETIME
```
    See Also:
    
    Constant Field Values
  - MIN_TICKET_LIFETIME
```
public static final java.lang.String MIN_TICKET_LIFETIME
```
    See Also:
    
    Constant Field Values
  - MAX_RENEWABLE_LIFETIME
```
public static final java.lang.String MAX_RENEWABLE_LIFETIME
```
    See Also:
    
    Constant Field Values
  - TRANSPORT
```
public static final java.lang.String TRANSPORT
```
    See Also:
    
    Constant Field Values
  - DEBUG
```
public static final java.lang.String DEBUG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MiniKdc
```
public MiniKdc(java.util.Properties conf,
               java.io.File workDir)
        throws java.lang.Exception
```
    Creates a MiniKdc.
    
    Parameters:
    
    conf - MiniKdc configuration.
    
    workDir - working directory, it should be the build directory. Under this directory an ApacheDS working directory will be created, this directory will be deleted when the MiniKdc stops.
    
    Throws:
    
    java.lang.Exception - thrown if the MiniKdc could not be created.
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - createConf
```
public static java.util.Properties createConf()
```
    Convenience method that returns MiniKdc default configuration.
    The returned configuration is a copy, it can be customized before using it to create a MiniKdc.
    
    Returns:
    
    a MiniKdc default configuration.
  - setTransport
```
public void setTransport(java.lang.String transport)
```
  - getPort
```
public int getPort()
```
    Returns the port of the MiniKdc.
    
    Returns:
    
    the port of the MiniKdc.
  - getHost
```
public java.lang.String getHost()
```
    Returns the host of the MiniKdc.
    
    Returns:
    
    the host of the MiniKdc.
  - getRealm
```
public java.lang.String getRealm()
```
    Returns the realm of the MiniKdc.
    
    Returns:
    
    the realm of the MiniKdc.
  - getKrb5conf
```
public java.io.File getKrb5conf()
```
  - start
```
public void start()
           throws java.lang.Exception
```
    Starts the MiniKdc.
    
    Throws:
    
    java.lang.Exception - thrown if the MiniKdc could not be started.
  - stop
```
public void stop()
```
    Stops the MiniKdc
  - createPrincipal
```
public void createPrincipal(java.lang.String principal,
                            java.lang.String password)
                     throws java.lang.Exception
```
    Creates a principal in the KDC with the specified user and password.
    
    Parameters:
    
    principal - principal name, do not include the domain.
    
    password - password.
    
    Throws:
    
    java.lang.Exception - thrown if the principal could not be created.
  - createPrincipal
```
public void createPrincipal(java.io.File keytabFile,
                            java.lang.String... principals)
                     throws java.lang.Exception
```
    Creates multiple principals in the KDC and adds them to a keytab file.
    
    Parameters:
    
    keytabFile - keytab file to add the created principals.
    
    principals - principals to add to the KDC, do not include the domain.
    
    Throws:
    
    java.lang.Exception - thrown if the principals or the keytab file could not be created.

Class MiniKdc

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAVA_SECURITY_KRB5_CONF

SUN_SECURITY_KRB5_DEBUG

ORG_NAME

ORG_DOMAIN

KDC_BIND_ADDRESS

KDC_PORT

INSTANCE

MAX_TICKET_LIFETIME

MIN_TICKET_LIFETIME

MAX_RENEWABLE_LIFETIME

TRANSPORT

DEBUG

Constructor Detail

MiniKdc

Method Detail

main

createConf

setTransport

getPort

getHost

getRealm

getKrb5conf

start

stop

createPrincipal

createPrincipal