org.apache.jackrabbit.rmi.client

Interface LocalAdapterFactory

All Known Implementing Classes:

ClientAdapterFactory, JackrabbitClientAdapterFactory

public interface LocalAdapterFactory

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

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

See Also:

RemoteAdapterFactory, ClientAdapterFactory, ClientObject

Method Summary

Methods

Modifier and Type	Method and Description
javax.jcr.security.AccessControlEntry	getAccessControlEntry(RemoteAccessControlEntry remote) Factory method for creating a local adapter for a remote access control entry
javax.jcr.security.AccessControlEntry[]	getAccessControlEntry(RemoteAccessControlEntry[] remote) Factory method for creating an array of local adapter for an array of remote access control entry
javax.jcr.security.AccessControlManager	getAccessControlManager(RemoteAccessControlManager remote) Factory method for creating a local adapter for a remote access control manager
javax.jcr.security.AccessControlPolicy	getAccessControlPolicy(RemoteAccessControlPolicy remote) Factory method for creating a local adapter for a remote access control policy
javax.jcr.security.AccessControlPolicy[]	getAccessControlPolicy(RemoteAccessControlPolicy[] remote) Factory method for creating an array of local adapter for an array of remote access control policies
javax.jcr.security.AccessControlPolicyIterator	getAccessControlPolicyIterator(RemoteIterator remote) Factory method for creating a local adapter for a remote access control policy iterator
javax.jcr.Item	getItem(javax.jcr.Session session, RemoteItem remote) Factory method for creating a local adapter for a remote item.
javax.jcr.nodetype.ItemDefinition	getItemDef(RemoteItemDefinition remote) Factory method for creating a local adapter for a remote item definition.
javax.jcr.lock.Lock	getLock(javax.jcr.Session session, RemoteLock remote) Factory method for creating a local adapter for a remote lock.
javax.jcr.lock.LockManager	getLockManager(javax.jcr.Session session, RemoteLockManager lockManager)
javax.jcr.NamespaceRegistry	getNamespaceRegistry(RemoteNamespaceRegistry remote) Factory method for creating a local adapter for a remote namespace registry.
javax.jcr.Node	getNode(javax.jcr.Session session, RemoteNode remote) Factory method for creating a local adapter for a remote node.
javax.jcr.nodetype.NodeDefinition	getNodeDef(RemoteNodeDefinition remote) Factory method for creating a local adapter for a remote node definition.
javax.jcr.NodeIterator	getNodeIterator(javax.jcr.Session session, RemoteIterator remote) Factory method for creating a local adapter for a remote node iterator.
javax.jcr.nodetype.NodeType	getNodeType(RemoteNodeType remote) Factory method for creating a local adapter for a remote node type.
javax.jcr.nodetype.NodeTypeIterator	getNodeTypeIterator(RemoteIterator remote) Factory method for creating a local adapter for a remote node type iterator.
javax.jcr.nodetype.NodeTypeManager	getNodeTypeManager(RemoteNodeTypeManager remote) Factory method for creating a local adapter for a remote node type manager.
javax.jcr.observation.ObservationManager	getObservationManager(javax.jcr.Workspace workspace, RemoteObservationManager remote) Factory method for creating a local adapter for a remote observation manager.
Principal	getPrincipal(RemotePrincipal remote) Factory method for creating a local adapter for a remote principal.
Iterator<Principal>	getPrincipalIterator(RemoteIterator remote) Factory method for creating a local adapter for a remote principal iterator.
javax.jcr.security.Privilege	getPrivilege(RemotePrivilege remote) Factory method for creating a local adapter for a remote privilege
javax.jcr.security.Privilege[]	getPrivilege(RemotePrivilege[] remote) Factory method for creating an array of local adapter for an array of remote privilege
javax.jcr.Property	getProperty(javax.jcr.Session session, RemoteProperty remote) Factory method for creating a local adapter for a remote property.
javax.jcr.nodetype.PropertyDefinition	getPropertyDef(RemotePropertyDefinition remote) Factory method for creating a local adapter for a remote property definition.
javax.jcr.PropertyIterator	getPropertyIterator(javax.jcr.Session session, RemoteIterator remote) Factory method for creating a local adapter for a remote property iterator.
javax.jcr.query.Query	getQuery(javax.jcr.Session session, RemoteQuery remote) Factory method for creating a local adapter for a remote query.
javax.jcr.query.QueryManager	getQueryManager(javax.jcr.Session session, RemoteQueryManager remote) Factory method for creating a local adapter for a remote query manager.
javax.jcr.query.QueryResult	getQueryResult(javax.jcr.Session session, RemoteQueryResult remote) Factory method for creating a local adapter for a remote query result.
javax.jcr.Repository	getRepository(RemoteRepository remote) Factory method for creating a local adapter for a remote repository.
javax.jcr.query.Row	getRow(javax.jcr.Session session, RemoteRow remote) Factory method for creating a local adapter for a remote query row.
javax.jcr.query.RowIterator	getRowIterator(javax.jcr.Session session, RemoteIterator remote) Factory method for creating a local adapter for a remote row iterator.
javax.jcr.Session	getSession(javax.jcr.Repository repository, RemoteSession remote) Factory method for creating a local adapter for a remote session.
javax.jcr.version.Version	getVersion(javax.jcr.Session session, RemoteVersion remote) Factory method for creating a local adapter for a remote version.
javax.jcr.version.VersionHistory	getVersionHistory(javax.jcr.Session session, RemoteVersionHistory remote) Factory method for creating a local adapter for a remote version history.
javax.jcr.version.VersionIterator	getVersionIterator(javax.jcr.Session session, RemoteIterator remote) Factory method for creating a local adapter for a remote version iterator.
javax.jcr.version.VersionManager	getVersionManager(javax.jcr.Session session, RemoteVersionManager versionManager)
javax.jcr.Workspace	getWorkspace(javax.jcr.Session session, RemoteWorkspace remote) Factory method for creating a local adapter for a remote workspace.

