net.morimekta.providence.graphql

Class GQLContext

java.lang.Object

net.morimekta.providence.graphql.GQLContext

All Implemented Interfaces:

AutoCloseable

public abstract class GQLContext
extends Object
implements AutoCloseable

The GQL context is created once per query method call, and once for the whole operation for mutations. Note that GQLServlet can be updated to handle queries serially as mutations if need be.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GQLContext(javax.servlet.http.HttpServletRequest request, GQLOperation operation)

Method Summary

Modifier and Type	Method and Description
void	abort(Exception ex) Implement if a failed context session ends in failure, e.g. update failure.
void	commit() Implement if a successful request is passed, and e.g. a transaction needs to be committed (instead of aborted).
GQLOperation	getOperation()
javax.servlet.http.HttpServletRequest	getRequest()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

GQLContext

protected GQLContext(@Nonnull
                     javax.servlet.http.HttpServletRequest request,
                     @Nonnull
                     GQLOperation operation)

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns:

The HTTP request that initiated the GQL operation.

getOperation

public GQLOperation getOperation()

Returns:

The GQL operation to be handled.

commit

public void commit()
            throws Exception

Implement if a successful request is passed, and e.g. a transaction needs to be committed (instead of aborted). This method is called when the last method call has passed for the context. It will be called before close.

Throws:

Exception - If committing failed.

abort

public void abort(Exception ex)
           throws Exception

Implement if a failed context session ends in failure, e.g. update failure. This can be used to trigger transaction abort procedure etc. This will also trigger if commit() throws exception.

Parameters:

ex - The exception causing the abort.

Throws:

Exception - If the abort procedure failed.