org.lsc.jndi

Class SimpleJndiDstService

java.lang.Object

org.lsc.jndi.AbstractSimpleJndiService

org.lsc.jndi.SimpleJndiDstService

All Implemented Interfaces:

Closeable, AutoCloseable, IService, IWritableService

Direct Known Subclasses:

ActiveDirectoryDstService, SimpleJndiFakeDstService

public class SimpleJndiDstService
extends AbstractSimpleJndiService
implements IWritableService

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

Author:

Sebastien Bahloul <seb@lsc-project.org>

Constructor Summary

Constructors

Constructor and Description
SimpleJndiDstService(LdapServiceType ldapService, List<String> writableDatasetIds, Class<IBean> beanClass)
SimpleJndiDstService(TaskType task) Constructor adapted to the context properties and the bean class name to instantiate.

Method Summary

Modifier and Type	Method and Description
boolean	apply(JndiModifications jm) Apply directory modifications.
boolean	apply(LscModifications lm) Apply directory modifications.
IBean	getBean(String pivotName, LscDatasets pivotAttributes, boolean fromSameService) The simple object getter according to its identifier.
Map<String,LscDatasets>	getListPivots() Returns a list of all the objects' identifiers.
List<String>	getWriteDatasetIds()

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

SimpleJndiDstService

public SimpleJndiDstService(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:

LscServiceException

LscServiceConfigurationException

SimpleJndiDstService

public SimpleJndiDstService(LdapServiceType ldapService,
                            List<String> writableDatasetIds,
                            Class<IBean> beanClass)
                     throws LscServiceConfigurationException

Parameters:

ldapService -

writableDatasetIds -

beanClass -

Throws:

LscServiceException

LscServiceConfigurationException

Method Detail

getBean

public final 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 - May throw a NamingException if an error occurs while searching the directory.

apply

public boolean apply(JndiModifications jm)
              throws LscServiceCommunicationException

Apply directory modifications.

Parameters:

jm - Modifications to apply in a JndiModifications object.

Returns:

Operation status

Throws:

CommunicationException - If the connection to the service is lost, and all other attempts to use this service should fail.

LscServiceCommunicationException

apply

public boolean apply(LscModifications lm)
              throws LscServiceException

Apply directory modifications.

Specified by:

apply in interface IWritableService

Parameters:

lm - Modifications to apply in a JndiModifications object.

Returns:

Operation status

Throws:

CommunicationException - If the connection to the service is lost, and all other attempts to use this service should fail.

LscServiceException - thrown if an error is encountered

getWriteDatasetIds

public List<String> getWriteDatasetIds()

Specified by:

getWriteDatasetIds in interface IWritableService