org.neo4j.server.rest.transactional

Class ExecutionResultSerializer

java.lang.Object

org.neo4j.server.rest.transactional.ExecutionResultSerializer

public class ExecutionResultSerializer
extends Object

Writes directly to an output stream, therefore implicitly stateful. Methods must be invoked in the correct order, as follows:

• transactionId?
• statementResult*
• errors?
• transactionStatus(long expiryDate)?
• finish

Where ? means invoke at most once, and * means invoke zero or more times.

Constructor Summary

Constructors

Constructor and Description
ExecutionResultSerializer(OutputStream output, URI baseUri, org.neo4j.logging.LogProvider logProvider)

Method Summary

Methods

Modifier and Type	Method and Description
void	errors(Iterable<? extends Neo4jError> errors) Will get called once if any errors occurred, after statementResult(org.neo4j.graphdb.Result, boolean, ResultDataContent...) statementResults} has been called This method is not allowed to throw exceptions.
void	finish() This method must be called exactly once, and no method must be called after calling this method.
void	notifications(Iterable<org.neo4j.graphdb.Notification> notifications)
void	statementResult(org.neo4j.graphdb.Result result, boolean includeStats, ResultDataContent... resultDataContents) Will get called at most once per statement.
void	transactionCommitUri(URI commitUri) Will always get called at most once, and is the first method to get called.
void	transactionStatus(long expiryDate)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExecutionResultSerializer

public ExecutionResultSerializer(OutputStream output,
                         URI baseUri,
                         org.neo4j.logging.LogProvider logProvider)

Method Detail

transactionCommitUri

public void transactionCommitUri(URI commitUri)

Will always get called at most once, and is the first method to get called. This method is not allowed to throw exceptions. If there are network errors or similar, the handler should take appropriate action, but never fail this method.

statementResult

public void statementResult(org.neo4j.graphdb.Result result,
                   boolean includeStats,
                   ResultDataContent... resultDataContents)
                     throws IOException

Will get called at most once per statement. Throws IOException so that upstream executor can decide whether to execute further statements.

Throws:

IOException

notifications

public void notifications(Iterable<org.neo4j.graphdb.Notification> notifications)
                   throws IOException

Throws:

IOException

errors

public void errors(Iterable<? extends Neo4jError> errors)

Will get called once if any errors occurred, after statementResult(org.neo4j.graphdb.Result, boolean, ResultDataContent...) statementResults} has been called This method is not allowed to throw exceptions. If there are network errors or similar, the handler should take appropriate action, but never fail this method.

Parameters:

errors - the errors to write

transactionStatus

public void transactionStatus(long expiryDate)

finish

public void finish()

This method must be called exactly once, and no method must be called after calling this method. This method may not fail.