Method Detail

getRepository

javax.jcr.Repository getRepository(RemoteRepository remote)

Factory method for creating a local adapter for a remote repository.

Parameters:

remote - remote repository

Returns:

local repository adapter

getSession

javax.jcr.Session getSession(javax.jcr.Repository repository,
                           RemoteSession remote)

Factory method for creating a local adapter for a remote session.

Parameters:

repository - current repository

remote - remote session

Returns:

local session adapter

getWorkspace

javax.jcr.Workspace getWorkspace(javax.jcr.Session session,
                               RemoteWorkspace remote)

Factory method for creating a local adapter for a remote workspace.

Parameters:

session - current session

remote - remote workspace

Returns:

local workspace adapter

getObservationManager

javax.jcr.observation.ObservationManager getObservationManager(javax.jcr.Workspace workspace,
                                                             RemoteObservationManager remote)

Factory method for creating a local adapter for a remote observation manager.

Parameters:

workspace - current workspace

remote - remote observation manager

Returns:

local observation manager adapter

getNamespaceRegistry

javax.jcr.NamespaceRegistry getNamespaceRegistry(RemoteNamespaceRegistry remote)

Factory method for creating a local adapter for a remote namespace registry.

Parameters:

remote - remote namespace registry

Returns:

local namespace registry adapter

getNodeTypeManager

javax.jcr.nodetype.NodeTypeManager getNodeTypeManager(RemoteNodeTypeManager remote)

Factory method for creating a local adapter for a remote node type manager.

Parameters:

remote - remote node type manager

Returns:

local node type manager adapter

getItem

javax.jcr.Item getItem(javax.jcr.Session session,
                     RemoteItem remote)

Factory method for creating a local adapter for a remote item. Note that before calling this method, the client may want to introspect the remote item reference to determine whether to use the getNode or getProperty method instead, as the adapter returned by this method will only cover the basic Item interface.

