Package com.aerospike.client

Class Info

java.lang.Object

com.aerospike.client.Info

public class Info
extends Object

Access server's info monitoring protocol.

The info protocol is a name/value pair based system, where an individual database server node is queried to determine its configuration and status. The list of supported names can be found at:

https://www.aerospike.com/docs/reference/info/index.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Info.Error	Info command error response.
class	Info.NameValueParser	Parser for responses in name/value pair format:

Field Summary

Fields

Modifier and Type	Field	Description
byte[]	buffer
int	length
int	offset

Constructor Summary

Constructors

Constructor	Description
Info(byte[] buffer, int length)	Internal constructor.
Info(com.aerospike.client.cluster.Connection conn)	Send default empty command to server and store results.
Info(com.aerospike.client.cluster.Connection conn, String command)	Send single command to server and store results.
Info(com.aerospike.client.cluster.Connection conn, String... commands)	Send multiple commands to server and store results.
Info(com.aerospike.client.cluster.Connection conn, List<String> commands)	Send multiple commands to server and store results.

Method Summary

Modifier and Type	Method	Description
void	expect(char expected)
Info.NameValueParser	getNameValueParser()	Parse response in name/value pair format:
String	getTruncatedResponse()
String	getValue()	Return single value from response buffer.
int	parseInt()	Convert UTF8 numeric digits to an integer.
HashMap<String,String>	parseMultiResponse()
void	parseName(String name)	Parse request name, verify the name is expected and check for error message.
static int	parseResultCode(String response)	Parse info response string and return the result code for info commands that only return OK or an error string.
String	parseString(char stop)
String	parseString(char stop1, char stop2, char stop3)
static HashMap<String,String>	request(com.aerospike.client.cluster.Connection conn)	Get all the default info from the specified database server node.
static String	request(com.aerospike.client.cluster.Connection conn, String name)	Get one info value by name from the specified database server node.
static HashMap<String,String>	request(com.aerospike.client.cluster.Connection conn, String... names)	Get many info values by name from the specified database server node.
static HashMap<String,String>	request(com.aerospike.client.cluster.Connection conn, List<String> names)	Get many info values by name from the specified database server node.
static String	request(Node node, String name)	Get one info value by name from the specified database server node.
static Map<String,String>	request(InfoPolicy policy, Node node)	Get default info values from the specified database server node.
static String	request(InfoPolicy policy, Node node, String name)	Get one info value by name from the specified database server node.
static Map<String,String>	request(InfoPolicy policy, Node node, String... names)	Get many info values by name from the specified database server node.
static HashMap<String,String>	request(String hostname, int port)	Get default info from the specified database server node, using host name and port.
static String	request(String hostname, int port, String name)	Get one info value by name from the specified database server node, using host name and port.
static HashMap<String,String>	request(String hostname, int port, String... names)	Get many info values by name from the specified database server node, using host name and port.
static HashMap<String,String>	request(InetSocketAddress socketAddress)	Get all the default info from the specified database server node.
static String	request(InetSocketAddress socketAddress, String name)	Get one info value by name from the specified database server node.
static HashMap<String,String>	request(InetSocketAddress socketAddress, String... names)	Get many info values by name from the specified database server node.
void	skipDelimiter(char stop)	Find next delimeter and skip over it.
void	skipToValue()

Methods inherited from class java.lang.Object

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

Field Details

buffer

public byte[] buffer

length

public int length

offset

public int offset

Constructor Details

Info

public Info(com.aerospike.client.cluster.Connection conn,
 String command)
     throws AerospikeException

Send single command to server and store results. This constructor is used internally. The static request methods should be used instead.

Parameters:

conn - connection to server node

command - command sent to server

Throws:

AerospikeException

Info

public Info(com.aerospike.client.cluster.Connection conn,
 String... commands)
     throws AerospikeException

Send multiple commands to server and store results. This constructor is used internally. The static request methods should be used instead.

Parameters:

conn - connection to server node

commands - commands sent to server

Throws:

AerospikeException

Info

public Info(com.aerospike.client.cluster.Connection conn,
 List<String> commands)
     throws AerospikeException

Send multiple commands to server and store results. This constructor is used internally. The static request methods should be used instead.

Parameters:

conn - connection to server node

commands - commands sent to server

Throws:

AerospikeException

Info

public Info(com.aerospike.client.cluster.Connection conn)
     throws AerospikeException

Send default empty command to server and store results. This constructor is used internally. The static request methods should be used instead.

Parameters:

conn - connection to server node

Throws:

AerospikeException

Info

public Info(byte[] buffer,
 int length)

Internal constructor. Do not use.

Method Details

request

public static String request(Node node,
 String name)
                      throws AerospikeException

Get one info value by name from the specified database server node. This method supports user authentication.

Parameters:

node - server node

name - name of variable to retrieve

Throws:

AerospikeException

request

public static String request(InfoPolicy policy,
 Node node,
 String name)
                      throws AerospikeException

