org.apache.knox.gateway.shell

Class KnoxSession

java.lang.Object

org.apache.knox.gateway.shell.KnoxSession

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

Hadoop

public class KnoxSession
extends Object
implements Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEGIN_CERTIFICATE
static String	END_CERTIFICATE
static String	JGSS_LOGIN_MOUDLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KnoxSession()
	KnoxSession(ClientContext clientContext)

Method Summary

Modifier and Type	Method and Description
String	base()
void	close()
protected org.apache.http.impl.client.CloseableHttpClient	createClient(ClientContext clientContext)
protected void	discoverTruststoreDetails(ClientContext clientContext)
<T> Future<T>	executeLater(Callable<T> callable)
org.apache.http.client.methods.CloseableHttpResponse	executeNow(org.apache.http.HttpRequest request)
protected X509Certificate	generateCertificateFromBytes(byte[] certBytes)
Map<String,String>	getHeaders()
static <T> Map<String,T>	getMapFromJsonString(String json)
static Map<String,KnoxDataSource>	getMapOfDataSourcesFromJsonString(String json)
static Map<String,List<String>>	getMapOfStringArrayListsFromJsonString(String json)
static KnoxSession	kerberosLogin(String url) Support kerberos authentication.
static KnoxSession	kerberosLogin(String url, boolean debug) Support kerberos authentication.
static KnoxSession	kerberosLogin(String url, String jaasConf, String krb5Conf, boolean debug) Support kerberos authentication.
static Map<String,KnoxDataSource>	loadDataSources() Load and return a map of datasource names to KnoxDataSource objects from the {user.home}/.knoxshell/knoxdatasources.json file.
static Map<String,String>	loadMountPoints()
static Map<String,List<String>>	loadSQLHistories() Load and return a map of datasource names to sql commands from the {user.home}/.knoxshell/knoxsqlhistories.json file.
static KnoxSession	login(ClientContext context)
static KnoxSession	login(String url, Map<String,String> headers)
static KnoxSession	login(String url, Map<String,String> headers, String truststoreLocation, String truststorePass)
static KnoxSession	login(String url, String username, String password)
static KnoxSession	login(String url, String username, String password, String truststoreLocation, String truststorePass)
static KnoxSession	loginInsecure(String url, String username, String password)
static void	persistDataSources(Map<String,KnoxDataSource> datasources)
static <T> void	persistDataSourcesToKnoxShell(String fileName, Map<String,T> map) Persist provided Map to a file within the {user.home}/.knoxshell directory
static <T> void	persistMapToKnoxShell(String fileName, Map<String,T> map) Persist provided Map to a file within the {user.home}/.knoxshell directory
static void	persistMountPoints(Map<String,String> mounts)
static void	persistSQLHistory(Map<String,List<String>> sqlHistories)
static <T> void	persistToKnoxShell(String fileName, Map<String,List<T>> map) Persist provided Map to a file within the {user.home}/.knoxshell directory
void	setHeaders(Map<String,String> headers)
void	shutdown()
boolean	shutdown(long timeout, TimeUnit unit)
String	toString()
void	waitFor(Future<?>... futures)
void	waitFor(long timeout, TimeUnit units, Future<?>... futures)

Methods inherited from class java.lang.Object

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

Field Detail

JGSS_LOGIN_MOUDLE

public static final String JGSS_LOGIN_MOUDLE

See Also:

Constant Field Values

END_CERTIFICATE

public static final String END_CERTIFICATE

See Also:

Constant Field Values

BEGIN_CERTIFICATE

public static final String BEGIN_CERTIFICATE

See Also:

Constant Field Values

Constructor Detail

KnoxSession

protected KnoxSession()
               throws KnoxShellException,
                      URISyntaxException

Throws:

KnoxShellException

URISyntaxException

KnoxSession

public KnoxSession(ClientContext clientContext)
            throws KnoxShellException,
                   URISyntaxException

Throws:

KnoxShellException

URISyntaxException

Method Detail

getHeaders

public Map<String,String> getHeaders()

setHeaders

public void setHeaders(Map<String,String> headers)

login

public static KnoxSession login(String url,
                                Map<String,String> headers)
                         throws URISyntaxException

Throws:

URISyntaxException

login

public static KnoxSession login(String url,
                                Map<String,String> headers,
                                String truststoreLocation,
                                String truststorePass)
                         throws URISyntaxException

Throws:

URISyntaxException

login

public static KnoxSession login(String url,
                                String username,
                                String password)
                         throws URISyntaxException

Throws:

URISyntaxException

login

public static KnoxSession login(String url,
                                String username,
                                String password,
                                String truststoreLocation,
                                String truststorePass)
                         throws URISyntaxException

Throws:

URISyntaxException

login

public static KnoxSession login(ClientContext context)
                         throws URISyntaxException

Throws:

URISyntaxException

kerberosLogin

public static KnoxSession kerberosLogin(String url,
                                        String jaasConf,
                                        String krb5Conf,
                                        boolean debug)
                                 throws URISyntaxException

