Package com.simplicite.util.integration
Class SimpleAdapter
- java.lang.Object
-
- com.simplicite.util.integration.SimpleAdapter
-
- All Implemented Interfaces:
AdapterInterface
,java.io.Serializable
- Direct Known Subclasses:
LineBasedAdapter
,SAXParserAdapter
,SimpleJSONAdapter
,SimpleScriptedAdapter
,SimpleSQLAdapter
,SimpleXLSAdapter
,SimpleXLSXAdapter
public abstract class SimpleAdapter extends java.lang.Object implements AdapterInterface, java.io.Serializable
Abstract class for generic adapter based on textual data- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SimpleAdapter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
append(java.lang.String data)
Append data as a new linevoid
appendError(java.lang.String data)
Append one error record in a new line (if the Error writer exists)void
appendError(java.lang.Throwable e)
Append one error record from throwable in a new line (if the Error writer exists)void
appendLog(char level, long lineNumber, java.lang.String data)
Append one log in a new line (if the Log writer exists)void
appendLog(java.lang.String data)
Append one log in a new line (if the Log writer exists)void
close()
Close the adapter streamsvoid
directProcess()
Called each N lines in direct mode, by default is flushes outputboolean
getBooleanParameter(java.lang.String param)
Get adapter boolean parameterboolean
getBooleanParameter(java.lang.String param, boolean def)
Get adapter boolean parameter with default valueConsole
getConsole()
Get consolejava.io.OutputStream
getErrorStream()
Get optional error stream, to send errors or any specific/rejected data for any future retryjava.io.PrintWriter
getErrorWriter()
Get optional error writer, to send errors or any specific/rejected data for any future retryGrant
getGrant()
Get adapter grantjava.io.BufferedReader
getInputReader()
Get data readerjava.io.InputStream
getInputStream()
Get input data streamint
getIntParameter(java.lang.String param)
Get adapter integer parameterint
getIntParameter(java.lang.String param, int def)
Get adapter integer parameter with default valuejava.io.OutputStream
getLogStream()
Get optional log stream, to send any end-user trace, logs, errorsjava.io.PrintWriter
getLogWriter()
Get optional log writer, to send any end-user trace, logs, errorslong
getLongParameter(java.lang.String param)
Get adapter long integer parameterlong
getLongParameter(java.lang.String param, long def)
Get adapter long integer parameter with default valuejava.lang.String
getName()
Get adapter namejava.lang.String
getOrigin()
Get data originjava.io.OutputStream
getOutputStream()
Get output data streamjava.io.PrintWriter
getOutputWriter()
Get output data writerjava.lang.Object
getParameter(java.lang.String param)
Get adapter parameterjava.lang.Object
getParameter(java.lang.String param, java.lang.Object def)
Get adapter parameter with optional default valuejava.util.Map<java.lang.String,java.lang.Object>
getParameters()
Get adapter parametersint
getProcessCount()
Get processing countchar
getStatus()
Get adapter statusjava.lang.String
getTrackingId()
Get tracking Idvoid
init(java.lang.String name, Grant grant, java.io.InputStream inStream, java.io.OutputStream outStream, java.io.OutputStream errStream, java.io.OutputStream logStream, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String trackId, java.lang.String origin)
Adapter initializationvoid
postProcess()
Called after processing lines, by default it sends the XML footer to outputjava.lang.String
preProcess()
Called before processing lines, by default it sends the XML header to outputvoid
setConsole(Console console)
Set consolevoid
setErrorStream(java.io.OutputStream es)
Set error data streamvoid
setInputData(byte[] data)
Set input data byte arrayvoid
setInputStream(java.io.InputStream is)
Set input data streamvoid
setLogStream(java.io.OutputStream ls)
Set log streamvoid
setOutputStream(java.io.OutputStream os)
Set output data streamvoid
setParameter(java.lang.String param, boolean value)
Set adapter parametervoid
setParameter(java.lang.String param, int value)
Set adapter parametervoid
setParameter(java.lang.String param, long value)
Set adapter parametervoid
setParameter(java.lang.String param, java.lang.Object value)
Set adapter parametervoid
setProcessCount(int processCount)
Set processing countvoid
setStatus(char status)
Set adapter status-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.simplicite.util.integration.AdapterInterface
process
-
-
-
-
Method Detail
-
getName
public java.lang.String getName()
Get adapter name
-
getGrant
public Grant getGrant()
Get adapter grant
-
getConsole
public Console getConsole()
Get console- Specified by:
getConsole
in interfaceAdapterInterface
- Returns:
- Console
-
setConsole
public void setConsole(Console console)
Set console- Specified by:
setConsole
in interfaceAdapterInterface
- Parameters:
console
- Console
-
getInputStream
public java.io.InputStream getInputStream()
Get input data stream- Specified by:
getInputStream
in interfaceAdapterInterface
- Returns:
- Input data stream
-
setInputStream
public void setInputStream(java.io.InputStream is)
Set input data stream- Parameters:
is
- Input data stream
-
setInputData
public void setInputData(byte[] data)
Set input data byte array- Parameters:
data
- Data
-
getInputReader
public java.io.BufferedReader getInputReader()
Get data reader
-
getOutputStream
public java.io.OutputStream getOutputStream()
Get output data stream- Specified by:
getOutputStream
in interfaceAdapterInterface
- Returns:
- Output data stream
-
setOutputStream
public void setOutputStream(java.io.OutputStream os)
Set output data stream- Parameters:
os
- Output stream
-
getOutputWriter
public java.io.PrintWriter getOutputWriter()
Get output data writer- Returns:
- Output data writer
-
setProcessCount
public void setProcessCount(int processCount)
Set processing count- Parameters:
processCount
- Processing count (0 means no processing count, all data is processed at the end)
-
getProcessCount
public int getProcessCount()
Get processing count- Returns:
- Processing count (0 means no processing count, all data is processed at the end)
-
append
public void append(java.lang.String data)
Append data as a new line- Parameters:
data
- Data
-
getStatus
public char getStatus()
Get adapter status- Specified by:
getStatus
in interfaceAdapterInterface
- Returns:
- Status (one of XMLSupervisor.STATUS_*)
-
setStatus
public void setStatus(char status)
Set adapter status- Specified by:
setStatus
in interfaceAdapterInterface
- Parameters:
status
- Status (one of XMLSupervisor.STATUS_*)
-
getTrackingId
public java.lang.String getTrackingId()
Get tracking Id
-
getOrigin
public java.lang.String getOrigin()
Get data origin
-
getParameters
public java.util.Map<java.lang.String,java.lang.Object> getParameters()
Get adapter parameters- Returns:
- Parameters
-
getParameter
public java.lang.Object getParameter(java.lang.String param)
Get adapter parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value
-
getParameter
public java.lang.Object getParameter(java.lang.String param, java.lang.Object def)
Get adapter parameter with optional default value- Parameters:
param
- Parameter namedef
- Default value- Returns:
- Parameter value
-
getBooleanParameter
public boolean getBooleanParameter(java.lang.String param)
Get adapter boolean parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value
-
getBooleanParameter
public boolean getBooleanParameter(java.lang.String param, boolean def)
Get adapter boolean parameter with default value- Parameters:
param
- Parameter namedef
- Default value- Returns:
- Parameter value
-
getIntParameter
public int getIntParameter(java.lang.String param)
Get adapter integer parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value
-
getIntParameter
public int getIntParameter(java.lang.String param, int def)
Get adapter integer parameter with default value- Parameters:
param
- Parameter namedef
- Default value- Returns:
- Parameter value
-
getLongParameter
public long getLongParameter(java.lang.String param)
Get adapter long integer parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value
-
getLongParameter
public long getLongParameter(java.lang.String param, long def)
Get adapter long integer parameter with default value- Parameters:
param
- Parameter namedef
- Default value- Returns:
- Parameter value
-
setParameter
public void setParameter(java.lang.String param, java.lang.Object value)
Set adapter parameter- Parameters:
param
- Parameter namevalue
- Parameter value
-
setParameter
public void setParameter(java.lang.String param, boolean value)
Set adapter parameter- Parameters:
param
- Parameter namevalue
- Parameter boolean value
-
setParameter
public void setParameter(java.lang.String param, int value)
Set adapter parameter- Parameters:
param
- Parameter namevalue
- Parameter integer value
-
setParameter
public void setParameter(java.lang.String param, long value)
Set adapter parameter- Parameters:
param
- Parameter namevalue
- Parameter long integer value
-
getErrorStream
public java.io.OutputStream getErrorStream()
Get optional error stream, to send errors or any specific/rejected data for any future retry- Specified by:
getErrorStream
in interfaceAdapterInterface
- Returns:
- Error stream
-
setErrorStream
public void setErrorStream(java.io.OutputStream es)
Set error data stream- Parameters:
es
- Error stream
-
getErrorWriter
public java.io.PrintWriter getErrorWriter()
Get optional error writer, to send errors or any specific/rejected data for any future retry- Returns:
- Error writer
-
appendError
public void appendError(java.lang.String data)
Append one error record in a new line (if the Error writer exists)- Parameters:
data
- Data
-
appendError
public void appendError(java.lang.Throwable e)
Append one error record from throwable in a new line (if the Error writer exists)- Parameters:
e
- Throwable
-
getLogStream
public java.io.OutputStream getLogStream()
Get optional log stream, to send any end-user trace, logs, errors- Specified by:
getLogStream
in interfaceAdapterInterface
- Returns:
- Log stream
-
setLogStream
public void setLogStream(java.io.OutputStream ls)
Set log stream- Parameters:
ls
- Log stream
-
getLogWriter
public java.io.PrintWriter getLogWriter()
Get optional log writer, to send any end-user trace, logs, errors- Returns:
- Log writer
-
appendLog
public void appendLog(char level, long lineNumber, java.lang.String data)
Append one log in a new line (if the Log writer exists)- Parameters:
level
- levellineNumber
- Line numberdata
- Data
-
appendLog
public void appendLog(java.lang.String data)
Append one log in a new line (if the Log writer exists)- Parameters:
data
- Data
-
init
public void init(java.lang.String name, Grant grant, java.io.InputStream inStream, java.io.OutputStream outStream, java.io.OutputStream errStream, java.io.OutputStream logStream, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String trackId, java.lang.String origin)
Adapter initialization- Specified by:
init
in interfaceAdapterInterface
- Parameters:
name
- Adapter namegrant
- User rightsinStream
- Input stream of dataoutStream
- Output stream of XMLerrStream
- Optional error stream for rejected incoming datalogStream
- Optional stream to log info, errors...params
- Adapter parameterstrackId
- Tracking IDorigin
- Origin of data
-
preProcess
public java.lang.String preProcess()
Called before processing lines, by default it sends the XML header to output- Specified by:
preProcess
in interfaceAdapterInterface
- Returns:
- Error code to stop, or null to continue
-
directProcess
public void directProcess() throws PlatformException
Called each N lines in direct mode, by default is flushes output- Throws:
PlatformException
-
postProcess
public void postProcess()
Called after processing lines, by default it sends the XML footer to output- Specified by:
postProcess
in interfaceAdapterInterface
-
close
public void close()
Close the adapter streams- Specified by:
close
in interfaceAdapterInterface
-
-