[CODEC-183] BaseNCodecOutputStream only supports writing EOF on close()

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.6
• Fix Version/s: 1.11

Environment

I'm running with version 1.6, but quick look shows it's present in 1.8.

• Assignee: Unassigned
• Reporter: Steven Wurster
• Created: 19/Mar/14 12:57
• Updated: 16/Nov/14 16:42
• Resolved: 16/Nov/14 16:42

Description

The only way to add the EOF marker when encoding or decoding with the BaseNCodecOutputStream is via the close() function. The flush() function does not perform this logic, and it is questionable whether or not it should.

The problem is that I want to write to a Base64OutputStream in the middle of writing to another stream. That is, I will write some content to a stream, then wrap that stream with a Base64OutputStream to write some more (encoded) content, and then finish writing directly to the original stream (and so not encoded). Calling flush() on the Base64OutputStream will not write the EOF marker, which means bytes can be lost. I do not want to call close() on the Base64OutputStream as that will propagate to my original stream, which I need to leave open.

Ideas for resolving this include the following:

• Adding a separate function for writing the final (EOF) bytes without an explicit close (hacky solution).
• Changing the visibility of various functions and members so that I can write my own descendant that provides the functionality I want. Note that the encode() and decode() functions on BaseNCodec used in the close() routine are package-private, and so I cannot call them within a descendant.