public class NimbusClient extends ThriftClient
Client used for connecting to nimbus. Typically you want to use a variant of the getConfiguredClient static method to get a client to use, as directly putting in a host and port does not support nimbus high availability.
| Modifier and Type | Class and Description |
|---|---|
static class |
NimbusClient.LocalOverride |
static interface |
NimbusClient.WithNimbus
An interface to allow callbacks with a thrift nimbus client.
|
| Modifier and Type | Field and Description |
|---|---|
boolean |
isLocal
Indicates if this is a special client that is overwritten for local mode.
|
protocol, retryForever| Constructor and Description |
|---|
NimbusClient(Map<String,Object> conf,
String host)
Constructor, Please try to use
getConfiguredClient instead of calling this directly. |
NimbusClient(Map<String,Object> conf,
String host,
int port)
Deprecated.
|
NimbusClient(Map<String,Object> conf,
String host,
Integer port,
Integer timeout,
String asUser)
Constructor, Please try to use
getConfiguredClientAs instead of calling this directly. |
NimbusClient(Map<String,Object> conf,
String host,
int port,
Integer timeout)
Constructor, Please try to use
getConfiguredClient instead of calling this directly. |
| Modifier and Type | Method and Description |
|---|---|
Nimbus.Iface |
getClient()
Get the underlying thrift client.
|
static NimbusClient |
getConfiguredClient(Map<String,Object> conf)
Get a nimbus client as configured by conf.
|
static NimbusClient |
getConfiguredClient(Map<String,Object> conf,
Integer timeout)
Get a nimbus client as configured by conf.
|
static NimbusClient |
getConfiguredClientAs(Map<String,Object> conf,
String asUser)
Get a nimbus client as configured by conf.
|
static NimbusClient |
getConfiguredClientAs(Map<String,Object> conf,
String asUser,
Integer timeout)
Get a nimbus client as configured by conf.
|
static boolean |
isLocalOverride()
Is the local override set or not.
|
static void |
withConfiguredClient(NimbusClient.WithNimbus cb)
Execute cb with a configured nimbus client that will be closed once cb returns.
|
static void |
withConfiguredClient(NimbusClient.WithNimbus cb,
Map<String,Object> conf)
Execute cb with a configured nimbus client that will be closed once cb returns.
|
close, reconnect, transportpublic final boolean isLocal
Indicates if this is a special client that is overwritten for local mode.
@Deprecated public NimbusClient(Map<String,Object> conf, String host, int port) throws org.apache.storm.thrift.transport.TTransportException
Constructor, Please try to use getConfiguredClient instead of calling this directly.
conf - the conf for the client.host - the host the client is to talk to.port - the port the client is to talk to.org.apache.storm.thrift.transport.TTransportException - on any error.public NimbusClient(Map<String,Object> conf, String host, int port, Integer timeout) throws org.apache.storm.thrift.transport.TTransportException
Constructor, Please try to use getConfiguredClient instead of calling this directly.
conf - the conf for the client.host - the host the client is to talk to.port - the port the client is to talk to.timeout - the timeout to use when connecting.org.apache.storm.thrift.transport.TTransportException - on any error.public NimbusClient(Map<String,Object> conf, String host, Integer port, Integer timeout, String asUser) throws org.apache.storm.thrift.transport.TTransportException
Constructor, Please try to use getConfiguredClientAs instead of calling this directly.
conf - the conf for the client.host - the host the client is to talk to.port - the port the client is to talk to.timeout - the timeout to use when connecting.asUser - the name of the user you want to impersonate (use with caution as it is not always supported).org.apache.storm.thrift.transport.TTransportException - on any error.public NimbusClient(Map<String,Object> conf, String host) throws org.apache.storm.thrift.transport.TTransportException
Constructor, Please try to use getConfiguredClient instead of calling this directly.
conf - the conf for the client.host - the host the client is to talk to.org.apache.storm.thrift.transport.TTransportException - on any error.public static boolean isLocalOverride()
Is the local override set or not.
public static void withConfiguredClient(NimbusClient.WithNimbus cb) throws Exception
Execute cb with a configured nimbus client that will be closed once cb returns.
cb - the callback to send to nimbus.Exception - on any kind of error.public static void withConfiguredClient(NimbusClient.WithNimbus cb, Map<String,Object> conf) throws Exception
Execute cb with a configured nimbus client that will be closed once cb returns.
cb - the callback to send to nimbus.conf - the conf to use instead of reading the global storm conf.Exception - on any kind of error.public static NimbusClient getConfiguredClient(Map<String,Object> conf)
Get a nimbus client as configured by conf.
conf - the configuration to use.public static NimbusClient getConfiguredClient(Map<String,Object> conf, Integer timeout)
Get a nimbus client as configured by conf.
conf - the configuration to use.timeout - the timeout to use when connecting.public static NimbusClient getConfiguredClientAs(Map<String,Object> conf, String asUser)
Get a nimbus client as configured by conf.
conf - the configuration to use.asUser - the user to impersonate (this does not always work).public static NimbusClient getConfiguredClientAs(Map<String,Object> conf, String asUser, Integer timeout)
Get a nimbus client as configured by conf.
conf - the configuration to use.asUser - the user to impersonate (this does not always work).timeout - the timeout to use when connecting.public Nimbus.Iface getClient()
Get the underlying thrift client.
Copyright © 2021 The Apache Software Foundation. All rights reserved.