redis.clients.jedis.util

Class JedisURIHelper

java.lang.Object

redis.clients.jedis.util.JedisURIHelper

public final class JedisURIHelper
extends java.lang.Object

Utility class for handling Redis URIs. This class provides methods to extract various components from a Redis URI, such as host, port, user, password, database index, and protocol. It also includes methods to validate the URI and check its scheme.

URI syntax

redis[s]://[[username][:password]@] host[:port][/database]

Authentication

Authentication details can be provided in the URI in the form of a username and password. Redis URIs may contain authentication details that effectively lead to usernames with passwords, password-only, or no authentication.

Examples:

• Username and Password: redis://username:password@host:port
• Password-only: redis://:password@host:port
• Empty password: redis://username:@host:port
• No Authentication: redis://host:port

Method Summary

Modifier and Type	Method and Description
static int	getDBIndex(java.net.URI uri)
static HostAndPort	getHostAndPort(java.net.URI uri)
static java.lang.String	getPassword(java.net.URI uri) Extracts the password from the given URI.
static RedisProtocol	getRedisProtocol(java.net.URI uri)
static java.lang.String	getUser(java.net.URI uri) Extracts the user from the given URI.
static boolean	isRedisScheme(java.net.URI uri)
static boolean	isRedisSSLScheme(java.net.URI uri)
static boolean	isValid(java.net.URI uri)

Methods inherited from class java.lang.Object

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

Method Detail

getHostAndPort

public static HostAndPort getHostAndPort(java.net.URI uri)

getUser

public static java.lang.String getUser(java.net.URI uri)

Extracts the user from the given URI.

For details on the URI format and authentication examples, see JedisURIHelper.

Parameters:

uri - the URI to extract the user from

Returns:

the user as a String, or null if user is empty or URI.getUserInfo() info is missing

getPassword

public static java.lang.String getPassword(java.net.URI uri)

Extracts the password from the given URI.

For details on the URI format and authentication examples, see JedisURIHelper.

Parameters:

uri - the URI to extract the password from

Returns:

the password as a String, or null if URI.getUserInfo() info is missing

Throws:

java.lang.IllegalArgumentException - if URI.getUserInfo() is provided but does not contain a password

getDBIndex

public static int getDBIndex(java.net.URI uri)

getRedisProtocol

public static RedisProtocol getRedisProtocol(java.net.URI uri)

isValid

public static boolean isValid(java.net.URI uri)

isRedisScheme

public static boolean isRedisScheme(java.net.URI uri)

isRedisSSLScheme

public static boolean isRedisSSLScheme(java.net.URI uri)