Package com.aerospike.client
Class Info
java.lang.Object
com.aerospike.client.Info
public final 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:
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
Info.NameValueParser
Parser for responses in name/value pair format: -
Field Summary
-
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()
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
skipToValue()
-
Field Details
-
Constructor Details
-
Info
public Info(com.aerospike.client.cluster.Connection conn, String command) throws AerospikeExceptionSend 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 nodecommand
- command sent to server- Throws:
AerospikeException
-
Info
public Info(com.aerospike.client.cluster.Connection conn, String... commands) throws AerospikeExceptionSend 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 nodecommands
- commands sent to server- Throws:
AerospikeException
-
Info
public Info(com.aerospike.client.cluster.Connection conn, List<String> commands) throws AerospikeExceptionSend 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 nodecommands
- commands sent to server- Throws:
AerospikeException
-
Info
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
-
getNameValueParser
Parse response in name/value pair format:<command>\t<name1>=<value1>;<name2>=<value2>;...\n
- Returns:
- parser for name/value pairs
-
getValue
Return single value from response buffer. -
skipToValue
public void skipToValue() -
parseInt
public int parseInt()Convert UTF8 numeric digits to an integer. Negative integers are not supported. Input format: 1234 -
parseString
-
parseString
-
expect
public void expect(char expected) -
getTruncatedResponse
-
request
Get one info value by name from the specified database server node. This method supports user authentication.- Parameters:
node
- server nodename
- name of variable to retrieve- Throws:
AerospikeException
-
request
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 defaultsnode
- server nodename
- name of variable to retrieve- Throws:
AerospikeException
-
request
public static Map<String,String> request(InfoPolicy policy, Node node, String... names) throws AerospikeExceptionGet 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 defaultsnode
- server nodenames
- names of variables to retrieve- Throws:
AerospikeException
-
request
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 defaultsnode
- server node- Throws:
AerospikeException
-
request
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 nameport
- host portname
- name of value to retrieve- Returns:
- info value
- Throws:
AerospikeException
-
request
public static HashMap<String,String> request(String hostname, int port, String... names) throws AerospikeExceptionGet 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 nameport
- host portnames
- names of values to retrieve- Returns:
- info name/value pairs
- Throws:
AerospikeException
-
request
Get default info from the specified database server node, using host name and port. This method does not support user authentication.- Parameters:
hostname
- host nameport
- host port- Returns:
- info name/value pairs
- Throws:
AerospikeException
-
request
public static String request(InetSocketAddress socketAddress, String name) throws AerospikeExceptionGet 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 nodename
- name of value to retrieve- Returns:
- info value
- Throws:
AerospikeException
-
request
public static HashMap<String,String> request(InetSocketAddress socketAddress, String... names) throws AerospikeExceptionGet 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 nodenames
- names of values to retrieve- Returns:
- info name/value pairs
- Throws:
AerospikeException
-
request
public static HashMap<String,String> request(InetSocketAddress socketAddress) throws AerospikeExceptionGet 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 AerospikeExceptionGet one info value by name from the specified database server node.- Parameters:
conn
- socket connection to server nodename
- 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 AerospikeExceptionGet many info values by name from the specified database server node.- Parameters:
conn
- socket connection to server nodenames
- 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 AerospikeExceptionGet many info values by name from the specified database server node.- Parameters:
conn
- socket connection to server nodenames
- 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 AerospikeExceptionGet all the default info from the specified database server node.- Parameters:
conn
- socket connection to server node- Returns:
- info name/value pairs
- Throws:
AerospikeException
-
parseMultiResponse
- Throws:
AerospikeException
-