Package org.openprovenance.prov.service.summary

Class SummaryService

java.lang.Object

org.openprovenance.prov.service.summary.SummaryService

All Implemented Interfaces:

InteropMediaType, Constants

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

Field Summary

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getConfiguration(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg)
org.openprovenance.prov.scala.summary.SummaryIndex	getProvenanceKernel(String docId, int level, org.openprovenance.prov.scala.summary.Level0Mapper level0, boolean aggregated)
jakarta.ws.rs.core.Response	getProvtypes(String msg, String configId, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.Request request)
jakarta.ws.rs.core.Response	getProvtypesConfiguration(String msg, String configId, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.Request request)
org.openprovenance.prov.scala.summary.SummaryIndex	getSummary(String docId, int level, org.openprovenance.prov.scala.summary.Level0Mapper level0, boolean aggregated)
org.openprovenance.prov.scala.summary.SummaryIndex	getSummaryIndex(String docId, int level, org.openprovenance.prov.scala.summary.Level0Mapper level0, boolean kernel, boolean aggregated)
jakarta.ws.rs.core.Response	getSummaryProvTypes(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg)
String	storeSummaryConfiguration(org.openprovenance.prov.scala.summary.SummaryConfiguration sc, NonDocumentResourceIndex<NonDocumentResource> ndIndex)
String	storeSummaryDescription(org.openprovenance.prov.scala.summary.SummaryIndex ndx, NonDocumentResourceIndex<NonDocumentResource> ndIndex)
String	storeSummaryDocument(org.openprovenance.prov.scala.summary.SummaryIndex ndx)
jakarta.ws.rs.core.Response	submit(InputStream input, String msg, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.Request request)
jakarta.ws.rs.core.Response	submitProvtypesConfig(InputStream input, String msg, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.Request request)

Methods inherited from class java.lang.Object

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

Constructor Detail

SummaryService

public SummaryService(PostService postService)

SummaryService

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

Method Detail

submit

@POST
@Path("/documents/{docId}/summary")
@Consumes("application/json")
public jakarta.ws.rs.core.Response submit(InputStream input,
                                          @PathParam("docId")
                                          String msg,
                                          @Context
                                          jakarta.ws.rs.core.HttpHeaders headers,
                                          @Context
                                          jakarta.ws.rs.core.Request request)
                                   throws IOException

Throws:

IOException

storeSummaryDocument

public String storeSummaryDocument(org.openprovenance.prov.scala.summary.SummaryIndex ndx)
                            throws IOException

Throws:

IOException

storeSummaryDescription

public String storeSummaryDescription(org.openprovenance.prov.scala.summary.SummaryIndex ndx,
                                      NonDocumentResourceIndex<NonDocumentResource> ndIndex)
                               throws IOException

Throws:

IOException

storeSummaryConfiguration

public String storeSummaryConfiguration(org.openprovenance.prov.scala.summary.SummaryConfiguration sc,
                                        NonDocumentResourceIndex<NonDocumentResource> ndIndex)
                                 throws IOException

Throws:

IOException

getSummary

public org.openprovenance.prov.scala.summary.SummaryIndex getSummary(String docId,
                                                                     int level,
                                                                     org.openprovenance.prov.scala.summary.Level0Mapper level0,
                                                                     boolean aggregated)
                                                              throws IOException

Throws:

IOException

getProvenanceKernel

public org.openprovenance.prov.scala.summary.SummaryIndex getProvenanceKernel(String docId,
                                                                              int level,
                                                                              org.openprovenance.prov.scala.summary.Level0Mapper level0,
                                                                              boolean aggregated)
                                                                       throws IOException

Throws:

IOException

getSummaryIndex

public org.openprovenance.prov.scala.summary.SummaryIndex getSummaryIndex(String docId,
                                                                          int level,
                                                                          org.openprovenance.prov.scala.summary.Level0Mapper level0,
                                                                          boolean kernel,
                                                                          boolean aggregated)
                                                                   throws IOException

Throws:

IOException

getConfiguration

@GET
@Path("/documents/{docId}/config")
@Produces("application/json")
public jakarta.ws.rs.core.Response getConfiguration(@Context
                                                    jakarta.servlet.http.HttpServletResponse response,
                                                    @Context
                                                    jakarta.ws.rs.core.Request request,
                                                    @PathParam("docId")
                                                    String msg)

getSummaryProvTypes

@GET
@Path("/documents/{docId}/details")
@Produces("application/json")
public jakarta.ws.rs.core.Response getSummaryProvTypes(@Context
                                                       jakarta.servlet.http.HttpServletResponse response,
                                                       @Context
                                                       jakarta.ws.rs.core.Request request,
                                                       @PathParam("docId")
                                                       String msg)

submitProvtypesConfig

@POST
@Path("/documents/{docId}/provtypes")
@Consumes("application/json")
public jakarta.ws.rs.core.Response submitProvtypesConfig(InputStream input,
                                                         @PathParam("docId")
                                                         String msg,
                                                         @Context
                                                         jakarta.ws.rs.core.HttpHeaders headers,
                                                         @Context
                                                         jakarta.ws.rs.core.Request request)
                                                  throws IOException

Throws:

IOException

getProvtypes

@GET
@Path("/documents/{docId}/provtypes/{configId}.json")
@Consumes("application/json")
public jakarta.ws.rs.core.Response getProvtypes(@PathParam("docId")
                                                String msg,
                                                @PathParam("configId")
                                                String configId,
                                                @Context
                                                jakarta.ws.rs.core.HttpHeaders headers,
                                                @Context
                                                jakarta.ws.rs.core.Request request)
                                         throws IOException

Throws:

IOException

getProvtypesConfiguration

@GET
@Path("/documents/{docId}/provtypes/{configId}/config")
@Consumes("application/json")
public jakarta.ws.rs.core.Response getProvtypesConfiguration(@PathParam("docId")
                                                             String msg,
                                                             @PathParam("configId")
                                                             String configId,
                                                             @Context
                                                             jakarta.ws.rs.core.HttpHeaders headers,
                                                             @Context
                                                             jakarta.ws.rs.core.Request request)
                                                      throws IOException

Throws:

IOException