org.neo4j.server.rest.repr

Class OutputFormat

java.lang.Object

org.neo4j.server.rest.repr.OutputFormat

public class OutputFormat
extends Object

Constructor Summary

Constructors

Constructor and Description
OutputFormat(org.neo4j.server.rest.repr.RepresentationFormat format, URI baseUri, org.neo4j.server.rest.repr.ExtensionInjector extensions)

Method Summary

Methods

Modifier and Type	Method and Description
String	assemble(org.neo4j.server.rest.repr.Representation representation)
javax.ws.rs.core.Response	badRequest(javax.ws.rs.core.MediaType mediaType, String entity)
javax.ws.rs.core.Response	badRequest(Throwable exception)
javax.ws.rs.core.Response	badRequestWithoutLegacyStacktrace(Throwable exception) Before the 'errors' response existed, we would just spit out stack traces.
<REPR extends org.neo4j.server.rest.repr.Representation & EntityRepresentation> javax.ws.rs.core.Response	conflict(REPR representation)
javax.ws.rs.core.Response	conflict(Throwable exception)
<REPR extends org.neo4j.server.rest.repr.Representation & EntityRepresentation> javax.ws.rs.core.Response	created(REPR representation)
javax.ws.rs.core.MediaType	getMediaType()
RepresentationWriteHandler	getRepresentationWriteHandler()
javax.ws.rs.core.Response	methodNotAllowed(UnsupportedOperationException e)
javax.ws.rs.core.Response	noContent()
javax.ws.rs.core.Response	notFound()
javax.ws.rs.core.Response	notFound(Throwable exception)
javax.ws.rs.core.Response	ok()
javax.ws.rs.core.Response	ok(org.neo4j.server.rest.repr.Representation representation)
<REPR extends org.neo4j.server.rest.repr.Representation & EntityRepresentation> javax.ws.rs.core.Response	okIncludeLocation(REPR representation)
javax.ws.rs.core.Response	response(javax.ws.rs.core.Response.StatusType status, org.neo4j.server.rest.repr.Representation representation)
javax.ws.rs.core.Response	seeOther(URI uri)
javax.ws.rs.core.Response	serverError(Throwable exception)
javax.ws.rs.core.Response	serverErrorWithoutLegacyStacktrace(Throwable exception)
void	setRepresentationWriteHandler(RepresentationWriteHandler representationWriteHandler)
javax.ws.rs.core.Response	unauthorized(org.neo4j.server.rest.repr.Representation representation, String authChallenge)
static void	write(org.neo4j.server.rest.repr.Representation representation, org.neo4j.server.rest.repr.RepresentationFormat format, URI baseUri)

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputFormat

public OutputFormat(org.neo4j.server.rest.repr.RepresentationFormat format,
            URI baseUri,
            org.neo4j.server.rest.repr.ExtensionInjector extensions)

Method Detail

setRepresentationWriteHandler

public void setRepresentationWriteHandler(RepresentationWriteHandler representationWriteHandler)

getRepresentationWriteHandler

public RepresentationWriteHandler getRepresentationWriteHandler()

ok

public final javax.ws.rs.core.Response ok(org.neo4j.server.rest.repr.Representation representation)

okIncludeLocation

public final <REPR extends org.neo4j.server.rest.repr.Representation & EntityRepresentation> javax.ws.rs.core.Response okIncludeLocation(REPR representation)
                                                  throws org.neo4j.server.rest.repr.BadInputException

Throws:

org.neo4j.server.rest.repr.BadInputException

created

public final <REPR extends org.neo4j.server.rest.repr.Representation & EntityRepresentation> javax.ws.rs.core.Response created(REPR representation)
                                        throws org.neo4j.server.rest.repr.BadInputException

Throws:

org.neo4j.server.rest.repr.BadInputException

response

public final javax.ws.rs.core.Response response(javax.ws.rs.core.Response.StatusType status,
                                 org.neo4j.server.rest.repr.Representation representation)

badRequestWithoutLegacyStacktrace

public javax.ws.rs.core.Response badRequestWithoutLegacyStacktrace(Throwable exception)

Before the 'errors' response existed, we would just spit out stack traces. For new endpoints, we should return the new 'errors' response format, which will bundle stack traces only on unknown problems.

badRequest

public javax.ws.rs.core.Response badRequest(Throwable exception)

notFound

public javax.ws.rs.core.Response notFound(Throwable exception)

notFound

public javax.ws.rs.core.Response notFound()

seeOther

public javax.ws.rs.core.Response seeOther(URI uri)

conflict

public javax.ws.rs.core.Response conflict(Throwable exception)

conflict

public final <REPR extends org.neo4j.server.rest.repr.Representation & EntityRepresentation> javax.ws.rs.core.Response conflict(REPR representation)
                                         throws org.neo4j.server.rest.repr.BadInputException

Throws:

org.neo4j.server.rest.repr.BadInputException

serverErrorWithoutLegacyStacktrace

public javax.ws.rs.core.Response serverErrorWithoutLegacyStacktrace(Throwable exception)

See Also:

#badRequestWithoutLegacyStacktrace}

serverError

public javax.ws.rs.core.Response serverError(Throwable exception)

write

public static void write(org.neo4j.server.rest.repr.Representation representation,
         org.neo4j.server.rest.repr.RepresentationFormat format,
         URI baseUri)

getMediaType

public javax.ws.rs.core.MediaType getMediaType()

assemble

public String assemble(org.neo4j.server.rest.repr.Representation representation)

noContent

public javax.ws.rs.core.Response noContent()

methodNotAllowed

public javax.ws.rs.core.Response methodNotAllowed(UnsupportedOperationException e)

ok

public javax.ws.rs.core.Response ok()

badRequest

public javax.ws.rs.core.Response badRequest(javax.ws.rs.core.MediaType mediaType,
                                   String entity)

unauthorized

public javax.ws.rs.core.Response unauthorized(org.neo4j.server.rest.repr.Representation representation,
                                     String authChallenge)