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.

See Also:

LocalAdapterFactory, ServerAdapterFactory, ServerObject

Method Summary

Methods

Modifier and Type	Method and Description
int	getPortNumber() Returns the port number to which the server objects created by this factory are bound.
RemoteAccessControlEntry	getRemoteAccessControlEntry(javax.jcr.security.AccessControlEntry local) Returns a remote adapter for the given local access control manager.
RemoteAccessControlEntry[]	getRemoteAccessControlEntry(javax.jcr.security.AccessControlEntry[] local) Returns a remote adapter for the given local access control manager.
RemoteAccessControlManager	getRemoteAccessControlManager(javax.jcr.security.AccessControlManager acm) Returns a remote adapter for the given local access control manager.
RemoteAccessControlPolicy	getRemoteAccessControlPolicy(javax.jcr.security.AccessControlPolicy local) Returns a remote adapter for the given local access control manager.
RemoteAccessControlPolicy[]	getRemoteAccessControlPolicy(javax.jcr.security.AccessControlPolicy[] local) Returns a remote adapter for the given local access control manager.
RemoteIterator	getRemoteAccessControlPolicyIterator(javax.jcr.security.AccessControlPolicyIterator iterator) Returns a remote adapter for the given local access control manager.
RemoteEventCollection	getRemoteEvent(long listenerId, javax.jcr.observation.EventIterator events) Returns a remote adapter for the given local events.
RemoteItem	getRemoteItem(javax.jcr.Item item) Returns a remote adapter for the given local item.
RemoteItemDefinition	getRemoteItemDefinition(javax.jcr.nodetype.ItemDefinition def) Returns a remote adapter for the given local item definition.
RemoteLock	getRemoteLock(javax.jcr.lock.Lock lock) Returns a remote adapter for the given local lock.
RemoteLockManager	getRemoteLockManager(javax.jcr.lock.LockManager lockManager)
RemoteNamespaceRegistry	getRemoteNamespaceRegistry(javax.jcr.NamespaceRegistry registry) Returns a remote adapter for the given local namespace registry.
RemoteNode	getRemoteNode(javax.jcr.Node node) Returns a remote adapter for the given local node.
RemoteNodeDefinition	getRemoteNodeDefinition(javax.jcr.nodetype.NodeDefinition def) Returns a remote adapter for the given local node definition.
RemoteIterator	getRemoteNodeIterator(javax.jcr.NodeIterator iterator) Returns a remote adapter for the given local node iterator.
RemoteNodeType	getRemoteNodeType(javax.jcr.nodetype.NodeType type) Returns a remote adapter for the given local node type.
RemoteIterator	getRemoteNodeTypeIterator(javax.jcr.nodetype.NodeTypeIterator iterator) Returns a remote adapter for the given local node type iterator.
RemoteNodeTypeManager	getRemoteNodeTypeManager(javax.jcr.nodetype.NodeTypeManager manager) Returns a remote adapter for the given local node type manager.
RemoteObservationManager	getRemoteObservationManager(javax.jcr.observation.ObservationManager observationManager) Returns a remote adapter for the given local observation manager.
RemotePrincipal	getRemotePrincipal(Principal principal) Returns a remote adapter for the given local access control manager.
RemoteIterator	getRemotePrincipalIterator(Iterator<Principal> principals) Returns a remote adapter for the given local access control manager.
RemotePrivilege	getRemotePrivilege(javax.jcr.security.Privilege local) Returns a remote adapter for the given local access control manager.
RemotePrivilege[]	getRemotePrivilege(javax.jcr.security.Privilege[] local) Returns a remote adapter for the given local access control manager.
RemoteProperty	getRemoteProperty(javax.jcr.Property property) Returns a remote adapter for the given local property.
RemotePropertyDefinition	getRemotePropertyDefinition(javax.jcr.nodetype.PropertyDefinition def) Returns a remote adapter for the given local property definition.
RemoteIterator	getRemotePropertyIterator(javax.jcr.PropertyIterator iterator) Returns a remote adapter for the given local property iterator.
RemoteQuery	getRemoteQuery(javax.jcr.query.Query query) Returns a remote adapter for the given local query.
RemoteQueryManager	getRemoteQueryManager(javax.jcr.Session session, javax.jcr.query.QueryManager manager) Returns a remote adapter for the given local query manager.
RemoteQueryResult	getRemoteQueryResult(javax.jcr.query.QueryResult result) Returns a remote adapter for the given local query result.
RemoteRepository	getRemoteRepository(javax.jcr.Repository repository) Returns a remote adapter for the given local repository.
RemoteRow	getRemoteRow(javax.jcr.query.Row row) Returns a remote adapter for the given local query row.
RemoteIterator	getRemoteRowIterator(javax.jcr.query.RowIterator iterator) Returns a remote adapter for the given local row iterator.
RemoteSession	getRemoteSession(javax.jcr.Session session) Returns a remote adapter for the given local session.
RemoteVersion	getRemoteVersion(javax.jcr.version.Version version) Returns a remote adapter for the given local version.
RemoteVersionHistory	getRemoteVersionHistory(javax.jcr.version.VersionHistory versionHistory) Returns a remote adapter for the given local version history.
RemoteIterator	getRemoteVersionIterator(javax.jcr.version.VersionIterator iterator) Returns a remote adapter for the given local version iterator.
RemoteVersionManager	getRemoteVersionManager(javax.jcr.Session session, javax.jcr.version.VersionManager versionManager)
RemoteWorkspace	getRemoteWorkspace(javax.jcr.Workspace workspace) Returns a remote adapter for the given local workspace.

Method Detail

getPortNumber

int getPortNumber()

Returns the port number to which the server objects created by this factory are bound. This method is mostly used internally by the ServerObject constructor to determine which port number to use.

