org.apache.jackrabbit.rmi.server
Interface RemoteAdapterFactory

All Known Implementing Classes:

ServerAdapterFactory

public interface RemoteAdapterFactory

Factory interface for creating remote adapters for local resources. This interface defines how the local JCR interfaces are adapted to remote JCR-RMI references. The adaption mechanism can be modified (for example to add extra features) by changing the remote adapter factory used by the repository server.

Note that the ServerObject base class provides a number of utility methods designed to work with a remote adapter factory. Adapter implementations may want to inherit that functionality by subclassing from ServerObject.

Author:

Jukka Zitting, Philipp Koch

See Also:

LocalAdapterFactory, ServerAdapterFactory, ServerObject

Method Summary

RemoteEventCollection	getRemoteEvent(long listenerId, EventIterator events) Returns a remote adapter for the given local events.
RemoteItem	getRemoteItem(Item item) Returns a remote adapter for the given local item.
RemoteItemDefinition	getRemoteItemDefinition(ItemDefinition def) Returns a remote adapter for the given local item definition.
RemoteLock	getRemoteLock(Lock lock) Returns a remote adapter for the given local lock.
RemoteNamespaceRegistry	getRemoteNamespaceRegistry(NamespaceRegistry registry) Returns a remote adapter for the given local namespace registry.
RemoteNode	getRemoteNode(Node node) Returns a remote adapter for the given local node.
RemoteNodeDefinition	getRemoteNodeDefinition(NodeDefinition def) Returns a remote adapter for the given local node definition.
RemoteNodeType	getRemoteNodeType(NodeType type) Returns a remote adapter for the given local node type.
RemoteNodeTypeManager	getRemoteNodeTypeManager(NodeTypeManager manager) Returns a remote adapter for the given local node type manager.
RemoteObservationManager	getRemoteObservationManager(ObservationManager observationManager) Returns a remote adapter for the given local observation manager.
RemoteProperty	getRemoteProperty(Property property) Returns a remote adapter for the given local property.
RemotePropertyDefinition	getRemotePropertyDefinition(PropertyDefinition def) Returns a remote adapter for the given local property definition.
RemoteQuery	getRemoteQuery(Query query) Returns a remote adapter for the given local query.
RemoteQueryManager	getRemoteQueryManager(QueryManager manager) Returns a remote adapter for the given local query manager.
RemoteQueryResult	getRemoteQueryResult(QueryResult result) Returns a remote adapter for the given local query result.
RemoteRepository	getRemoteRepository(Repository repository) Returns a remote adapter for the given local repository.
RemoteRow	getRemoteRow(Row row) Returns a remote adapter for the given local query row.
RemoteSession	getRemoteSession(Session session) Returns a remote adapter for the given local session.
RemoteVersion	getRemoteVersion(Version version) Returns a remote adapter for the given local version.
RemoteVersionHistory	getRemoteVersionHistory(VersionHistory versionHistory) Returns a remote adapter for the given local version history.
RemoteWorkspace	getRemoteWorkspace(Workspace workspace) Returns a remote adapter for the given local workspace.

Method Detail

getRemoteRepository

public RemoteRepository getRemoteRepository(Repository repository)
                                     throws RemoteException

Returns a remote adapter for the given local repository.

Parameters:

repository - local repository

Returns:

remote repository adapter

Throws:

RemoteException - on RMI errors

getRemoteSession

public RemoteSession getRemoteSession(Session session)
                               throws RemoteException

Returns a remote adapter for the given local session.

Parameters:

session - local session

Returns:

remote session adapter

Throws:

RemoteException - on RMI errors

getRemoteWorkspace

public RemoteWorkspace getRemoteWorkspace(Workspace workspace)
                                   throws RemoteException

Returns a remote adapter for the given local workspace.

Parameters:

workspace - local workspace

Returns:

remote workspace adapter

Throws:

RemoteException - on RMI errors

getRemoteObservationManager

public RemoteObservationManager getRemoteObservationManager(ObservationManager observationManager)
                                                     throws RemoteException

Returns a remote adapter for the given local observation manager.

Parameters:

observationManager - local observation manager

Returns:

remote observation manager adapter

Throws:

RemoteException - on RMI errors

getRemoteNamespaceRegistry

public RemoteNamespaceRegistry getRemoteNamespaceRegistry(NamespaceRegistry registry)
                                                   throws RemoteException

Returns a remote adapter for the given local namespace registry.

Parameters:

registry - local namespace registry

Returns:

remote namespace registry adapter

Throws:

RemoteException - on RMI errors

getRemoteNodeTypeManager

public RemoteNodeTypeManager getRemoteNodeTypeManager(NodeTypeManager manager)
                                               throws RemoteException

