Class MimeEntity

java.lang.Object

org.apache.james.mime4j.stream.MimeEntity

All Implemented Interfaces:

EntityStateMachine

class MimeEntity
extends Object
implements EntityStateMachine

Field Summary

Fields

Modifier and Type	Field	Description
protected static final ThreadLocal<SoftReference<BufferRecycler>>	_recyclerRef
private BodyDescriptor	body
private final BodyDescriptorBuilder	bodyDescBuilder
private final MimeConfig	config
private MimeBoundaryInputStream	currentMimePartStream
private LineReaderInputStreamAdaptor	dataStream
private boolean	endOfHeader
private final EntityState	endState
private Field	field
private final FieldBuilder	fieldBuilder
private int	headerCount
private final BufferedLineReaderInputStream	inbuffer
private final ByteArrayBuffer	linebuf
private int	lineCount
private final LineNumberSource	lineSource
private final DecodeMonitor	monitor
private RecursionMode	recursionMode
private EntityState	state
private byte[]	tmpbuf

Constructor Summary

Constructors

Constructor	Description
MimeEntity(LineNumberSource lineSource, InputStream instream, BodyDescriptorBuilder bodyDescBuilder)
MimeEntity(LineNumberSource lineSource, InputStream instream, FieldBuilder fieldBuilder, BodyDescriptorBuilder bodyDescBuilder)
MimeEntity(LineNumberSource lineSource, InputStream instream, MimeConfig config, BodyDescriptorBuilder bodyDescBuilder)
MimeEntity(LineNumberSource lineSource, InputStream instream, MimeConfig config, EntityState startState, EntityState endState, DecodeMonitor monitor, FieldBuilder fieldBuilder, BodyDescriptorBuilder bodyDescBuilder)

Method Summary

Modifier and Type	Method	Description
EntityStateMachine	advance()	Advances the state machine to the next state in the process of the MIME stream parsing.
private void	advanceToBoundary()
private void	clearMimePartStream()
private void	createMimePartStream()
private InputStream	decodedStream(InputStream instream)
BodyDescriptor	getBodyDescriptor()	Gets a descriptor for the current entity.
static BufferRecycler	getBufferRecycler()
InputStream	getContentStream()	Returns content stream of the entity body.
private LineReaderInputStream	getDataStream()
InputStream	getDecodedContentStream()	Returns the decoded content stream of the entity body.
Field	getField()	This method is valid, if getState() returns EntityState.T_FIELD.
private InputStream	getLimitedContentStream()
private int	getLineNumber()
RecursionMode	getRecursionMode()
EntityState	getState()	Return the current state of the entity.
protected String	message(Event event)	Creates an indicative message suitable for display based on the given event and the current state of the system.
protected void	monitor(Event event)
protected boolean	nextField()
private EntityStateMachine	nextMessage()
private EntityStateMachine	nextMimeEntity()
private EntityStateMachine	nextMimeEntity(EntityState startState, EntityState endState, InputStream instream)
private void	readRawField()
void	setRecursionMode(RecursionMode recursionMode)	Sets the current recursion mode.
static String	stateToString(EntityState state)	Renders a state as a string suitable for logging.
void	stop()
void	stopSoft()
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_recyclerRef

protected static final ThreadLocal<SoftReference<BufferRecycler>> _recyclerRef

endState

private final EntityState endState

config

private final MimeConfig config

monitor

private final DecodeMonitor monitor

fieldBuilder

private final FieldBuilder fieldBuilder

bodyDescBuilder

private final BodyDescriptorBuilder bodyDescBuilder

linebuf

private final ByteArrayBuffer linebuf

lineSource

private final LineNumberSource lineSource

inbuffer

private final BufferedLineReaderInputStream inbuffer

state

private EntityState state

lineCount

private int lineCount

endOfHeader

private boolean endOfHeader

headerCount

private int headerCount

field

private Field field

body

private BodyDescriptor body

recursionMode

private RecursionMode recursionMode

currentMimePartStream

private MimeBoundaryInputStream currentMimePartStream

dataStream

private LineReaderInputStreamAdaptor dataStream

tmpbuf

private byte[] tmpbuf

Constructor Details

MimeEntity

MimeEntity(LineNumberSource lineSource,
 InputStream instream,
 MimeConfig config,
 EntityState startState,
 EntityState endState,
 DecodeMonitor monitor,
 FieldBuilder fieldBuilder,
 BodyDescriptorBuilder bodyDescBuilder)

MimeEntity

MimeEntity(LineNumberSource lineSource,
 InputStream instream,
 MimeConfig config,
 BodyDescriptorBuilder bodyDescBuilder)

