org.apache.ambari.server

Class KdcServerConnectionVerification

java.lang.Object

org.apache.ambari.server.KdcServerConnectionVerification

public class KdcServerConnectionVerification
extends Object

Utility class which checks connection to Kerberos Server.

It has two potential clients.

• Ambari Agent: Uses it to make sure host can talk to specified KDC Server
• Ambari Server: Uses it for connection check, like agent, and also validates the credentials provided on Server side.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KdcServerConnectionVerification.ConnectionProtocol A connection protocol to use to for connecting to the KDC

Constructor Summary

Constructors

Constructor and Description
KdcServerConnectionVerification(Configuration config)

Method Summary

Modifier and Type	Method and Description
int	getConnectionTimeout() Get the timeout value.
protected org.apache.directory.kerberos.client.KdcConnection	getKdcConnection(org.apache.directory.kerberos.client.KdcConfig config) Get a KDC UDP connection for the given configuration.
boolean	isKdcReachable(String kdcHost) Given server IP or hostname, checks if server is reachable i.e.
boolean	isKdcReachable(String server, int port) Given a host and port, checks if server is reachable meaning that we can communicate with it.
boolean	isKdcReachable(String server, int port, KdcServerConnectionVerification.ConnectionProtocol connectionProtocol) Attempt to communicate with KDC server over a specified communication protocol (TCP or UDP).
protected int	parsePort(String port) Parses port number from given string.
void	setConnectionTimeout(int timeoutSeconds) Set the connection timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

KdcServerConnectionVerification

@Inject
public KdcServerConnectionVerification(Configuration config)

Method Detail

isKdcReachable

public boolean isKdcReachable(String kdcHost)

Given server IP or hostname, checks if server is reachable i.e. we can make a socket connection to it. Hostname may contain port number separated by a colon.

Parameters:

kdcHost - KDC server IP or hostname (with optional port number)

Returns:

true, if server is accepting connection given port; false otherwise.

isKdcReachable

public boolean isKdcReachable(String server,
                              int port)

Given a host and port, checks if server is reachable meaning that we can communicate with it. First we attempt to connect via TCP and if that is unsuccessful, attempt via UDP. It is important to understand that we are not validating credentials, only attempting to communicate with server process for the give host and port.

Parameters:

server - KDC server IP or hostname

port - KDC port

Returns:

true, if server is accepting connection given port; false otherwise.

isKdcReachable

public boolean isKdcReachable(String server,
                              int port,
                              KdcServerConnectionVerification.ConnectionProtocol connectionProtocol)

Attempt to communicate with KDC server over a specified communication protocol (TCP or UDP).

Parameters:

server - KDC hostname or IP address

port - KDC server port

connectionProtocol - the type of connection to use

Returns:

true if communication is successful; false otherwise

getKdcConnection

protected org.apache.directory.kerberos.client.KdcConnection getKdcConnection(org.apache.directory.kerberos.client.KdcConfig config)

Get a KDC UDP connection for the given configuration. This has been extracted into it's own method primarily for unit testing purposes.

Parameters:

config - KDC connection configuration

Returns:

new KDC connection

setConnectionTimeout

public void setConnectionTimeout(int timeoutSeconds)

Set the connection timeout. This is the amount of time that we will attempt to read data from connection.

Parameters:

timeoutSeconds - timeout in seconds

getConnectionTimeout

public int getConnectionTimeout()

Get the timeout value.

Returns:

the connection timeout value in seconds

parsePort

protected int parsePort(String port)

Parses port number from given string.

Parameters:

port - port number string

Returns:

parsed port number

Throws:

NumberFormatException - if given string cannot be parsed

IllegalArgumentException - if given string is null or empty