Returns a remote adapter for the given local node type manager.

Parameters:

manager - local node type manager

Returns:

remote node type manager adapter

Throws:

RemoteException - on RMI errors

getRemoteItem

public RemoteItem getRemoteItem(Item item)
                         throws RemoteException

Returns a remote adapter for the given local item. This method will return an adapter that implements only the Item interface. The caller may want to introspect the local item to determine whether to use either the getRemoteNode or the getRemoteProperty method instead.

Parameters:

item - local item

Returns:

remote item adapter

Throws:

RemoteException - on RMI errors

getRemoteProperty

public RemoteProperty getRemoteProperty(Property property)
                                 throws RemoteException

Returns a remote adapter for the given local property.

Parameters:

property - local property

Returns:

remote property adapter

Throws:

RemoteException - on RMI errors

getRemoteNode

public RemoteNode getRemoteNode(Node node)
                         throws RemoteException

Returns a remote adapter for the given local node.

Parameters:

node - local node

Returns:

remote node adapter

Throws:

RemoteException - on RMI errors

getRemoteVersion

public RemoteVersion getRemoteVersion(Version version)
                               throws RemoteException

Returns a remote adapter for the given local version.

Parameters:

version - local version

Returns:

remote version adapter

Throws:

RemoteException - on RMI errors

getRemoteVersionHistory

public RemoteVersionHistory getRemoteVersionHistory(VersionHistory versionHistory)
                                             throws RemoteException

Returns a remote adapter for the given local version history.

Parameters:

versionHistory - local version history

Returns:

remote version history adapter

Throws:

RemoteException - on RMI errors

getRemoteNodeType

public RemoteNodeType getRemoteNodeType(NodeType type)
                                 throws RemoteException

Returns a remote adapter for the given local node type.

Parameters:

type - local node type

Returns:

remote node type adapter

Throws:

RemoteException - on RMI errors

getRemoteItemDefinition

public RemoteItemDefinition getRemoteItemDefinition(ItemDefinition def)
                                             throws RemoteException

Returns a remote adapter for the given local item definition. This method will return an adapter that implements only the ItemDefinition interface. The caller may want to introspect the local item definition to determine whether to use either the getRemoteNodeDef or the getRemotePropertyDef method instead.

Parameters:

def - local item definition

Returns:

remote item definition adapter

Throws:

RemoteException - on RMI errors

getRemoteNodeDefinition

public RemoteNodeDefinition getRemoteNodeDefinition(NodeDefinition def)
                                             throws RemoteException

Returns a remote adapter for the given local node definition.

Parameters:

def - local node definition

Returns:

remote node definition adapter

Throws:

RemoteException - on RMI errors

getRemotePropertyDefinition

public RemotePropertyDefinition getRemotePropertyDefinition(PropertyDefinition def)
                                                     throws RemoteException

Returns a remote adapter for the given local property definition.

Parameters:

def - local property definition

Returns:

remote property definition adapter

Throws:

RemoteException - on RMI errors

getRemoteLock

public RemoteLock getRemoteLock(Lock lock)
                         throws RemoteException

Returns a remote adapter for the given local lock.

Parameters:

lock - local lock

Returns:

remote lock adapter

Throws:

RemoteException - on RMI errors

getRemoteQueryManager

public RemoteQueryManager getRemoteQueryManager(QueryManager manager)
                                         throws RemoteException

Returns a remote adapter for the given local query manager.

Parameters:

manager - local query manager

Returns:

remote query manager adapter

Throws:

RemoteException - on RMI errors

getRemoteQuery

public RemoteQuery getRemoteQuery(Query query)
                           throws RemoteException

Returns a remote adapter for the given local query.

Parameters:

query - local query

Returns:

remote query adapter

Throws:

RemoteException - on RMI errors

getRemoteQueryResult

public RemoteQueryResult getRemoteQueryResult(QueryResult result)
                                       throws RemoteException

Returns a remote adapter for the given local query result.

Parameters:

result - local query result

Returns:

remote query result adapter

Throws:

RemoteException - on RMI errors

getRemoteRow

public RemoteRow getRemoteRow(Row row)
                       throws RemoteException

Returns a remote adapter for the given local query row.

Parameters:

row - local query row

Returns:

remote query row adapter

Throws:

RemoteException - on RMI errors

getRemoteEvent

public RemoteEventCollection getRemoteEvent(long listenerId,
                                            EventIterator events)
                                     throws RemoteException

Returns a remote adapter for the given local events.

Parameters:

listenerId - The listener identifier to which the events are to be dispatched.

events - the local events

Returns:

remote event iterator adapter

Throws:

RemoteException - on RMI errors