Get one info value by name from the specified database server node. This method supports user authentication.

Parameters:

policy - info command configuration parameters, pass in null for defaults

node - server node

name - name of variable to retrieve

Throws:

AerospikeException

request

public static Map<String,String> request(InfoPolicy policy,
 Node node,
 String... names)
                                  throws AerospikeException

Get many info values by name from the specified database server node. This method supports user authentication.

Parameters:

policy - info command configuration parameters, pass in null for defaults

node - server node

names - names of variables to retrieve

Throws:

AerospikeException

request

public static Map<String,String> request(InfoPolicy policy,
 Node node)
                                  throws AerospikeException

Get default info values from the specified database server node. This method supports user authentication.

Parameters:

policy - info command configuration parameters, pass in null for defaults

node - server node

Throws:

AerospikeException

request

public static String request(String hostname,
 int port,
 String name)
                      throws AerospikeException

Get one info value by name from the specified database server node, using host name and port. This method does not support user authentication.

Parameters:

hostname - host name

port - host port

name - name of value to retrieve

Returns:

info value

Throws:

AerospikeException

request

public static HashMap<String,String> request(String hostname,
 int port,
 String... names)
                                      throws AerospikeException

Get many info values by name from the specified database server node, using host name and port. This method does not support user authentication.

Parameters:

hostname - host name

port - host port

names - names of values to retrieve

Returns:

info name/value pairs

Throws:

AerospikeException

request

public static HashMap<String,String> request(String hostname,
 int port)
                                      throws AerospikeException

Get default info from the specified database server node, using host name and port. This method does not support user authentication.

Parameters:

hostname - host name

port - host port

Returns:

info name/value pairs

Throws:

AerospikeException

request

public static String request(InetSocketAddress socketAddress,
 String name)
                      throws AerospikeException

Get one info value by name from the specified database server node. This method does not support TLS connections nor user authentication.

Parameters:

socketAddress - InetSocketAddress of server node

name - name of value to retrieve

Returns:

info value

Throws:

AerospikeException

request

public static HashMap<String,String> request(InetSocketAddress socketAddress,
 String... names)
                                      throws AerospikeException

Get many info values by name from the specified database server node. This method does not support TLS connections nor user authentication.

Parameters:

socketAddress - InetSocketAddress of server node

names - names of values to retrieve

Returns:

info name/value pairs

Throws:

AerospikeException

request

public static HashMap<String,String> request(InetSocketAddress socketAddress)
                                      throws AerospikeException

Get all the default info from the specified database server node. This method does not support TLS connections nor user authentication.

Parameters:

socketAddress - InetSocketAddress of server node

Returns:

info name/value pairs

Throws:

AerospikeException

request

public static String request(com.aerospike.client.cluster.Connection conn,
 String name)
                      throws AerospikeException

Get one info value by name from the specified database server node.

Parameters:

conn - socket connection to server node

name - name of value to retrieve

Returns:

info value

Throws:

AerospikeException

request

public static HashMap<String,String> request(com.aerospike.client.cluster.Connection conn,
 String... names)
                                      throws AerospikeException

Get many info values by name from the specified database server node.

Parameters:

conn - socket connection to server node

names - names of values to retrieve

Returns:

info name/value pairs

Throws:

AerospikeException

request

public static HashMap<String,String> request(com.aerospike.client.cluster.Connection conn,
 List<String> names)
                                      throws AerospikeException

Get many info values by name from the specified database server node.

Parameters:

conn - socket connection to server node

names - names of values to retrieve

Returns:

info name/value pairs

Throws:

AerospikeException

request

public static HashMap<String,String> request(com.aerospike.client.cluster.Connection conn)
                                      throws AerospikeException

Get all the default info from the specified database server node.

Parameters:

conn - socket connection to server node

Returns:

info name/value pairs

Throws:

AerospikeException

parseResultCode

public static int parseResultCode(String response)

Parse info response string and return the result code for info commands that only return OK or an error string. Info commands that return other data are not handled by this method.

parseMultiResponse

public HashMap<String,String> parseMultiResponse()
                                          throws AerospikeException

Throws:

AerospikeException

parseName

public void parseName(String name)

Parse request name, verify the name is expected and check for error message.

getValue

public String getValue()

Return single value from response buffer.

getNameValueParser

public Info.NameValueParser getNameValueParser()

Parse response in name/value pair format:

<command>\t<name1>=<value1>;<name2>=<value2>;...\n

Returns:

parser for name/value pairs

skipToValue

public void skipToValue()

skipDelimiter

public void skipDelimiter(char stop)

Find next delimeter and skip over it.

parseInt

public int parseInt()

Convert UTF8 numeric digits to an integer. Negative integers are not supported. Input format: 1234

parseString

public String parseString(char stop)

parseString

public String parseString(char stop1,
 char stop2,
 char stop3)

expect

public void expect(char expected)

getTruncatedResponse

public String getTruncatedResponse()