InMemoryLookup (org.cristalise:cristalise-inmemory-lookup:3.7.0)

org.cristalise.lookup.lite.InMemoryLookup

All Implemented Interfaces and Traits:

Lookup
```
@CompileStatic
abstract class InMemoryLookup
extends ClusterStorage
```
This file is part of the CRISTAL-iSE kernel. Copyright (c) 2001-2015 The CRISTAL Consortium. All rights reserved. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. http://www.fsf.org/licensing/licenses/lgpl.html

Properties Summary

Properties
Type	Name and description
`MemoryOnlyClusterStorage`	`propertyStore`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`clear()`
	`void`	`close()` Shutdown the lookup
	`boolean`	`exists(Path path)` Checks if a particular Path exists in the directory
	`String`	`getAgentName(AgentPath agentPath)`
	`AgentPath`	`getAgentPath(String agentName)`
	`AgentPath[]`	`getAgents(RolePath role)`
	`PagedResult`	`getAgents(RolePath rolePath, int offset, int limit)`
	`PagedResult`	`getChildren(Path path, int offset, int limit)`
	`Iterator<Path>`	`getChildren(Path path)`
	`String`	`getIOR(Path path)` Resolve a path to a CORBA Object Item or Agent
	`ItemPath`	`getItemPath(String sysKey)` Fetch the correct subclass class of ItemPath for a particular Item, derived from its lookup entry.
	`RolePath`	`getRolePath(String roleName)`
	`RolePath[]`	`getRoles(AgentPath agent)`
	`PagedResult`	`getRoles(AgentPath agentPath, int offset, int limit)`
	`boolean`	`hasRole(AgentPath agent, RolePath role)`
	`void`	`open(Authenticator user)` Connect to the directory using the credentials supplied in the Authenticator.
	`ItemPath`	`resolvePath(DomainPath domainPath)` Find the ItemPath for which a DomainPath is an alias.
	`Iterator<Path>`	`search(Path start, String name)`
	`Iterator<Path>`	`search(Path start, Property... props)`
	`Iterator<Path>`	`search(Path start, PropertyDescriptionList props)`
	`PagedResult`	`search(Path start, List<Property> props, int offset, int limit)`
	`PagedResult`	`search(Path start, PropertyDescriptionList props, int offset, int limit)`
	`Iterator<Path>`	`searchAliases(ItemPath itemPath)`
	`PagedResult`	`searchAliases(ItemPath itemPath, int offset, int limit)`

- Property Detail
  - @Delegate MemoryOnlyClusterStorage propertyStore
- Method Detail
  - void clear()
  - @Override void close()
    
    Shutdown the lookup
  - @Override boolean exists(Path path)
    
    Checks if a particular Path exists in the directory
    Parameters:
    path - The path to check
    Returns:
    boolean true if the path exists, false if it doesn't
  - @Override String getAgentName(AgentPath agentPath)
  - @Override AgentPath getAgentPath(String agentName)
  - @Override AgentPath[] getAgents(RolePath role)
  - @Override PagedResult getAgents(RolePath rolePath, int offset, int limit)
  - @Override PagedResult getChildren(Path path, int offset, int limit)
  - @Override Iterator<Path> getChildren(Path path)
  - @Override String getIOR(Path path)
    
    Resolve a path to a CORBA Object Item or Agent
    throws:
    ObjectNotFoundException When the Path doesn't exist, or doesn't have an IOR associated with it
    
    Parameters:
    path - The path to be resolved
    Returns:
    The CORBA Object
  - @Override ItemPath getItemPath(String sysKey)
    
    Fetch the correct subclass class of ItemPath for a particular Item, derived from its lookup entry. This is used by the CORBA Server to make sure the correct Item subclass is used.
    throws:
    InvalidItemPathException When the system key is invalid/out-of-range
    throws:
    ObjectNotFoundException When the Item does not exist in the directory.
    
    Parameters:
    sysKey - The system key of the Item
    Returns:
    an ItemPath or AgentPath
  - @Override RolePath getRolePath(String roleName)
  - @Override RolePath[] getRoles(AgentPath agent)
  - @Override PagedResult getRoles(AgentPath agentPath, int offset, int limit)
  - @Override boolean hasRole(AgentPath agent, RolePath role)
  - @Override void open(Authenticator user)
    
    Connect to the directory using the credentials supplied in the Authenticator.
    Parameters:
    user - The connected Authenticator. The Lookup implementation may use the AuthObject in this to communicate with the database.
  - @Override ItemPath resolvePath(DomainPath domainPath)
    
    Find the ItemPath for which a DomainPath is an alias.
    throws:
    InvalidItemPathException
    throws:
    ObjectNotFoundException
    
    Parameters:
    domainPath - The path to resolve
    Returns:
    The ItemPath it points to (should be an AgentPath if the path references an Agent)
  - @Override Iterator<Path> search(Path start, String name)
  - @Override Iterator<Path> search(Path start, Property... props)
  - @Override Iterator<Path> search(Path start, PropertyDescriptionList props)
  - @Override PagedResult search(Path start, List<Property> props, int offset, int limit)
  - @Override PagedResult search(Path start, PropertyDescriptionList props, int offset, int limit)
  - @Override Iterator<Path> searchAliases(ItemPath itemPath)
  - @Override PagedResult searchAliases(ItemPath itemPath, int offset, int limit)

Summary:
Property
Method

| Detail:
Property
Method

org.cristalise:cristalise-inmemory-lookup:3.7.0

[Groovy] Class InMemoryLookup

Properties Summary

Methods Summary

Property Detail

@Delegate MemoryOnlyClusterStorage propertyStore

Method Detail

void clear()

@Override void close()

@Override boolean exists(Path path)

@Override String getAgentName(AgentPath agentPath)

@Override AgentPath getAgentPath(String agentName)

@Override AgentPath[] getAgents(RolePath role)

@Override PagedResult getAgents(RolePath rolePath, int offset, int limit)

@Override PagedResult getChildren(Path path, int offset, int limit)

@Override Iterator<Path> getChildren(Path path)

@Override String getIOR(Path path)

@Override ItemPath getItemPath(String sysKey)

@Override RolePath getRolePath(String roleName)

@Override RolePath[] getRoles(AgentPath agent)

@Override PagedResult getRoles(AgentPath agentPath, int offset, int limit)

@Override boolean hasRole(AgentPath agent, RolePath role)

@Override void open(Authenticator user)

@Override ItemPath resolvePath(DomainPath domainPath)

@Override Iterator<Path> search(Path start, String name)

@Override Iterator<Path> search(Path start, Property... props)

@Override Iterator<Path> search(Path start, PropertyDescriptionList props)

@Override PagedResult search(Path start, List<Property> props, int offset, int limit)

@Override PagedResult search(Path start, PropertyDescriptionList props, int offset, int limit)

@Override Iterator<Path> searchAliases(ItemPath itemPath)

@Override PagedResult searchAliases(ItemPath itemPath, int offset, int limit)