org.jboss.dna.repository
Class RepositoryLibrary

java.lang.Object
  org.jboss.dna.repository.RepositoryLibrary

All Implemented Interfaces:

org.jboss.dna.graph.connectors.RepositoryConnectionFactory

@ThreadSafe
public class RepositoryLibrary
extends Object
implements org.jboss.dna.graph.connectors.RepositoryConnectionFactory

A library of RepositorySource instances and the RepositoryConnectionPool used to manage the connections for each.

Author:

Randall Hauch

Nested Class Summary

protected class

RepositoryLibrary.Administrator The administrative component for this service.

Constructor Summary

RepositoryLibrary()
Create a new manager instance.

RepositoryLibrary(org.jboss.dna.graph.ExecutionContextFactory executionContextFactory)
Create a new manager instance.

RepositoryLibrary(org.jboss.dna.graph.ExecutionContextFactory executionContextFactory, org.jboss.dna.graph.connectors.RepositoryConnectionFactory delegate)
Create a new manager instance.

RepositoryLibrary(org.jboss.dna.graph.connectors.RepositoryConnectionFactory delegate)
Create a new manager instance.

Method Summary

boolean	addSource(org.jboss.dna.graph.connectors.RepositorySource source) Add the supplied federated source.
protected boolean	awaitTermination(long timeout, TimeUnit unit) Utility method called by the administrator.
org.jboss.dna.graph.connectors.RepositoryConnection	createConnection(String sourceName)
ServiceAdministrator	getAdministrator()
org.jboss.dna.graph.connectors.RepositoryConnectionPool	getConnectionPool(String sourceName) Get the connection pool managing the RepositorySource with the specified name managed by this instance.
org.jboss.dna.graph.connectors.RepositoryConnectionFactory	getDelegate() Get the delegate connection factory.
org.jboss.dna.graph.ExecutionContextFactory	getExecutionContextFactory()
org.jboss.dna.graph.connectors.RepositorySource	getSource(String sourceName) Get the RepositorySource with the specified name managed by this instance.
Collection<String>	getSourceNames() Get an unmodifiable collection of RepositorySource names.
Collection<org.jboss.dna.graph.connectors.RepositorySource>	getSources() Get an unmodifiable collection of RepositorySource instances managed by this instance.
boolean	isTerminated() Return true if this federated repository has completed its termination and no longer has any open connections.
boolean	isTerminating() Returns true if this federated repository is in the process of terminating after ServiceAdministrator.shutdown() has been called on the administrator, but the federated repository has connections that have not yet normally been closed.
boolean	removeSource(org.jboss.dna.graph.connectors.RepositorySource source, long timeToAwait, TimeUnit unit) Remove from this federated repository the supplied source (or a source with the same name as that supplied).
org.jboss.dna.graph.connectors.RepositorySource	removeSource(String name, long timeToAwait, TimeUnit unit) Remove from this federated repository the source with the supplied name.
void	setDelegate(org.jboss.dna.graph.connectors.RepositoryConnectionFactory delegate) Set the delegate connection factory.
protected void	shutdown() Utility method called by the administrator.
protected void	start() Utility method called by the administrator.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryLibrary

public RepositoryLibrary()

Create a new manager instance.

RepositoryLibrary

public RepositoryLibrary(org.jboss.dna.graph.connectors.RepositoryConnectionFactory delegate)

Create a new manager instance.

Parameters:

delegate - the connection factory to which this instance should delegate in the event that a source is not found in this manager; may be null if there is no delegate

RepositoryLibrary

public RepositoryLibrary(org.jboss.dna.graph.ExecutionContextFactory executionContextFactory)

Create a new manager instance.

Parameters:

executionContextFactory - the execution context factory, used by sources to create ExecutionContext instances

Throws:

IllegalArgumentException - if the executionContextFactory reference is null

RepositoryLibrary

public RepositoryLibrary(org.jboss.dna.graph.ExecutionContextFactory executionContextFactory,
                         org.jboss.dna.graph.connectors.RepositoryConnectionFactory delegate)

Create a new manager instance.

Parameters:

executionContextFactory - the execution context factory, used by sources to create ExecutionContext instances

delegate - the connection factory to which this instance should delegate in the event that a source is not found in this manager; may be null if there is no delegate

Throws:

IllegalArgumentException - if the executionContextFactory reference is null

Method Detail

getExecutionContextFactory

public org.jboss.dna.graph.ExecutionContextFactory getExecutionContextFactory()

Returns:

executionContextFactory

getDelegate

public org.jboss.dna.graph.connectors.RepositoryConnectionFactory getDelegate()

