Package org.openprovenance.prov.service

Class TemplateService

java.lang.Object

org.openprovenance.prov.service.TemplateService

@Path("")
public class TemplateService
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplateService.Linker

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_VND_KCL_PROV_TEMPLATE_JSON
static final String	DB_PASS
static final String	DB_USER
static final String	NO_SECURITY_CONFIG
static final String	POSTGRES_HOST
static final String	postgresHost
static final String	postgresPassword
static final String	postgresUsername
static final String	PROV_API
static final String	provAPI
static final String	provHost
static final SecurityConfiguration	securityConfiguration
static final Utils	secUtils
static final String	TPL_HOST
static final String	TPL_SECURITY_CONFIG
static final String	tplSecurityConfig

Constructor Summary

Constructors

Constructor	Description
TemplateService(PostService ps)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getHash(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, String template, Integer id)
jakarta.ws.rs.core.Response	getLiveNode(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, String relation, Integer id, String extension)
String	getPrincipalAsPreferredUsername(Principal principal)
jakarta.ws.rs.core.Response	getTemplateInstanceWithId(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, String template, Integer id, String extension)
jakarta.ws.rs.core.Response	getTemplatePropertyInstanceWithId(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, String template, Integer id, String variable, String extension)
jakarta.ws.rs.core.Response	getTemplates(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, String extension, TableKeyList tableKey)
jakarta.ws.rs.core.Response	getTemplatesRecords(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, SearchConfig searchConfig)
jakarta.ws.rs.core.Response	getTemplatesViz(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, TemplatesVizConfig config)
jakarta.ws.rs.core.Response	reHash(jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, String template, Integer id)
jakarta.ws.rs.core.Response	submitStatements(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, JsonOrCsv documentOrCsv)

Methods inherited from class java.lang.Object

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

Field Details

APPLICATION_VND_KCL_PROV_TEMPLATE_JSON

public static final String APPLICATION_VND_KCL_PROV_TEMPLATE_JSON

See Also:

• Constant Field Values

TPL_HOST

public static final String TPL_HOST

See Also:

• Constant Field Values

provHost

public static final String provHost

PROV_API

public static final String PROV_API

See Also:

• Constant Field Values

provAPI

public static final String provAPI

POSTGRES_HOST

public static final String POSTGRES_HOST

See Also:

• Constant Field Values

postgresHost

public static final String postgresHost

DB_USER

public static final String DB_USER

See Also:

• Constant Field Values

postgresUsername

public static final String postgresUsername

DB_PASS

public static final String DB_PASS

See Also:

• Constant Field Values

postgresPassword

public static final String postgresPassword

TPL_SECURITY_CONFIG

public static final String TPL_SECURITY_CONFIG

See Also:

• Constant Field Values

NO_SECURITY_CONFIG

public static final String NO_SECURITY_CONFIG

See Also:

• Constant Field Values

tplSecurityConfig

public static final String tplSecurityConfig

secUtils

public static final Utils secUtils

securityConfiguration

public static final SecurityConfiguration securityConfiguration

Constructor Details

TemplateService

public TemplateService(PostService ps)

Method Details

submitStatements

@POST
@Path("/statements")
@Consumes({"text/csv","application/vnd.kcl.prov-template+json"})
@Produces({"text/csv","application/vnd.kcl.prov-template+json"})
public jakarta.ws.rs.core.Response submitStatements(@Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 JsonOrCsv documentOrCsv)

getTemplateInstanceWithId

@GET
@Path("/template/{template}/{id}.{extension}")
@Produces({"application/ld+json","text/provenance-notation","image/svg+xml","text/csv"})
public jakarta.ws.rs.core.Response getTemplateInstanceWithId(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("template")
 String template,
 @PathParam("id")
 Integer id,
 @PathParam("extension")
 String extension)

getPrincipalAsPreferredUsername

public String getPrincipalAsPreferredUsername(Principal principal)

getTemplatePropertyInstanceWithId

@GET
@Path("/template/{template}/{id}/{variable:\\w+}{extension:(\\.\\w+)?}")
@Produces({"application/ld+json","text/provenance-notation","image/svg+xml"})
public jakarta.ws.rs.core.Response getTemplatePropertyInstanceWithId(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("template")
 String template,
 @PathParam("id")
 Integer id,
 @PathParam("variable")
 String variable,
 @PathParam("extension")
 String extension)

getTemplates

@POST
@Path("/templates.{extension}")
@Produces({"application/ld+json","text/provenance-notation","image/svg+xml"})
@Consumes("application/json")
public jakarta.ws.rs.core.Response getTemplates(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("extension")
 String extension,
 TableKeyList tableKey)

getTemplatesRecords

@POST
@Path("/templates/records")
@Consumes("application/json")
@Produces("text/csv")
public jakarta.ws.rs.core.Response getTemplatesRecords(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 SearchConfig searchConfig)

getTemplatesViz

@POST
@Path("/templates/viz")
@Consumes("application/json")
@Produces("image/svg+xml")
public jakarta.ws.rs.core.Response getTemplatesViz(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 TemplatesVizConfig config)

getLiveNode

@GET
@Path("/live/{relation}/{id:\\d+}{extension:(\\.\\w+)?}")
@Produces({"application/ld+json","text/provenance-notation","image/svg+xml"})
@Consumes("application/json")
public jakarta.ws.rs.core.Response getLiveNode(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("relation")
 String relation,
 @PathParam("id")
 Integer id,
 @PathParam("extension")
 String extension)

getHash

@GET
@Path("/hash/template/{template}/{id}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getHash(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("template")
 String template,
 @PathParam("id")
 Integer id)

reHash

@GET
@Path("/rehash/template/{template}/{id}")
@Produces("application/json")
public jakarta.ws.rs.core.Response reHash(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("template")
 String template,
 @PathParam("id")
 Integer id)