alluxio.security.authentication

Interface TransportProvider

All Known Implementing Classes:

NoSaslTransportProvider, PlainSaslTransportProvider

public interface TransportProvider

Interface to provide thrift transport service for thrift client and server, based on the type of authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TransportProvider.Factory Factory for TransportProvider.

Method Summary

Modifier and Type	Method and Description
org.apache.thrift.transport.TTransport	getClientTransport(InetSocketAddress serverAddress) Creates a transport per the connection options.
org.apache.thrift.transport.TTransport	getClientTransport(Subject subject, InetSocketAddress serverAddress) Similar as getClientTransport(InetSocketAddress) but it also specifies the Subject explicitly.
org.apache.thrift.transport.TTransportFactory	getServerTransportFactory(Runnable runnable, String serverName) For server side, this method returns a TTransportFactory based on the auth type.
org.apache.thrift.transport.TTransportFactory	getServerTransportFactory(String serverName) For server side, this method returns a TTransportFactory based on the auth type.

Method Detail

getClientTransport

org.apache.thrift.transport.TTransport getClientTransport(InetSocketAddress serverAddress)
                                                   throws UnauthenticatedException

Creates a transport per the connection options. Supported transport options are: AuthType.NOSASL, AuthType.SIMPLE, {link@ AuthType#CUSTOM}, AuthType.KERBEROS. With NOSASL as input, an unmodified TTransport is returned; with SIMPLE/CUSTOM as input, a PlainClientTransport is returned; KERBEROS is not supported currently. If the auth type is not supported or recognized, an UnsupportedOperationException is thrown.

Parameters:

serverAddress - the server address which clients will connect to

Returns:

a TTransport for client

Throws:

UnauthenticatedException

getClientTransport

org.apache.thrift.transport.TTransport getClientTransport(Subject subject,
                                                          InetSocketAddress serverAddress)
                                                   throws UnauthenticatedException

Similar as getClientTransport(InetSocketAddress) but it also specifies the Subject explicitly.

Parameters:

subject - the subject, set to null if not present

serverAddress - the server address which clients will connect to

Returns:

a TTransport for client

Throws:

UnauthenticatedException

getServerTransportFactory

org.apache.thrift.transport.TTransportFactory getServerTransportFactory(String serverName)
                                                                 throws SaslException

For server side, this method returns a TTransportFactory based on the auth type. It is used as one argument to build a Thrift TServer. If the auth type is not supported or recognized, an UnsupportedOperationException is thrown.

Parameters:

serverName - the name for this server

Returns:

a corresponding TTransportFactory

Throws:

SaslException - if building a TransportFactory fails

getServerTransportFactory

org.apache.thrift.transport.TTransportFactory getServerTransportFactory(Runnable runnable,
                                                                        String serverName)
                                                                 throws SaslException

For server side, this method returns a TTransportFactory based on the auth type. It is used as one argument to build a Thrift TServer. If the auth type is not supported or recognized, an UnsupportedOperationException is thrown.

Parameters:

runnable - a closure to run after the transport is established

serverName - the name for this server

Returns:

a corresponding TTransportFactory

Throws:

SaslException - if building a TransportFactory fails