Returns:

port number, or 0 for a random port

getRemoteRepository

RemoteRepository getRemoteRepository(javax.jcr.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

RemoteSession getRemoteSession(javax.jcr.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

RemoteWorkspace getRemoteWorkspace(javax.jcr.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

RemoteObservationManager getRemoteObservationManager(javax.jcr.observation.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

RemoteNamespaceRegistry getRemoteNamespaceRegistry(javax.jcr.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

RemoteNodeTypeManager getRemoteNodeTypeManager(javax.jcr.nodetype.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

RemoteItem getRemoteItem(javax.jcr.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

RemoteProperty getRemoteProperty(javax.jcr.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

RemoteNode getRemoteNode(javax.jcr.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

RemoteVersion getRemoteVersion(javax.jcr.version.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

RemoteVersionHistory getRemoteVersionHistory(javax.jcr.version.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

RemoteNodeType getRemoteNodeType(javax.jcr.nodetype.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

RemoteItemDefinition getRemoteItemDefinition(javax.jcr.nodetype.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

RemoteNodeDefinition getRemoteNodeDefinition(javax.jcr.nodetype.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

RemotePropertyDefinition getRemotePropertyDefinition(javax.jcr.nodetype.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

RemoteLock getRemoteLock(javax.jcr.lock.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

RemoteQueryManager getRemoteQueryManager(javax.jcr.Session session,
                                       javax.jcr.query.QueryManager manager)
                                         throws RemoteException

Returns a remote adapter for the given local query manager.

Parameters:

session - current session

manager - local query manager

Returns:

remote query manager adapter

Throws:

RemoteException - on RMI errors

getRemoteQuery

RemoteQuery getRemoteQuery(javax.jcr.query.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

RemoteQueryResult getRemoteQueryResult(javax.jcr.query.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

RemoteRow getRemoteRow(javax.jcr.query.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

RemoteEventCollection getRemoteEvent(long listenerId,
                                   javax.jcr.observation.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

getRemoteNodeIterator

RemoteIterator getRemoteNodeIterator(javax.jcr.NodeIterator iterator)
                                     throws RemoteException

Returns a remote adapter for the given local node iterator.

Parameters:

iterator - local node iterator

Returns:

remote iterator adapter

Throws:

RemoteException - on RMI errors

getRemotePropertyIterator

RemoteIterator getRemotePropertyIterator(javax.jcr.PropertyIterator iterator)
                                         throws RemoteException

Returns a remote adapter for the given local property iterator.

Parameters:

iterator - local property iterator

Returns:

remote iterator adapter

Throws:

RemoteException - on RMI errors

getRemoteVersionIterator

RemoteIterator getRemoteVersionIterator(javax.jcr.version.VersionIterator iterator)
                                        throws RemoteException

Returns a remote adapter for the given local version iterator.

Parameters:

iterator - local version iterator

Returns:

remote iterator adapter

Throws:

RemoteException - on RMI errors

getRemoteNodeTypeIterator

RemoteIterator getRemoteNodeTypeIterator(javax.jcr.nodetype.NodeTypeIterator iterator)
                                         throws RemoteException

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

Parameters:

iterator - local node type iterator

Returns:

remote iterator adapter

Throws:

RemoteException - on RMI errors

getRemoteRowIterator

RemoteIterator getRemoteRowIterator(javax.jcr.query.RowIterator iterator)
                                    throws RemoteException

Returns a remote adapter for the given local row iterator.

Parameters:

iterator - local row iterator

Returns:

remote iterator adapter

Throws:

RemoteException - on RMI errors

getRemoteLockManager

RemoteLockManager getRemoteLockManager(javax.jcr.lock.LockManager lockManager)
                                       throws RemoteException

Throws:

RemoteException

getRemoteVersionManager

RemoteVersionManager getRemoteVersionManager(javax.jcr.Session session,
                                           javax.jcr.version.VersionManager versionManager)
                                             throws RemoteException

Throws:

RemoteException

getRemoteAccessControlManager

RemoteAccessControlManager getRemoteAccessControlManager(javax.jcr.security.AccessControlManager acm)
                                                         throws RemoteException

Returns a remote adapter for the given local access control manager.

Parameters:

acm - local access control manager

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemotePrivilege

RemotePrivilege getRemotePrivilege(javax.jcr.security.Privilege local)
                                   throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemotePrivilege

RemotePrivilege[] getRemotePrivilege(javax.jcr.security.Privilege[] local)
                                     throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemoteAccessControlPolicy

RemoteAccessControlPolicy getRemoteAccessControlPolicy(javax.jcr.security.AccessControlPolicy local)
                                                       throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemoteAccessControlPolicy

RemoteAccessControlPolicy[] getRemoteAccessControlPolicy(javax.jcr.security.AccessControlPolicy[] local)
                                                         throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemoteAccessControlPolicyIterator

RemoteIterator getRemoteAccessControlPolicyIterator(javax.jcr.security.AccessControlPolicyIterator iterator)
                                                    throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemoteAccessControlEntry

RemoteAccessControlEntry getRemoteAccessControlEntry(javax.jcr.security.AccessControlEntry local)
                                                     throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemoteAccessControlEntry

RemoteAccessControlEntry[] getRemoteAccessControlEntry(javax.jcr.security.AccessControlEntry[] local)
                                                       throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemotePrincipal

RemotePrincipal getRemotePrincipal(Principal principal)
                                   throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors

getRemotePrincipalIterator

RemoteIterator getRemotePrincipalIterator(Iterator<Principal> principals)
                                          throws RemoteException

Returns a remote adapter for the given local access control manager.

Returns:

remote access control manager

Throws:

RemoteException - on RMI errors