org.jredis.connector

Class ConnectionSpec.RefImpl

java.lang.Object

org.jredis.connector.ConnectionSpec.RefImpl

All Implemented Interfaces:

ConnectionSpec

Direct Known Subclasses:

DefaultConnectionSpec

Enclosing interface:

ConnectionSpec

public static class ConnectionSpec.RefImpl
extends java.lang.Object
implements ConnectionSpec

Reference implementation of ConnectionSpec.

This implementation is a read/write implementation providing no default values of any kind. It can be used as is and initialized as required, or (as it is intended) it will provide support for various connection profiles (e.g. server connectors), etc.

Since:

alpha.0

Version:

alpha.0, Aug 23, 2009

Nested Class Summary

Nested classes/interfaces inherited from interface org.jredis.connector.ConnectionSpec

ConnectionSpec.RefImpl

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	connectionFlagBitmask Connection.Flag bitmask
(package private) java.util.Map<Connection.Property,java.lang.Object>	connectionProperties Map of the Connection.Flags of the ConnectionSpec
private int	heartbeat heartbeat period in milliseconds
(package private) java.util.Map<Connection.Socket.Flag,java.lang.Boolean>	socketFlags Map of the SocketFlags of the ConnectionSpec
(package private) java.util.Map<Connection.Socket.Property,java.lang.Integer>	socketProperties Map of the SocketPropertys of the ConnectionSpec

Constructor Summary

Constructors

Constructor and Description
RefImpl()

Method Summary

Modifier and Type	Method and Description
java.net.InetAddress	getAddress()
boolean	getConnectionFlag(Connection.Flag flag)
java.lang.Object	getConnectionProperty(Connection.Property prop)
byte[]	getCredentials()
int	getDatabase()
int	getHeartbeat()
int	getMaxConnectWait()
Connection.Modality	getModality()
int	getPort()
int	getReconnectCnt()
boolean	getSocketFlag(Connection.Socket.Flag flag) Get the SocketFlag for the ConnectionSpec
java.lang.Integer	getSocketProperty(Connection.Socket.Property property) Get the Connection.Socket.Property for the ConnectionSpec
ConnectionSpec	setAddress(java.net.InetAddress address)
ConnectionSpec	setConnectionFlag(Connection.Flag flag, java.lang.Boolean value) Sets the specified Connection.Flag
ConnectionSpec	setConnectionProperty(Connection.Property prop, java.lang.Object value)
ConnectionSpec	setCredentials(byte[] credentials) Set the Connection's credentials, presented to Redis on (re)connects.
ConnectionSpec	setCredentials(java.lang.String credentials) Convenience method
ConnectionSpec	setDatabase(int database)
ConnectionSpec	setHeartbeat(int seconds)
ConnectionSpec	setMaxConnectWait(int cnt)
ConnectionSpec	setModality(Connection.Modality modality)
ConnectionSpec	setPort(int port)
ConnectionSpec	setReconnectCnt(int reconnectCnt)
ConnectionSpec	setSocketFlag(Connection.Socket.Flag flag, java.lang.Boolean value) Set the Connection.Socket.Flag for the ConnectionSpec
ConnectionSpec	setSocketProperty(Connection.Socket.Property property, java.lang.Integer value) Set the SocketProperty for the ConnectionSpec

Methods inherited from class java.lang.Object

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

Field Detail

socketFlags

java.util.Map<Connection.Socket.Flag,java.lang.Boolean> socketFlags

Map of the SocketFlags of the ConnectionSpec

socketProperties

java.util.Map<Connection.Socket.Property,java.lang.Integer> socketProperties

Map of the SocketPropertys of the ConnectionSpec

connectionFlagBitmask

int connectionFlagBitmask

Connection.Flag bitmask

connectionProperties

java.util.Map<Connection.Property,java.lang.Object> connectionProperties

Map of the Connection.Flags of the ConnectionSpec

heartbeat

private int heartbeat

heartbeat period in milliseconds

Constructor Detail

RefImpl

public RefImpl()

Method Detail

getAddress

public final java.net.InetAddress getAddress()

Specified by:

getAddress in interface ConnectionSpec

Returns:

getCredentials

public final byte[] getCredentials()

Specified by:

getCredentials in interface ConnectionSpec

Returns:

the password (if any) for the connection. Used on (re-)connect to authenticate the client after connectivity has been established

See Also:

Command#AUTH

getDatabase

public final int getDatabase()

Specified by:

getDatabase in interface ConnectionSpec

Returns:

the database selected for the connection. Used on (re-)connect to select the db after network connectivity has been established.

See Also:

Command#SELECT

getPort

public final int getPort()

Specified by:

getPort in interface ConnectionSpec

Returns:

the port number for the connection

getModality

public final Connection.Modality getModality()

