org.lsc.jndi

Class SimpleJndiSrcService

java.lang.Object

org.lsc.jndi.AbstractSimpleJndiService

org.lsc.jndi.SimpleJndiSrcService

All Implemented Interfaces:

Closeable, AutoCloseable, IService

Direct Known Subclasses:

PullableJndiSrcService, SyncReplSourceService

public class SimpleJndiSrcService
extends AbstractSimpleJndiService
implements IService

This class is a generic but configurable implementation to get data from the directory. You can specify where (baseDn) and what (filterId & attr) information will be read on which type of entries (filterAll and attrId). TODO implements JUnit test

Author:

Sebastien Bahloul <seb@lsc-project.org>

Constructor Summary

Constructors

Constructor and Description
SimpleJndiSrcService(Properties props, String beanClassName) Deprecated.
SimpleJndiSrcService(TaskType task) Constructor adapted to the context properties and the bean class name to instantiate.

Method Summary

Modifier and Type	Method and Description
IBean	getBean(String pivotName, LscDatasets pivotAttributes, boolean fromSameService) The simple object getter according to its identifier.
String	getFilterIdClean()
Map<String,LscDatasets>	getListPivots() Returns a list of all the objects' identifiers.

Methods inherited from class org.lsc.jndi.AbstractSimpleJndiService

close, get, getAttrs, getAttrsId, getBaseDn, getBeanFromSR, getFilterAll, getFilterId, getJndiServices

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleJndiSrcService

@Deprecated
public SimpleJndiSrcService(Properties props,
                                        String beanClassName)
                                 throws LscServiceConfigurationException

Deprecated.

Constructor adapted to the context properties and the bean class name to instantiate.

Parameters:

props - the properties used to identify the directory parameters and context

Throws:

LscServiceConfigurationException

SimpleJndiSrcService

public SimpleJndiSrcService(TaskType task)
                     throws LscServiceConfigurationException

Constructor adapted to the context properties and the bean class name to instantiate.

Parameters:

task - Initialized task containing all necessary pieces of information to initiate connection and load settings

Throws:

LscServiceConfigurationException

Method Detail

getBean

public IBean getBean(String pivotName,
                     LscDatasets pivotAttributes,
                     boolean fromSameService)
              throws LscServiceException

The simple object getter according to its identifier.

Specified by:

getBean in interface IService

Parameters:

pivotName - Name of the entry to be returned, which is the name returned by getListPivots() (used for display only)

pivotAttributes - Map of attribute names and values, which is the data identifier in the source such as returned by getListPivots(). It must identify a unique entry in the source.

fromSameService - are the pivot attributes provided by the same service

Returns:

The bean, or null if not found

Throws:

LscServiceException - May throw a NamingException if the object is not found in the directory, or if more than one object would be returned.

getListPivots

public Map<String,LscDatasets> getListPivots()
                                      throws LscServiceException

Returns a list of all the objects' identifiers.

Specified by:

getListPivots in interface IService

Returns:

Map of all entries names that are returned by the directory with an associated map of attribute names and values (never null)

Throws:

LscServiceException

NamingException - May throw a NamingException if an error occurs while searching the directory.

getFilterIdClean

public final String getFilterIdClean()