Package org.apereo.cas.ticket.registry

Class RedisCompositeKey

java.lang.Object

org.apereo.cas.ticket.registry.RedisCompositeKey

public class RedisCompositeKey
extends Object

This is RedisCompositeKey.

Since:

7.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedisCompositeKey.RedisCompositeKeyBuilder<C extends RedisCompositeKey,B extends RedisCompositeKey.RedisCompositeKeyBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REDIS_TICKET_REGISTRY_MESSAGE_TOPIC	Redis message topic key used to sync memory cache across nodes.

Constructor Summary

Constructors

Constructor	Description
RedisCompositeKey(String query, String prefix)

Method Summary

Modifier and Type	Method	Description
static RedisCompositeKey.RedisCompositeKeyBuilder<?,?>	builder()
static RedisCompositeKey	forPrincipal()	For principal redis composite key.
static RedisCompositeKey	forTickets()	For tickets redis composite key.
String	getPrefix()
String	getQuery()
String	toKeyPattern()	To key pattern string.
RedisCompositeKey	withIdPattern(String id)	Construct a redis key that can use pattern matching on IDs.
String	withoutPrefix(String key)	Remove the starting prefix from the key.
RedisCompositeKey	withPrefix(String prefix)
RedisCompositeKey	withQuery(String query)
RedisCompositeKey	withTicketId(String ticketPrefix, String encodedId)	With ticket id redis composite key.

Methods inherited from class java.lang.Object

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

Field Details

REDIS_TICKET_REGISTRY_MESSAGE_TOPIC

public static final String REDIS_TICKET_REGISTRY_MESSAGE_TOPIC

Redis message topic key used to sync memory cache across nodes.

See Also:

• Constant Field Values

Constructor Details

RedisCompositeKey

public RedisCompositeKey(String query,
 String prefix)

Method Details

forTickets

public static RedisCompositeKey forTickets()

For tickets redis composite key.

Returns:

the redis composite key

forPrincipal

public static RedisCompositeKey forPrincipal()

For principal redis composite key.

Returns:

the redis composite key

toKeyPattern

public String toKeyPattern()

To key pattern string.

Returns:

the string

withIdPattern

public RedisCompositeKey withIdPattern(String id)

Construct a redis key that can use pattern matching on IDs.

Parameters:

id - the id

Returns:

the redis composite key

withTicketId

public RedisCompositeKey withTicketId(String ticketPrefix,
 String encodedId)

With ticket id redis composite key.

Parameters:

ticketPrefix - the ticket prefix

encodedId - the encoded id

Returns:

the redis composite key

withoutPrefix

public String withoutPrefix(String key)

Remove the starting prefix from the key.

Parameters:

key - the key

Returns:

the string

builder

public static RedisCompositeKey.RedisCompositeKeyBuilder<?,?> builder()

getQuery

public String getQuery()

getPrefix

public String getPrefix()

withQuery

public RedisCompositeKey withQuery(String query)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withPrefix

public RedisCompositeKey withPrefix(String prefix)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).