Get the delegate connection factory.

Returns:

the connection factory to which this instance should delegate in the event that a source is not found in this manager, or null if there is no delegate

setDelegate

public void setDelegate(org.jboss.dna.graph.connectors.RepositoryConnectionFactory delegate)

Set the delegate connection factory.

Parameters:

delegate - the connection factory to which this instance should delegate in the event that a source is not found in this manager; may be null if there is no delegate

getAdministrator

public ServiceAdministrator getAdministrator()

Returns:

administrator

start

protected void start()

Utility method called by the administrator.

shutdown

protected void shutdown()

Utility method called by the administrator.

awaitTermination

protected boolean awaitTermination(long timeout,
                                   TimeUnit unit)
                            throws InterruptedException

Utility method called by the administrator.

Parameters:

timeout -

unit -

Returns:

true if all pools were terminated in the supplied time (or were already terminated), or false if the timeout occurred before all the connections were closed

Throws:

InterruptedException

isTerminating

public boolean isTerminating()

Returns true if this federated repository is in the process of terminating after ServiceAdministrator.shutdown() has been called on the administrator, but the federated repository has connections that have not yet normally been closed. This method may be useful for debugging. A return of true reported a sufficient period after shutdown may indicate that connection users have ignored or suppressed interruption, causing this repository not to properly terminate.

Returns:

true if terminating but not yet terminated, or false otherwise

See Also:

isTerminated()

isTerminated

public boolean isTerminated()

Return true if this federated repository has completed its termination and no longer has any open connections.

Returns:

true if terminated, or false otherwise

See Also:

isTerminating()

getSourceNames

public Collection<String> getSourceNames()

Get an unmodifiable collection of RepositorySource names.

Returns:

the pools

getSources

public Collection<org.jboss.dna.graph.connectors.RepositorySource> getSources()

Get an unmodifiable collection of RepositorySource instances managed by this instance.

Returns:

the pools

getSource

public org.jboss.dna.graph.connectors.RepositorySource getSource(String sourceName)

Get the RepositorySource with the specified name managed by this instance.

Parameters:

sourceName - the name of the source

Returns:

the source, or null if no such source exists in this instance

getConnectionPool

public org.jboss.dna.graph.connectors.RepositoryConnectionPool getConnectionPool(String sourceName)

Get the connection pool managing the RepositorySource with the specified name managed by this instance.

Parameters:

sourceName - the name of the source

Returns:

the pool, or null if no such pool exists in this instance

addSource

public boolean addSource(org.jboss.dna.graph.connectors.RepositorySource source)

Add the supplied federated source. This method returns false if the source is null.

Parameters:

source - the source to add

Returns:

true if the source is added, or false if the reference is null or if there is already an existing source with the supplied name.

removeSource

public boolean removeSource(org.jboss.dna.graph.connectors.RepositorySource source,
                            long timeToAwait,
                            TimeUnit unit)
                     throws InterruptedException

Remove from this federated repository the supplied source (or a source with the same name as that supplied). This call shuts down the connections in the source in an orderly fashion, allowing those connection currently in use to be used and closed normally, but preventing further connections from being used.

This method can safely be called while the federation repository is in use.

Parameters:

source - the source to be removed

timeToAwait - the amount of time to wait while all of the source's connections are closed, or non-positive if the call should not wait at all

unit - the time unit to be used for timeToAwait

Returns:

true if the source was removed, or false if the source was not a source for this repository.

Throws:

InterruptedException - if the thread is interrupted while awaiting closing of the connections

removeSource

public org.jboss.dna.graph.connectors.RepositorySource removeSource(String name,
                                                                    long timeToAwait,
                                                                    TimeUnit unit)
                                                             throws InterruptedException

Remove from this federated repository the source with the supplied name. This call shuts down the connections in the source in an orderly fashion, allowing those connection currently in use to be used and closed normally, but preventing further connections from being used.

Parameters:

name - the name of the source to be removed

timeToAwait - the amount of time to wait while all of the source's connections are closed, or non-positive if the call should not wait at all

unit - the time unit to be used for timeToAwait

Returns:

the source with the supplied name that was removed, or null if no existing source matching the supplied name could be found

Throws:

InterruptedException - if the thread is interrupted while awaiting closing of the connections

createConnection

public org.jboss.dna.graph.connectors.RepositoryConnection createConnection(String sourceName)

Specified by:

createConnection in interface org.jboss.dna.graph.connectors.RepositoryConnectionFactory

See Also:

RepositoryConnectionFactory.createConnection(java.lang.String)