Parameters:

session - current session

remote - remote item

Returns:

local item adapter

getProperty

javax.jcr.Property getProperty(javax.jcr.Session session,
                             RemoteProperty remote)

Factory method for creating a local adapter for a remote property.

Parameters:

session - current session

remote - remote property

Returns:

local property adapter

getNode

javax.jcr.Node getNode(javax.jcr.Session session,
                     RemoteNode remote)

Factory method for creating a local adapter for a remote node.

Parameters:

session - current session

remote - remote node

Returns:

local node adapter

getVersion

javax.jcr.version.Version getVersion(javax.jcr.Session session,
                                   RemoteVersion remote)

Factory method for creating a local adapter for a remote version.

Parameters:

session - current session

remote - remote version

Returns:

local version adapter

getVersionHistory

javax.jcr.version.VersionHistory getVersionHistory(javax.jcr.Session session,
                                                 RemoteVersionHistory remote)

Factory method for creating a local adapter for a remote version history.

Parameters:

session - current session

remote - remote version history

Returns:

local version history adapter

getNodeType

javax.jcr.nodetype.NodeType getNodeType(RemoteNodeType remote)

Factory method for creating a local adapter for a remote node type.

Parameters:

remote - remote node type

Returns:

local node type adapter

getItemDef

javax.jcr.nodetype.ItemDefinition getItemDef(RemoteItemDefinition remote)

Factory method for creating a local adapter for a remote item definition. Note that before calling this method, the client may want to introspect the remote item definition to determine whether to use the getNodeDef or getPropertyDef method instead, as the adapter returned by this method will only cover the ItemDef base interface.

Parameters:

remote - remote item definition

Returns:

local item definition adapter

getNodeDef

javax.jcr.nodetype.NodeDefinition getNodeDef(RemoteNodeDefinition remote)

Factory method for creating a local adapter for a remote node definition.

Parameters:

remote - remote node definition

Returns:

local node definition adapter

getPropertyDef

javax.jcr.nodetype.PropertyDefinition getPropertyDef(RemotePropertyDefinition remote)

Factory method for creating a local adapter for a remote property definition.

Parameters:

remote - remote property definition

Returns:

local property definition adapter

getLock

javax.jcr.lock.Lock getLock(javax.jcr.Session session,
                          RemoteLock remote)

Factory method for creating a local adapter for a remote lock.

Parameters:

session - current session

remote - remote lock

Returns:

local lock adapter

getQueryManager

javax.jcr.query.QueryManager getQueryManager(javax.jcr.Session session,
                                           RemoteQueryManager remote)

Factory method for creating a local adapter for a remote query manager.

Parameters:

session - current session

remote - remote query manager

Returns:

local query manager adapter

getQuery

javax.jcr.query.Query getQuery(javax.jcr.Session session,
                             RemoteQuery remote)

Factory method for creating a local adapter for a remote query.

Parameters:

session - current session

remote - remote query

Returns:

local query adapter

getQueryResult

javax.jcr.query.QueryResult getQueryResult(javax.jcr.Session session,
                                         RemoteQueryResult remote)

Factory method for creating a local adapter for a remote query result.

Parameters:

session - current session

remote - remote query result

Returns:

local query result adapter

getRow

javax.jcr.query.Row getRow(javax.jcr.Session session,
                         RemoteRow remote)

Factory method for creating a local adapter for a remote query row.

Parameters:

session - current session

remote - remote query row

Returns:

local query row adapter

getNodeIterator

javax.jcr.NodeIterator getNodeIterator(javax.jcr.Session session,
                                     RemoteIterator remote)

Factory method for creating a local adapter for a remote node iterator.

Parameters:

session - current session

remote - remote node iterator

Returns:

local node iterator adapter

getPropertyIterator

javax.jcr.PropertyIterator getPropertyIterator(javax.jcr.Session session,
                                             RemoteIterator remote)

Factory method for creating a local adapter for a remote property iterator.

