org.apache.calcite.avatica.server

Interface AvaticaServerConfiguration

public interface AvaticaServerConfiguration

A generic configuration interface that users can implement to configure the HttpServer.

Method Summary

Modifier and Type	Method and Description
<T> T	doAsRemoteUser(String remoteUserName, String remoteAddress, Callable<T> action) Invokes the given action as the remoteUserName.
String[]	getAllowedRoles() Returns the array of allowed roles for login.
AuthenticationType	getAuthenticationType() Returns the type of authentication the HttpServer should use.
String	getHashLoginServiceProperties() Returns the path to a properties file that contains users and realms.
String	getHashLoginServiceRealm() Returns the name of the realm to use in coordination with the properties files specified by getHashLoginServiceProperties().
String	getKerberosHostName() Returns the "instance" component of the Kerberos principal for the Avatica server, e.g.
default File	getKerberosKeytab() Returns the file to the server's Kerberos keytab.
String	getKerberosPrincipal() Returns the Kerberos principal that the Avatica server should log in as.
String	getKerberosRealm() Returns the Kerberos realm to use for the server's login.
String	getKerberosServiceName() Returns the "primary" component of the Kerberos principal for the Avatica server, e.g.
RemoteUserExtractor	getRemoteUserExtractor() Extract the user this request should execute as.
boolean	supportsImpersonation() Returns true if the Avatica server should run user requests at that remote user.

Method Detail

getAuthenticationType

AuthenticationType getAuthenticationType()

Returns the type of authentication the HttpServer should use.

Returns:

An enum corresponding to an authentication mechanism

getKerberosRealm

String getKerberosRealm()

Returns the Kerberos realm to use for the server's login. Only relevant when getAuthenticationType() returns AuthenticationType.SPNEGO.

Returns:

The Kerberos realm for the server login, or null if not applicable.

getKerberosServiceName

String getKerberosServiceName()

Returns the "primary" component of the Kerberos principal for the Avatica server, e.g. primary/instance@REALM

getKerberosHostName

String getKerberosHostName()

Returns the "instance" component of the Kerberos principal for the Avatica server, e.g. primary/instance@REALM

getKerberosPrincipal

String getKerberosPrincipal()

Returns the Kerberos principal that the Avatica server should log in as.

Returns:

A Kerberos principal, or null if not applicable.

getKerberosKeytab

default File getKerberosKeytab()

Returns the file to the server's Kerberos keytab.

getAllowedRoles

String[] getAllowedRoles()

Returns the array of allowed roles for login. Only applicable when getAuthenticationType() returns AuthenticationType.BASIC or AuthenticationType.DIGEST.

Returns:

An array of allowed login roles, or null.

getHashLoginServiceRealm

String getHashLoginServiceRealm()

Returns the name of the realm to use in coordination with the properties files specified by getHashLoginServiceProperties(). Only applicable when getAuthenticationType() returns AuthenticationType.BASIC or AuthenticationType.DIGEST.

Returns:

A realm for the HashLoginService, or null.

getHashLoginServiceProperties

String getHashLoginServiceProperties()

Returns the path to a properties file that contains users and realms. Only applicable when getAuthenticationType() returns AuthenticationType.BASIC or AuthenticationType.DIGEST.

Returns:

A realm for the HashLoginService, or null.

supportsImpersonation

boolean supportsImpersonation()

Returns true if the Avatica server should run user requests at that remote user. Otherwise, all requests are run as the Avatica server user (which is the default).

Returns:

True if impersonation is enabled, false otherwise.

doAsRemoteUser

<T> T doAsRemoteUser(String remoteUserName,
                     String remoteAddress,
                     Callable<T> action)
              throws Exception

Invokes the given action as the remoteUserName. This will only be invoked if supportsImpersonation() returns true.

Parameters:

remoteUserName - The remote user making a request to the Avatica server.

remoteAddress - The address the remote user is making the request from.

Returns:

The result from the Callable.

Throws:

Exception

See Also:

to deny a remoteUser access

getRemoteUserExtractor

RemoteUserExtractor getRemoteUserExtractor()

Extract the user this request should execute as.

Returns:

Name of the RemoteUserExtractor