org.jboss.dna.connector.federation
Class FederatedRepositoryConnection

java.lang.Object
  org.jboss.dna.connector.federation.FederatedRepositoryConnection

All Implemented Interfaces:

RepositoryConnection

@ThreadSafe
public class FederatedRepositoryConnection
extends Object
implements RepositoryConnection

Author:

Randall Hauch

Method Summary

void	close() Close this connection to signal that it is no longer needed and that any accumulated resources are to be released.
void	execute(ExecutionContext context, Request request) Execute the supplied commands against this repository source.
CachePolicy	getDefaultCachePolicy() Get the default cache policy for this repository.
String	getSourceName() Get the name for this repository source.
XAResource	getXAResource() Return the transactional resource associated with this connection.
boolean	ping(long time, TimeUnit unit) Ping the underlying system to determine if the connection is still valid and alive.
void	setListener(RepositorySourceListener listener) Set the listener that is to receive notifications to changes to content within this source.

Methods inherited from class java.lang.Object

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

Method Detail

getSourceName

public String getSourceName()

Get the name for this repository source. This value should be the same as that returned by the same RepositorySource that created this connection.

Specified by:

getSourceName in interface RepositoryConnection

Returns:

the identifier; never null or empty

getDefaultCachePolicy

public CachePolicy getDefaultCachePolicy()

Get the default cache policy for this repository. If none is provided, a global cache policy will be used.

Specified by:

getDefaultCachePolicy in interface RepositoryConnection

Returns:

the default cache policy

getXAResource

public XAResource getXAResource()

Return the transactional resource associated with this connection. The transaction manager will use this resource to manage the participation of this connection in a distributed transaction.

Specified by:

getXAResource in interface RepositoryConnection

Returns:

the XA resource, or null if this connection is not aware of distributed transactions

setListener

public void setListener(RepositorySourceListener listener)

Set the listener that is to receive notifications to changes to content within this source.

Specified by:

setListener in interface RepositoryConnection

Parameters:

listener - the new listener, or null if no component is interested in the change notifications

ping

public boolean ping(long time,
                    TimeUnit unit)

Ping the underlying system to determine if the connection is still valid and alive.

Specified by:

ping in interface RepositoryConnection

Parameters:

time - the length of time to wait before timing out

unit - the time unit to use; may not be null

Returns:

true if this connection is still valid and can still be used, or false otherwise

execute

public void execute(ExecutionContext context,
                    Request request)
             throws RepositorySourceException

Execute the supplied commands against this repository source.

Specified by:

execute in interface RepositoryConnection

Parameters:

context - the environment in which the commands are being executed; never null

request - the request to be executed; never null

Throws:

RepositorySourceException - if there is a problem loading the node data

See Also:

RepositoryConnection.execute(org.jboss.dna.graph.ExecutionContext, org.jboss.dna.graph.requests.Request)

close

public void close()

Close this connection to signal that it is no longer needed and that any accumulated resources are to be released.

Specified by:

close in interface RepositoryConnection