Support kerberos authentication.

Parameters:

url - Gateway url

jaasConf - jaas configuration (optional- can be null)

krb5Conf - kerberos configuration (optional - can be null)

debug - enable debug messages

Returns:

KnoxSession

Throws:

URISyntaxException - exception in case of malformed url

Since:

1.3.0

kerberosLogin

public static KnoxSession kerberosLogin(String url)
                                 throws URISyntaxException

Support kerberos authentication. This method assumed kinit has already been called and the token is persisted on disk.

Parameters:

url - Gateway url

Returns:

KnoxSession

Throws:

URISyntaxException - exception in case of malformed url

Since:

1.3.0

kerberosLogin

public static KnoxSession kerberosLogin(String url,
                                        boolean debug)
                                 throws URISyntaxException

Support kerberos authentication. This method assumed kinit has already been called and the token is persisted on disk.

Parameters:

url - Gateway url

debug - enable debug messages

Returns:

KnoxSession

Throws:

URISyntaxException - exception in case of malformed url

Since:

1.3.0

loginInsecure

public static KnoxSession loginInsecure(String url,
                                        String username,
                                        String password)
                                 throws URISyntaxException

Throws:

URISyntaxException

createClient

protected org.apache.http.impl.client.CloseableHttpClient createClient(ClientContext clientContext)
                                                                throws GeneralSecurityException

Throws:

GeneralSecurityException

generateCertificateFromBytes

protected X509Certificate generateCertificateFromBytes(byte[] certBytes)
                                                throws CertificateException

Throws:

CertificateException

discoverTruststoreDetails

protected void discoverTruststoreDetails(ClientContext clientContext)

base

public String base()

executeNow

public org.apache.http.client.methods.CloseableHttpResponse executeNow(org.apache.http.HttpRequest request)
                                                                throws IOException

Throws:

IOException

executeLater

public <T> Future<T> executeLater(Callable<T> callable)

waitFor

public void waitFor(Future<?>... futures)
             throws ExecutionException,
                    InterruptedException

Throws:

ExecutionException

InterruptedException

waitFor

public void waitFor(long timeout,
                    TimeUnit units,
                    Future<?>... futures)
             throws ExecutionException,
                    TimeoutException,
                    InterruptedException

Throws:

ExecutionException

TimeoutException

InterruptedException

shutdown

public void shutdown()
              throws InterruptedException,
                     IOException

Throws:

InterruptedException

IOException

shutdown

public boolean shutdown(long timeout,
                        TimeUnit unit)
                 throws InterruptedException,
                        IOException

Throws:

InterruptedException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

persistToKnoxShell

public static <T> void persistToKnoxShell(String fileName,
                                          Map<String,List<T>> map)

Persist provided Map to a file within the {user.home}/.knoxshell directory

Type Parameters:

T - type of the list

Parameters:

fileName - of persisted file

map - to persist

persistDataSourcesToKnoxShell

public static <T> void persistDataSourcesToKnoxShell(String fileName,
                                                     Map<String,T> map)

Persist provided Map to a file within the {user.home}/.knoxshell directory

Type Parameters:

T - type of the value in the map

Parameters:

fileName - of persisted file

map - to persist

persistMapToKnoxShell

public static <T> void persistMapToKnoxShell(String fileName,
                                             Map<String,T> map)

Persist provided Map to a file within the {user.home}/.knoxshell directory

Type Parameters:

T - type of the value in the map

Parameters:

fileName - of persisted file

map - to persist

persistSQLHistory

public static void persistSQLHistory(Map<String,List<String>> sqlHistories)

persistDataSources

public static void persistDataSources(Map<String,KnoxDataSource> datasources)

persistMountPoints

public static void persistMountPoints(Map<String,String> mounts)

loadSQLHistories

public static Map<String,List<String>> loadSQLHistories()
                                                 throws IOException

Load and return a map of datasource names to sql commands from the {user.home}/.knoxshell/knoxsqlhistories.json file.

Returns:

sqlHistory map

Throws:

IOException - exception when loading sql history

loadMountPoints

public static Map<String,String> loadMountPoints()
                                          throws IOException

Throws:

IOException

loadDataSources

public static Map<String,KnoxDataSource> loadDataSources()
                                                  throws IOException

Load and return a map of datasource names to KnoxDataSource objects from the {user.home}/.knoxshell/knoxdatasources.json file.

Returns:

map of data sources

Throws:

IOException - exception when loading data sources

getMapOfStringArrayListsFromJsonString

public static Map<String,List<String>> getMapOfStringArrayListsFromJsonString(String json)
                                                                       throws IOException

Throws:

IOException

getMapFromJsonString

public static <T> Map<String,T> getMapFromJsonString(String json)
                                              throws IOException

Throws:

IOException

getMapOfDataSourcesFromJsonString

public static Map<String,KnoxDataSource> getMapOfDataSourcesFromJsonString(String json)
                                                                    throws IOException

Throws:

IOException