OpenFileForWriting

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.3.1.5

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.file
Event OpenFileForWriting

The OpenFileForWriting event is a signal to the FileAdapter to open the file specified in order to write events to it.

A FileHandle event will be sent back if the file has been opened successfully. It will be in response to the requestId specified here, and will contain the sessionId used for the file.

Subsequent file line events generated from this file and sent to the correlator will reference this ID.

For Fixed Width files, the optional members fieldLength, isLeftAligned and pad character must be specified. These will be mapped to the payload when being sent to the adapter. Subsequent Write line events are responsible for ensuring that the data contained within them is capable of being written in accordance to the widths supplied.

Member summary
`string`	`transportName` The name of the transport being used within the file adapter.
`integer`	`requestId` Request ID for this open file event. The response will contain this ID.
`string`	`codec` The name of the codec to use with the file. This should match one of the codecs specified in the (static) config file. Use the null codec (by default this is called JNullCodec) to write entire lines.
`string`	`filename` Full filename to write to.
`boolean`	`appendData` Boolean representing whether file is to be overwritten or appended to.
`dictionary<string, string>`	`payload` Additional payload items.

Member detail

appendData

boolean appendData

Boolean representing whether file is to be overwritten or appended to.

codec

string codec

The name of the codec to use with the file. This should match one of the codecs specified in the (static) config file. Use the null codec (by default this is called JNullCodec) to write entire lines.

filename

string filename

Full filename to write to.

payload

dictionary<string, string> payload

Additional payload items.

requestId

integer requestId

Request ID for this open file event. The response will contain this ID.

transportName

string transportName

The name of the transport being used within the file adapter.