Specified by:

getModality in interface ConnectionSpec

Returns:

the Connection.Modality of this protocol handler.

getMaxConnectWait

public final int getMaxConnectWait()

Specified by:

getMaxConnectWait in interface ConnectionSpec

Returns:

getReconnectCnt

public final int getReconnectCnt()

Specified by:

getReconnectCnt in interface ConnectionSpec

Returns:

getSocketFlag

public final boolean getSocketFlag(Connection.Socket.Flag flag)

Description copied from interface: ConnectionSpec

Get the SocketFlag for the ConnectionSpec

Specified by:

getSocketFlag in interface ConnectionSpec

Returns:

the specified TCP socket flag used for the connection.

See Also:

SocketFlag

getSocketProperty

public final java.lang.Integer getSocketProperty(Connection.Socket.Property property)

Description copied from interface: ConnectionSpec

Get the Connection.Socket.Property for the ConnectionSpec

Specified by:

getSocketProperty in interface ConnectionSpec

Returns:

the specified socket property used for the connection.

See Also:

SocketFlag

getConnectionProperty

public final java.lang.Object getConnectionProperty(Connection.Property prop)

Specified by:

getConnectionProperty in interface ConnectionSpec

Returns:

setAddress

public final ConnectionSpec setAddress(java.net.InetAddress address)

Specified by:

setAddress in interface ConnectionSpec

Returns:

the ConnectionSpec

setPort

public final ConnectionSpec setPort(int port)

Specified by:

setPort in interface ConnectionSpec

Returns:

the ConnectionSpec

setCredentials

public final ConnectionSpec setCredentials(byte[] credentials)

Description copied from interface: ConnectionSpec

Set the Connection's credentials, presented to Redis on (re)connects.

Specified by:

setCredentials in interface ConnectionSpec

Returns:

the ConnectionSpec

See Also:

ConnectionSpec.setCredentials(String)

setCredentials

public final ConnectionSpec setCredentials(java.lang.String credentials)

Description copied from interface: ConnectionSpec

Convenience method

Specified by:

setCredentials in interface ConnectionSpec

Returns:

the ConnectionSpec

See Also:

ConnectionSpec.setCredentials(byte[])

setDatabase

public final ConnectionSpec setDatabase(int database)

Specified by:

setDatabase in interface ConnectionSpec

Returns:

the ConnectionSpec

setReconnectCnt

public final ConnectionSpec setReconnectCnt(int reconnectCnt)

Specified by:

setReconnectCnt in interface ConnectionSpec

Returns:

the ConnectionSpec

setConnectionProperty

public final ConnectionSpec setConnectionProperty(Connection.Property prop,
                                                  java.lang.Object value)

Specified by:

setConnectionProperty in interface ConnectionSpec

Returns:

setModality

public final ConnectionSpec setModality(Connection.Modality modality)

Specified by:

setModality in interface ConnectionSpec

Returns:

the the ConnectionSpec

setMaxConnectWait

public final ConnectionSpec setMaxConnectWait(int cnt)

Specified by:

setMaxConnectWait in interface ConnectionSpec

Returns:

the ConnectionSpec

setSocketFlag

public final ConnectionSpec setSocketFlag(Connection.Socket.Flag flag,
                                          java.lang.Boolean value)

Description copied from interface: ConnectionSpec

Set the Connection.Socket.Flag for the ConnectionSpec

Specified by:

setSocketFlag in interface ConnectionSpec

Returns:

ConnectionSpec this

setSocketProperty

public final ConnectionSpec setSocketProperty(Connection.Socket.Property property,
                                              java.lang.Integer value)

Description copied from interface: ConnectionSpec

Set the SocketProperty for the ConnectionSpec

Specified by:

setSocketProperty in interface ConnectionSpec

Returns:

the previous value (if any). Null if none existed, per Map.put(Object, Object) semantics.

getConnectionFlag

public final boolean getConnectionFlag(Connection.Flag flag)

Specified by:

getConnectionFlag in interface ConnectionSpec

Returns:

the Connection.Flag

See Also:

SocketFlag

setConnectionFlag

public final ConnectionSpec setConnectionFlag(Connection.Flag flag,
                                              java.lang.Boolean value)

Description copied from interface: ConnectionSpec

Sets the specified Connection.Flag

Specified by:

setConnectionFlag in interface ConnectionSpec

Returns:

the referenced ConnectionSpec

getHeartbeat

public final int getHeartbeat()

Specified by:

getHeartbeat in interface ConnectionSpec

Returns:

the heartbeat period in seconds

setHeartbeat

public final ConnectionSpec setHeartbeat(int seconds)

Specified by:

setHeartbeat in interface ConnectionSpec

Parameters:

seconds - heartbeat period

Returns:

the ConnectionSpec