org.jboss.remoting3.spi

Class AbstractHandleableCloseable<T extends HandleableCloseable<T>>

java.lang.Object

org.jboss.remoting3.spi.AbstractHandleableCloseable<T>

Type Parameters:

T - the type of the closeable resource

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, HandleableCloseable<T>

Direct Known Subclasses:

ConnectionImpl, EndpointImpl, EndpointImpl.MapRegistration, LocalChannel, LocalConnectionProvider, LocalConnectionProvider.LoopbackConnectionHandler, RemoteConnectionChannel, RemoteConnectionHandler, RemoteConnectionProvider

public abstract class AbstractHandleableCloseable<T extends HandleableCloseable<T>>
extends java.lang.Object
implements HandleableCloseable<T>

A basic implementation of a closeable resource. Use as a convenient base class for your closeable resources. Ensures that the close() method is idempotent; implements the registry of close handlers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	AbstractHandleableCloseable.CloseHandlerTask
private static class	AbstractHandleableCloseable.KeyImpl<T extends HandleableCloseable<T>>
(package private) static class	AbstractHandleableCloseable.LeakThrowable
private static class	AbstractHandleableCloseable.NullKey
(package private) static class	AbstractHandleableCloseable.State

Nested classes/interfaces inherited from interface org.jboss.remoting3.HandleableCloseable

HandleableCloseable.Key

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	autoClose
private java.lang.StackTraceElement[]	backtrace
private java.util.Map<HandleableCloseable.Key,CloseHandler<? super T>>	closeHandlers
private java.lang.Object	closeLock
private java.util.concurrent.Executor	executor
private java.io.IOException	failure
private static boolean	LEAK_DEBUGGING
private static org.jboss.logging.Logger	log
private AbstractHandleableCloseable.State	state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHandleableCloseable(java.util.concurrent.Executor executor) Basic constructor.
protected	AbstractHandleableCloseable(java.util.concurrent.Executor executor, boolean autoClose) Basic constructor.

Method Summary

Modifier and Type	Method and Description
HandleableCloseable.Key	addCloseHandler(CloseHandler<? super T> handler) Add a handler that will be called upon close.
void	awaitClosed() Wait for a resource close to complete.
void	awaitClosedUninterruptibly() Wait for a resource close to complete.
protected void	checkOpen() Check if open, throwing an exception if it is not.
private static <T extends java.io.IOException> T	clone(T original)
void	close() Close this resource.
protected void	closeAction() Called exactly once when the close() method is invoked; the actual close operation should take place here.
void	closeAsync() Asynchronously close this resource.
protected void	closeComplete() Call when close is complete.
protected void	closeFailed(java.io.IOException cause) Call if an async close has failed.
protected void	finalize() Finalize this closeable instance.
protected java.util.concurrent.Executor	getExecutor() Get the executor to use for handler invocation.
protected boolean	isOpen() Read the status of this resource.
private static void	runCloseTask(java.lang.Runnable task)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.jboss.logging.Logger log

LEAK_DEBUGGING

private static final boolean LEAK_DEBUGGING

executor

private final java.util.concurrent.Executor executor

backtrace

private final java.lang.StackTraceElement[] backtrace

autoClose

private final boolean autoClose

closeLock

private final java.lang.Object closeLock

state

private AbstractHandleableCloseable.State state

failure

private java.io.IOException failure

closeHandlers

private java.util.Map<HandleableCloseable.Key,CloseHandler<? super T extends HandleableCloseable<T>>> closeHandlers

Constructor Detail

AbstractHandleableCloseable

protected AbstractHandleableCloseable(java.util.concurrent.Executor executor)

Basic constructor.

Parameters:

executor - the executor used to execute the close notification handlers

AbstractHandleableCloseable

protected AbstractHandleableCloseable(java.util.concurrent.Executor executor,
                                      boolean autoClose)

Basic constructor.

Parameters:

executor - the executor used to execute the close notification handlers

autoClose - true if this instance should automatically close on finalize

Method Detail

isOpen

protected boolean isOpen()

Read the status of this resource. This is just a snapshot in time; there is no guarantee that the resource will remain open for any amount of time, even if this method returns true.

Returns:

true if the resource is still open

closeAction

protected void closeAction()
                    throws java.io.IOException

Called exactly once when the close() method is invoked; the actual close operation should take place here. This method must call closeComplete(), directly or indirectly, for the close operation to finish (it may happen in another thread but it must happen). This method should not expect the closeComplete() call to be made from another thread from the same thread pool that may cause close(). As close will block, this can result in situations where all threads in the pool are blocked on close() method calls, which means the closeComplete() will never be run.

Throws:

RemotingException - if the close failed

java.io.IOException

close

public void close()
           throws java.io.IOException

Close this resource. Call any registered close handlers. Calling this method more than once will not have any additional effect.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface HandleableCloseable<T extends HandleableCloseable<T>>

Throws:

java.io.IOException - if the close failed

clone

private static <T extends java.io.IOException> T clone(T original)

closeComplete

protected void closeComplete()

Call when close is complete.

closeFailed

protected void closeFailed(java.io.IOException cause)

Call if an async close has failed.

Parameters:

cause - the failure cause

awaitClosed

public void awaitClosed()
                 throws java.lang.InterruptedException

Wait for a resource close to complete.

Specified by:

awaitClosed in interface HandleableCloseable<T extends HandleableCloseable<T>>

Throws:

java.lang.InterruptedException - if the operation is interrupted

awaitClosedUninterruptibly

public void awaitClosedUninterruptibly()

Wait for a resource close to complete.

Specified by:

awaitClosedUninterruptibly in interface HandleableCloseable<T extends HandleableCloseable<T>>

closeAsync

public void closeAsync()

Asynchronously close this resource. Returns immediately.

Specified by:

closeAsync in interface HandleableCloseable<T extends HandleableCloseable<T>>

addCloseHandler

public HandleableCloseable.Key addCloseHandler(CloseHandler<? super T> handler)

Add a handler that will be called upon close. If the resource is already closed, the handler will be called immediately.

Specified by:

addCloseHandler in interface HandleableCloseable<T extends HandleableCloseable<T>>

Parameters:

handler - the close handler

Returns:

a key which may be used to later remove this handler

runCloseTask

private static void runCloseTask(java.lang.Runnable task)

getExecutor

protected java.util.concurrent.Executor getExecutor()

Get the executor to use for handler invocation.

Returns:

the executor

finalize

protected void finalize()
                 throws java.lang.Throwable

Finalize this closeable instance. If the instance hasn't been closed, it is closed and a warning is logged.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

checkOpen

protected void checkOpen()
                  throws NotOpenException

Check if open, throwing an exception if it is not.

Throws:

NotOpenException - if not open