org.lsc.service

Interface IService

All Known Subinterfaces:

IAsynchronousService, IJndiWritableService, IWritableService, IXAWritableService

All Known Implementing Classes:

AbstractJdbcDstService, AbstractJdbcService, ActiveDirectoryDstService, EmptyJndiDstService, FullDNJndiDstService, GoogleAppsService, MultipleDstService, PullableJndiSrcService, SimpleJdbcDstService, SimpleJdbcSrcService, SimpleJndiDstService, SimpleJndiFakeDstService, SimpleJndiSrcService, SyncReplSourceService, XAJdbcDstService, XALdifDstService

public interface IService

Interface used by services.

This interface must be implemented by a class to be considered a service.

Optionally, the service may also implement a constructor, which will be called once before a synchronization begins. This constructor may accept a Properties object as a parameter, which will be filled with properties from the lsc.properties file.

The returned bean type will be determined while calling constructor

Author:

Rémy-Christophe Schermesser

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getBean

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

The simple object getter according to its identifier.

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:

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

LscServiceException

getListPivots

Map<String,LscDatasets> getListPivots()
                               throws LscServiceException

Returns a list of all the objects' identifiers.

Returns:

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

Throws:

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

LscServiceException