com.allanbank.mongodb.client.connection.proxy

Class AbstractProxyConnection

java.lang.Object

com.allanbank.mongodb.client.connection.proxy.AbstractProxyConnection

All Implemented Interfaces:

Connection, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

AuthenticatingConnection

public abstract class AbstractProxyConnection
extends Object
implements Connection

A helper class for constructing connections that are really just proxies on top of other connections.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2014, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractProxyConnection.ProxiedChangeListener ProxiedChangeListener provides a change listener to modify the source of the event to the outer connection from the (inner) proxied connection.

Field Summary

Fields inherited from interface com.allanbank.mongodb.client.connection.Connection

COMMAND_COLLECTION, OPEN_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractProxyConnection(Connection proxiedConnection) Creates a AbstractProxyConnection.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to this connection.
void	close() Closes the underlying connection.
void	flush()
int	getPendingCount() Returns the number of messages that are pending responses from the server.
protected Connection	getProxiedConnection() Returns the proxiedConnection value.
String	getServerName() Returns the name of a server the connection is currently connected to.
boolean	isAvailable() Returns true if the connection is open and not shutting down, false otherwise.
boolean	isIdle() Determines if the connection is idle.
boolean	isOpen() Determines if the connection is open.
boolean	isShuttingDown() Returns true if the connection is being gracefully closed, false otherwise.
protected void	onExceptin(MongoDbException exception) Provides the ability for derived classes to intercept any exceptions from the underlying proxied connection.
void	raiseErrors(MongoDbException exception) Notifies the call backs for the pending and optionally the to be sent messages that there has been an external, unrecoverable error.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from this connection.
void	send(Message message1, Message message2, ReplyCallback replyCallback) Sends a message on the connection.
void	send(Message message, ReplyCallback replyCallback) Sends a message on the connection.
void	shutdown(boolean force) Notifies the connection that once all outstanding requests have been sent and all replies received the Connection should be closed.
void	waitForClosed(int timeout, TimeUnit timeoutUnits) Waits for the connection to become idle.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProxyConnection

public AbstractProxyConnection(Connection proxiedConnection)

Creates a AbstractProxyConnection.

Parameters:

proxiedConnection - The connection to forward to.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a PropertyChangeListener to this connection. Events are fired as the state of the connection changes.

Overridden to create a proxy connection if not already created and add the listener to that connection.

Specified by:

addPropertyChangeListener in interface Connection

Parameters:

listener - The listener for the change events.

close

public void close()
           throws IOException

Closes the underlying connection.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

See Also:

Closeable.close()

flush

public void flush()
           throws IOException

Forwards the call to the proxied Connection.

Specified by:

flush in interface Flushable

Throws:

IOException

See Also:

Flushable.flush()

getPendingCount

public int getPendingCount()

Returns the number of messages that are pending responses from the server.

Forwards the call to the proxied Connection.

Specified by:

getPendingCount in interface Connection

Returns:

The number of messages pending responses from the server.

getServerName

public String getServerName()

Returns the name of a server the connection is currently connected to.

Overridden to forward the call to the proxied connection.

Specified by:

getServerName in interface Connection

Returns:

The name of a server the connection is currently connected to.

isAvailable

public boolean isAvailable()

Returns true if the connection is open and not shutting down, false otherwise.

Forwards the call to the proxied Connection.

Specified by:

isAvailable in interface Connection

Returns:

True if the connection is open and not shutting down, false otherwise.

isIdle

public boolean isIdle()

Determines if the connection is idle.

Forwards the call to the proxied Connection.

Specified by:

isIdle in interface Connection

Returns:

True if the connection is waiting for messages to send and has no outstanding messages to receive.

isOpen

public boolean isOpen()

Determines if the connection is open.

Forwards the call to the proxied Connection.

Specified by:

isOpen in interface Connection

Returns:

True if the connection is open and thinks it can send messages.

isShuttingDown

public boolean isShuttingDown()

Returns true if the connection is being gracefully closed, false otherwise.

Forwards the call to the proxied Connection.

Specified by:

isShuttingDown in interface Connection

Returns:

True if the connection is being gracefully closed, false otherwise.

raiseErrors

public void raiseErrors(MongoDbException exception)

Notifies the call backs for the pending and optionally the to be sent messages that there has been an external, unrecoverable error.

Forwards the call to the proxied Connection.

Specified by:

raiseErrors in interface Connection

Parameters:

exception - The error condition.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener from this connection.

Overridden to create a proxy connection if not already created and add the listener to that connection.

Specified by:

removePropertyChangeListener in interface Connection

Parameters:

listener - The listener for the change events.

send

public void send(Message message1,
        Message message2,
        ReplyCallback replyCallback)
          throws MongoDbException

Sends a message on the connection.

Forwards the call to the proxied Connection.

Specified by:

send in interface Connection

Parameters:

message1 - The first message to send on the connection.

message2 - The second message to send on the connection.

replyCallback - The callback to notify of responses to the message2. May be null.

Throws:

MongoDbException - On an error sending the message.

send

public void send(Message message,
        ReplyCallback replyCallback)
          throws MongoDbException

Sends a message on the connection.

Forwards the call to the proxied Connection.

Specified by:

send in interface Connection

Parameters:

message - The message to send on the connection.

replyCallback - The callback to notify of responses to the messages. May be null.

Throws:

MongoDbException - On an error sending the message.

shutdown

public void shutdown(boolean force)

Notifies the connection that once all outstanding requests have been sent and all replies received the Connection should be closed. This method will return prior to the connection being closed.

Forwards the call to the proxied Connection.

Specified by:

shutdown in interface Connection

Parameters:

force - If true then the connection can be immediately closed as the caller knows there are no outstanding requests to the server.

waitForClosed

public void waitForClosed(int timeout,
                 TimeUnit timeoutUnits)

Waits for the connection to become idle.

Forwards the call to the proxied Connection.

Specified by:

waitForClosed in interface Connection

Parameters:

timeout - The amount of time to wait for the connection to become idle.

timeoutUnits - The units for the amount of time to wait for the connection to become idle.

getProxiedConnection

protected Connection getProxiedConnection()

Returns the proxiedConnection value.

Returns:

The proxiedConnection value.

onExceptin

protected void onExceptin(MongoDbException exception)

Provides the ability for derived classes to intercept any exceptions from the underlying proxied connection.

Closes the underlying connection.

Parameters:

exception - The thrown exception.