MimeEntity

MimeEntity(LineNumberSource lineSource,
 InputStream instream,
 FieldBuilder fieldBuilder,
 BodyDescriptorBuilder bodyDescBuilder)

MimeEntity

MimeEntity(LineNumberSource lineSource,
 InputStream instream,
 BodyDescriptorBuilder bodyDescBuilder)

Method Details

getBufferRecycler

public static BufferRecycler getBufferRecycler()

getState

public EntityState getState()

Description copied from interface: EntityStateMachine

Return the current state of the entity.

Specified by:

getState in interface EntityStateMachine

Returns:

current state

See Also:

• EntityState

getRecursionMode

public RecursionMode getRecursionMode()

setRecursionMode

public void setRecursionMode(RecursionMode recursionMode)

Description copied from interface: EntityStateMachine

Sets the current recursion mode. The recursion mode specifies the approach taken to parsing parts. RecursionMode.M_RAW mode does not parse the part at all. RecursionMode.M_RECURSE mode recursively parses each mail when an message/rfc822 part is encounted; RecursionMode.M_NO_RECURSE does not.

Specified by:

setRecursionMode in interface EntityStateMachine

Parameters:

recursionMode -

See Also:

• RecursionMode

stop

public void stop()

stopSoft

public void stopSoft()

getLineNumber

private int getLineNumber()

getDataStream

private LineReaderInputStream getDataStream()

message

protected String message(Event event)

Creates an indicative message suitable for display based on the given event and the current state of the system.

Parameters:

event - Event, not null

Returns:

message suitable for use as a message in an exception or for logging

monitor

protected void monitor(Event event)
                throws MimeException,
IOException

Throws:

MimeException

IOException

readRawField

private void readRawField()
                   throws IOException,
MimeException

Throws:

IOException

MimeException

nextField

protected boolean nextField()
                     throws MimeException,
IOException

Throws:

MimeException

IOException

advance

public EntityStateMachine advance()
                           throws IOException,
MimeException

Description copied from interface: EntityStateMachine

Advances the state machine to the next state in the process of the MIME stream parsing. This method may return an new state machine that represents an embedded entity, which must be parsed before the parsing process of the current entity can proceed.

Specified by:

advance in interface EntityStateMachine

Returns:

a state machine of an embedded entity, if encountered, null otherwise.

Throws:

IOException - if an I/O error occurs.

MimeException - if the message can not be processed due to the MIME specification violation.

createMimePartStream

private void createMimePartStream()
                           throws MimeException,
IOException

Throws:

MimeException

IOException

clearMimePartStream

private void clearMimePartStream()

advanceToBoundary

private void advanceToBoundary()
                        throws IOException

Throws:

IOException

nextMessage

private EntityStateMachine nextMessage()

decodedStream

private InputStream decodedStream(InputStream instream)

nextMimeEntity

private EntityStateMachine nextMimeEntity()

nextMimeEntity

private EntityStateMachine nextMimeEntity(EntityState startState,
 EntityState endState,
 InputStream instream)

getLimitedContentStream

private InputStream getLimitedContentStream()

getBodyDescriptor

public BodyDescriptor getBodyDescriptor()

Gets a descriptor for the current entity. This method is valid if getState() returns:

• EntityState.T_BODY
• EntityState.T_START_MULTIPART
• EntityState.T_EPILOGUE
• EntityState.T_PREAMBLE

Specified by:

getBodyDescriptor in interface EntityStateMachine

Returns:

BodyDescriptor, not nulls

getField

public Field getField()

This method is valid, if getState() returns EntityState.T_FIELD.

Specified by:

getField in interface EntityStateMachine

Returns:

String with the fields raw contents.

Throws:

IllegalStateException - getState() returns another value than EntityState.T_FIELD.

getContentStream

public InputStream getContentStream()

Description copied from interface: EntityStateMachine

Returns content stream of the entity body.

Specified by:

getContentStream in interface EntityStateMachine

Returns:

input stream

See Also:

• EntityStateMachine.getContentStream()

getDecodedContentStream

public InputStream getDecodedContentStream()
                                    throws IllegalStateException

Description copied from interface: EntityStateMachine

Returns the decoded content stream of the entity body.

Specified by:

getDecodedContentStream in interface EntityStateMachine

Returns:

input stream

Throws:

IllegalStateException - if the content stream cannot be obtained at the current stage of the parsing process.

See Also:

• EntityStateMachine.getDecodedContentStream()

toString

public String toString()

Overrides:

toString in class Object

stateToString

public static String stateToString(EntityState state)

Renders a state as a string suitable for logging.

Parameters:

state -

Returns:

rendered as string, not null