Parameters:

session - current session

remote - remote property iterator

Returns:

local property iterator adapter

getVersionIterator

javax.jcr.version.VersionIterator getVersionIterator(javax.jcr.Session session,
                                                   RemoteIterator remote)

Factory method for creating a local adapter for a remote version iterator.

Parameters:

session - current session

remote - remote version iterator

Returns:

local version iterator adapter

getNodeTypeIterator

javax.jcr.nodetype.NodeTypeIterator getNodeTypeIterator(RemoteIterator remote)

Factory method for creating a local adapter for a remote node type iterator.

Parameters:

remote - remote node type iterator

Returns:

local node type iterator adapter

getRowIterator

javax.jcr.query.RowIterator getRowIterator(javax.jcr.Session session,
                                         RemoteIterator remote)

Factory method for creating a local adapter for a remote row iterator.

Parameters:

session - current session

remote - remote row iterator

Returns:

local row iterator adapter

getLockManager

javax.jcr.lock.LockManager getLockManager(javax.jcr.Session session,
                                        RemoteLockManager lockManager)

getVersionManager

javax.jcr.version.VersionManager getVersionManager(javax.jcr.Session session,
                                                 RemoteVersionManager versionManager)

getAccessControlManager

javax.jcr.security.AccessControlManager getAccessControlManager(RemoteAccessControlManager remote)

Factory method for creating a local adapter for a remote access control manager

Parameters:

remote - remote access control manager

Returns:

local access control manager

getAccessControlPolicy

javax.jcr.security.AccessControlPolicy getAccessControlPolicy(RemoteAccessControlPolicy remote)

Factory method for creating a local adapter for a remote access control policy

Parameters:

remote - remote access control policy

Returns:

local access control policy

getAccessControlPolicy

javax.jcr.security.AccessControlPolicy[] getAccessControlPolicy(RemoteAccessControlPolicy[] remote)

Factory method for creating an array of local adapter for an array of remote access control policies

Parameters:

remote - array of remote access control policies

Returns:

array of local access control policies

getAccessControlPolicyIterator

javax.jcr.security.AccessControlPolicyIterator getAccessControlPolicyIterator(RemoteIterator remote)

Factory method for creating a local adapter for a remote access control policy iterator

Parameters:

remote - access control policy iterator

Returns:

local access control policy iterator

getAccessControlEntry

javax.jcr.security.AccessControlEntry getAccessControlEntry(RemoteAccessControlEntry remote)

Factory method for creating a local adapter for a remote access control entry

Parameters:

remote - remote access control entry

Returns:

local access control entry

getAccessControlEntry

javax.jcr.security.AccessControlEntry[] getAccessControlEntry(RemoteAccessControlEntry[] remote)

Factory method for creating an array of local adapter for an array of remote access control entry

Parameters:

remote - array of remote access control entry

Returns:

local array of access control entry

getPrincipal

Principal getPrincipal(RemotePrincipal remote)

Factory method for creating a local adapter for a remote principal.

If remote is a RemoteGroup the principal returned implements the java.security.acl.Group interface.

Parameters:

remote - principal

Returns:

local principal

getPrincipalIterator

Iterator<Principal> getPrincipalIterator(RemoteIterator remote)

Factory method for creating a local adapter for a remote principal iterator.

Each entry in the remote iterator which is a RemoteGroup will be provided as a principal implementing the java.security.acl.Group interface.

Parameters:

remote - remote principal iterator

Returns:

local principal iterator

getPrivilege

javax.jcr.security.Privilege getPrivilege(RemotePrivilege remote)

Factory method for creating a local adapter for a remote privilege

Parameters:

remote - remote privilege

Returns:

local privilege

getPrivilege

javax.jcr.security.Privilege[] getPrivilege(RemotePrivilege[] remote)

Factory method for creating an array of local adapter for an array of remote privilege

Parameters:

remote - array of remote privilege

Returns:

array of local privilege