Package org.openprovenance.prov.service.validation

Class ValidationService

java.lang.Object

org.openprovenance.prov.service.validation.ValidationService

All Implemented Interfaces:

InteropMediaType, Constants, SwaggerTags

@Path("")
public class ValidationService
extends Object
implements Constants, InteropMediaType, SwaggerTags

Field Summary

Fields

Modifier and Type	Field	Description
static jakarta.ws.rs.core.MediaType	IMAGE_PNG_TYPE
static String	VS
static String	VS_PREFIX
static String	VSI
static String	VSI_PREFIX

Fields inherited from interface org.openprovenance.prov.service.core.Constants

ACCESS_CONTROL_ALLOW_ORIGIN, ALLOWABLE_INPUT_DOCUMENT_EXTENSIONS, ALLOWABLE_OUTPUT_DOCUMENT_EXTENSIONS, DOCUMENT_NOT_FOUND, EXPANSION, GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET, HAS_PROVENANCE, HEADER_PARAM_ACCEPT, HTTP_HEADER_PROVENANCE_ACCEPT_DATETIME_OPTION, HTTP_HEADER_PROVENANCE_ACCEPT_TIMEZONE, HTTP_HEADER_PROVENANCE_CONTENT_DATETIME_OPTION, HTTP_HEADER_PROVENANCE_CONTENT_TIMEZONE, PROVAPI, SUMMARISATION, TEMPLATE_EXPANSION, translationExtensions, WILDCARD

Fields inherited from interface org.openprovenance.prov.interop.InteropMediaType

ALL_PROV_INPUT_MEDIA_TYPES, ALL_PROV_OUTPUT_MEDIA_TYPES, EXTENSION_DOT, EXTENSION_JPEG, EXTENSION_JPG, EXTENSION_JSON, EXTENSION_JSONLD, EXTENSION_PDF, EXTENSION_PNG, EXTENSION_PROVN, EXTENSION_PROVX, EXTENSION_RDF, EXTENSION_SVG, EXTENSION_TRIG, EXTENSION_TTL, EXTENSION_XML, MEDIA_APPLICATION_FORM_URLENCODED, MEDIA_APPLICATION_JSON, MEDIA_APPLICATION_JSONLD, MEDIA_APPLICATION_PDF, MEDIA_APPLICATION_PROVENANCE_XML, MEDIA_APPLICATION_RDF_XML, MEDIA_APPLICATION_SQL, MEDIA_APPLICATION_TRIG, MEDIA_APPLICATION_XML, MEDIA_IMAGE_JPEG, MEDIA_IMAGE_PNG, MEDIA_IMAGE_SVG_XML, MEDIA_TEXT_CSV, MEDIA_TEXT_HTML, MEDIA_TEXT_PLAIN, MEDIA_TEXT_PROVENANCE_NOTATION, MEDIA_TEXT_TURTLE, MEDIA_TEXT_VND_GRAPHVIZ, MEDIA_TEXT_XML

Fields inherited from interface org.openprovenance.prov.service.core.SwaggerTags

DOCUMENTS, NARRATIVE, NLG, RANDOM, RESOURCES, TEMPLATE, VALIDATION, VIEW

Constructor Summary

Constructors

Constructor	Description
ValidationService(PostService postService)
ValidationService(PostService postService, List<ActionPerformer> performers, Optional<OtherActionPerformer> otherPerformer)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getMatrix(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, String accept)
jakarta.ws.rs.core.Response	getMatrixAsPng(String msg)
jakarta.ws.rs.core.Response	getMatrixAsText(String msg)
jakarta.ws.rs.core.Response	getNormalFormAsType(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, String msg, String type)
jakarta.ws.rs.core.Response	getNormalized(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, String accept)
jakarta.ws.rs.core.Response	getValidationReport(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, String accept)
jakarta.ws.rs.core.Response	getValidationReportAsJson(String msg)
String	stackTraceToString(Throwable thrown)

Methods inherited from class java.lang.Object

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

Field Detail

IMAGE_PNG_TYPE

public static final jakarta.ws.rs.core.MediaType IMAGE_PNG_TYPE

VS

public static String VS

VS_PREFIX

public static String VS_PREFIX

VSI

public static String VSI

VSI_PREFIX

public static String VSI_PREFIX

Constructor Detail

ValidationService

public ValidationService(PostService postService)

ValidationService

public ValidationService(PostService postService,
                         List<ActionPerformer> performers,
                         Optional<OtherActionPerformer> otherPerformer)

Method Detail

getNormalized

@GET
@Path("/documents/{docId}/validation/normalForm")
public jakarta.ws.rs.core.Response getNormalized(@Context
                                                 jakarta.servlet.http.HttpServletResponse response,
                                                 @Context
                                                 jakarta.ws.rs.core.Request request,
                                                 @PathParam("docId")
                                                 String msg,
                                                 @HeaderParam("Accept")
                                                 String accept)

getNormalFormAsType

@GET
@Path("/documents/{docId}/validation/normalForm.{type}")
public jakarta.ws.rs.core.Response getNormalFormAsType(@Context
                                                       jakarta.servlet.http.HttpServletResponse response,
                                                       @Context
                                                       jakarta.servlet.http.HttpServletRequest request,
                                                       @PathParam("docId")
                                                       String msg,
                                                       @PathParam("type")
                                                       String type)
                                                throws FileNotFoundException,
                                                       IOException,
                                                       jakarta.servlet.ServletException

Throws:

FileNotFoundException

IOException

jakarta.servlet.ServletException

getValidationReport

@GET
@Path("/documents/{docId}/validation/report")
public jakarta.ws.rs.core.Response getValidationReport(@Context
                                                       jakarta.servlet.http.HttpServletResponse response,
                                                       @Context
                                                       jakarta.ws.rs.core.Request request,
                                                       @PathParam("docId")
                                                       String msg,
                                                       @HeaderParam("Accept")
                                                       String accept)

getValidationReportAsJson

@GET
@Path("/documents/{docId}/validation/report.json")
@Produces("application/json")
public jakarta.ws.rs.core.Response getValidationReportAsJson(@PathParam("docId")
                                                             String msg)

stackTraceToString

public String stackTraceToString(Throwable thrown)

getMatrix

@GET
@Path("/documents/{docId}/validation/matrix")
public jakarta.ws.rs.core.Response getMatrix(@Context
                                             jakarta.servlet.http.HttpServletResponse response,
                                             @Context
                                             jakarta.ws.rs.core.Request request,
                                             @PathParam("docId")
                                             String msg,
                                             @HeaderParam("Accept")
                                             String accept)

getMatrixAsText

@GET
@Path("/documents/{docId}/validation/matrix.txt")
@Produces("text/plain")
public jakarta.ws.rs.core.Response getMatrixAsText(@PathParam("docId")
                                                   String msg)
                                            throws IOException

Throws:

IOException

getMatrixAsPng

@GET
@Path("/documents/{docId}/validation/matrix.png")
@Produces("image/png")
public jakarta.ws.rs.core.Response getMatrixAsPng(@PathParam("docId")
                                                  String msg)
                                           throws IOException

Throws:

IOException