Class LdifReader
- All Implemented Interfaces:
ResourceAwareItemReaderItemStream<org.springframework.ldap.core.LdapAttributes>
,ItemReader<org.springframework.ldap.core.LdapAttributes>
,ItemStream
,ItemStreamReader<org.springframework.ldap.core.LdapAttributes>
,org.springframework.beans.factory.InitializingBean
LdifReader
is an adaptation of the
FlatFileItemReader
built
around an LdifParser
.
Unlike the FlatFileItemReader
, the LdifReader
does not require a mapper.
Instead, this version of the LdifReader
simply returns an
LdapAttributes
object which can be consumed and manipulated as
necessary by ItemProcessor
or any
output service. Alternatively, the RecordMapper
interface can be
implemented and set in a MappingLdifReader
to map records to
objects for return.
LdifReader
usage is mimics that of the
FlatFileItemReader
for
all intensive purposes. Adjustments have been made to process records instead of lines,
however. As such, the recordsToSkip
attribute indicates the
number of records from the top of the file that should not be processed.
Implementations of the RecordCallbackHandler
interface
can be used to execute operations on those skipped records.
As with the FlatFileItemReader
, the strict
option differentiates between whether
or not to require the resource to exist before processing. In the case of a value set
to false, a warning is logged instead of an exception being thrown.
This reader is not thread-safe.
- Author:
- Keith Barlow, Mahmoud Ben Hassine
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
protected void
doClose()
Close the resources opened inAbstractItemCountingItemStreamItemReader.doOpen()
.protected void
doOpen()
Open resources necessary to start reading input.protected org.springframework.ldap.core.LdapAttributes
doRead()
Read next item from input.void
setRecordsToSkip
(int recordsToSkip) Public setter for the number of lines to skip at the start of a file.void
setResource
(org.springframework.core.io.Resource resource) Establishes the resource that will be used as the input for the LdifReader.void
setSkippedRecordsCallback
(RecordCallbackHandler skippedRecordsCallback) RecordCallbackHandler
implementations can be used to take action on skipped records.void
setStrict
(boolean strict) In strict mode the reader will throw an exception onAbstractItemCountingItemStreamItemReader.open(org.springframework.batch.item.ExecutionContext)
if the input resource does not exist.Methods inherited from class org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader
close, getCurrentItemCount, isSaveState, jumpToItem, open, read, setCurrentItemCount, setMaxItemCount, setSaveState, update
Methods inherited from class org.springframework.batch.item.ItemStreamSupport
getExecutionContextKey, getName, setExecutionContextName, setName
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.batch.item.ItemReader
read
Methods inherited from interface org.springframework.batch.item.ItemStream
close, open, update
-
Constructor Details
-
LdifReader
public LdifReader()
-
-
Method Details
-
setStrict
public void setStrict(boolean strict) In strict mode the reader will throw an exception onAbstractItemCountingItemStreamItemReader.open(org.springframework.batch.item.ExecutionContext)
if the input resource does not exist.- Parameters:
strict
- true by default
-
setSkippedRecordsCallback
RecordCallbackHandler
implementations can be used to take action on skipped records.- Parameters:
skippedRecordsCallback
- will be called for each one of the initial skipped lines before any items are read.
-
setRecordsToSkip
public void setRecordsToSkip(int recordsToSkip) Public setter for the number of lines to skip at the start of a file. Can be used if the file contains a header without useful (column name) information, and without a comment delimiter at the beginning of the lines.- Parameters:
recordsToSkip
- the number of lines to skip
-
doClose
Description copied from class:AbstractItemCountingItemStreamItemReader
Close the resources opened inAbstractItemCountingItemStreamItemReader.doOpen()
.- Specified by:
doClose
in classAbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes>
- Throws:
Exception
- Allows subclasses to throw checked exceptions for interpretation by the framework
-
doOpen
Description copied from class:AbstractItemCountingItemStreamItemReader
Open resources necessary to start reading input.- Specified by:
doOpen
in classAbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes>
- Throws:
Exception
- Allows subclasses to throw checked exceptions for interpretation by the framework
-
doRead
Description copied from class:AbstractItemCountingItemStreamItemReader
Read next item from input.- Specified by:
doRead
in classAbstractItemCountingItemStreamItemReader<org.springframework.ldap.core.LdapAttributes>
- Returns:
- an item or
null
if the data source is exhausted - Throws:
Exception
- Allows subclasses to throw checked exceptions for interpretation by the framework
-
setResource
public void setResource(org.springframework.core.io.Resource resource) Establishes the resource that will be used as the input for the LdifReader.- Specified by:
setResource
in interfaceResourceAwareItemReaderItemStream<org.springframework.ldap.core.LdapAttributes>
- Parameters:
resource
- the resource that will be read.
-
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
Exception
-