alluxio.security.authentication

Class PlainSaslTransportProvider

java.lang.Object

alluxio.security.authentication.PlainSaslTransportProvider

All Implemented Interfaces:

TransportProvider

@ThreadSafe
public final class PlainSaslTransportProvider
extends Object
implements TransportProvider

If authentication type is AuthType.SIMPLE or AuthType.CUSTOM, this is the default transport provider which uses SASL transport.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.security.authentication.TransportProvider

TransportProvider.Factory

Constructor Summary

Constructors

Constructor and Description
PlainSaslTransportProvider() Constructor for transport provider with AuthType.SIMPLE or AuthType.CUSTOM.

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(String username, String password, String impersonationUser, InetSocketAddress serverAddress) Gets a PLAIN mechanism transport for client side.
org.apache.thrift.transport.TTransport	getClientTransport(Subject subject, InetSocketAddress serverAddress) Similar as TransportProvider.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlainSaslTransportProvider

public PlainSaslTransportProvider()

Constructor for transport provider with AuthType.SIMPLE or AuthType.CUSTOM.

Method Detail

getClientTransport

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

Description copied from interface: TransportProvider

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.

Specified by:

getClientTransport in interface TransportProvider

Parameters:

serverAddress - the server address which clients will connect to

Returns:

a TTransport for client

Throws:

UnauthenticatedException

getClientTransport

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

Description copied from interface: TransportProvider

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

Specified by:

getClientTransport in interface TransportProvider

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

getClientTransport

public org.apache.thrift.transport.TTransport getClientTransport(String username,
                                                                 String password,
                                                                 String impersonationUser,
                                                                 InetSocketAddress serverAddress)
                                                          throws UnauthenticatedException

Gets a PLAIN mechanism transport for client side.

Parameters:

username - User Name of PlainClient

password - Password of PlainClient

impersonationUser - impersonation user (not used if null)

serverAddress - address of the server

Returns:

Wrapped transport with PLAIN mechanism

Throws:

UnauthenticatedException

getServerTransportFactory

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

Description copied from interface: TransportProvider

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.

Specified by:

getServerTransportFactory in interface TransportProvider

Parameters:

serverName - the name for this server

Returns:

a corresponding TTransportFactory

Throws:

SaslException - if building a TransportFactory fails

getServerTransportFactory

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

Description copied from interface: TransportProvider

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.

Specified by:

getServerTransportFactory in interface TransportProvider

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