Module prov.service.core

Package org.openprovenance.prov.service.core

Class ServiceUtils

java.lang.Object

org.openprovenance.prov.service.core.ServiceUtils

public class ServiceUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ServiceUtils.Action
static enum	ServiceUtils.Destination

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_CONTROL_ALLOW_ORIGIN
static final String	CONFIG_PROPERTIES
LRUHashMap<String,Document>	documentCache
static final String	WILDCARD

Constructor Summary

Constructors

Constructor	Description
ServiceUtils(PostService postService, ServiceUtilsConfig config)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	composeResponseBadRequest(String result, Throwable thrown)
jakarta.ws.rs.core.Response	composeResponseError(jakarta.ws.rs.core.Response.Status status, String result, Throwable thrown)
jakarta.ws.rs.core.Response	composeResponseInternalServerError(String result, Throwable thrown)
jakarta.ws.rs.core.Response	composeResponseNotAcceptable(List<jakarta.ws.rs.core.Variant> vs)
jakarta.ws.rs.core.Response	composeResponseNotFOUND(String result)
jakarta.ws.rs.core.Response	composeResponseNotFOUND(String result, Throwable thrown)
jakarta.ws.rs.core.Response	composeResponseNotFoundConstraintResource(String msg)
jakarta.ws.rs.core.Response	composeResponseNotFoundDocument(String msg)
jakarta.ws.rs.core.Response	composeResponseNotFoundResource(String msg)
jakarta.ws.rs.core.Response	composeResponseNotFoundSummarisation(String msg)
jakarta.ws.rs.core.Response	composeResponseNotFoundType(String msg)
static jakarta.ws.rs.core.Response.ResponseBuilder	composeResponseOK(Object o)
jakarta.ws.rs.core.Response.ResponseBuilder	composeResponseSeeOther(String uri)
jakarta.ws.rs.core.Response	contentNegotiationForDocument(jakarta.ws.rs.core.Request request, String path)
jakarta.ws.rs.core.Response	contentNegotiationForDocument(jakarta.ws.rs.core.Request request, String msg, String uriPath)
boolean	deleteFromCache(String storageId)
DocumentResource	doProcessFile(InputStream inputStream, String mediaType)
boolean	doProcessFile(DocumentResource dr, boolean known)
DocumentResource	doProcessFileForm(List<org.jboss.resteasy.plugins.providers.multipart.InputPart> inputParts)
DocumentResource	doProcessStatementsForm(List<org.jboss.resteasy.plugins.providers.multipart.InputPart> inputParts, List<org.jboss.resteasy.plugins.providers.multipart.InputPart> type)
DocumentResource	doProcessURLForm(List<org.jboss.resteasy.plugins.providers.multipart.InputPart> inputParts)
ServiceUtils.Action	getAction(Map<String,List<org.jboss.resteasy.plugins.providers.multipart.InputPart>> formData)
ServiceUtilsConfig	getConfig()
ServiceUtils.Destination	getDestination(Map<String,List<org.jboss.resteasy.plugins.providers.multipart.InputPart>> formData)
Document	getDocumentFromCacheOrStore(String storageId)
Document	getDocumentFromStore(String storageId, DateTimeOption dateTimeOption, TimeZone timeZone)
ResourceIndex<DocumentResource>	getDocumentResourceIndex()
final Map<String,ResourceIndex<?>>	getExtensionMap()
String	getFileName(jakarta.ws.rs.core.MultivaluedMap<String,String> header)	header sample { Content-Type=[image/png], Content-Disposition=[form-data; name="file"; filename="filename.extension"] }
String	getFormDataValue(Map<String,List<org.jboss.resteasy.plugins.providers.multipart.InputPart>> formData, String name)
Map<String,NonDocumentGenericResourceStorage<?>>	getGenericResourceStorageMap()
JobManagement	getJobManager()
NonDocumentResourceIndex<NonDocumentResource>	getNonDocumentResourceIndex()
NonDocumentResourceStorage	getNonDocumentResourceStorage()
static Properties	getPropertiesFromClasspath(String propFileName)
ProvFactory	getProvFactory()
static String	getRequestURL(jakarta.servlet.http.HttpServletRequest request, String api, String docId, String action)
ResourceStorage	getStorageManager()
static String	getSystemOrEnvironmentVariableOrDefault(String name, String defaultValue)
static boolean	isNumeric(String str)
static String	isSelf(String s, jakarta.ws.rs.core.UriInfo uInfo, String resource)
static Map<String,String>	loadConfigFromEnvironment(Map<String,String> defaultConfiguration)
static Map<String,String>	loadConfigFromSystem(Map<String,String> defaultConfiguration)
void	printStackTrace(PrintWriter pw, Throwable thrown)

Methods inherited from class java.lang.Object

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

Field Details

WILDCARD

public static final String WILDCARD

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_ORIGIN

public static final String ACCESS_CONTROL_ALLOW_ORIGIN

See Also:

• Constant Field Values

CONFIG_PROPERTIES

public static final String CONFIG_PROPERTIES

See Also:

• Constant Field Values

documentCache

public LRUHashMap<String,Document> documentCache

Constructor Details

ServiceUtils

public ServiceUtils(PostService postService,
 ServiceUtilsConfig config)

Method Details

getSystemOrEnvironmentVariableOrDefault

public static String getSystemOrEnvironmentVariableOrDefault(String name,
 String defaultValue)

getGenericResourceStorageMap

public Map<String,NonDocumentGenericResourceStorage<?>> getGenericResourceStorageMap()

getConfig

public ServiceUtilsConfig getConfig()

getPropertiesFromClasspath

public static Properties getPropertiesFromClasspath(String propFileName)

getNonDocumentResourceStorage

public NonDocumentResourceStorage getNonDocumentResourceStorage()

getDocumentResourceIndex

public ResourceIndex<DocumentResource> getDocumentResourceIndex()

getStorageManager

public ResourceStorage getStorageManager()

getExtensionMap

public final Map<String,ResourceIndex<?>> getExtensionMap()

getNonDocumentResourceIndex

public NonDocumentResourceIndex<NonDocumentResource> getNonDocumentResourceIndex()

getProvFactory

public ProvFactory getProvFactory()

getDestination

public ServiceUtils.Destination getDestination(Map<String,List<org.jboss.resteasy.plugins.providers.multipart.InputPart>> formData)
                                        throws IOException

Throws:

IOException

getJobManager

public JobManagement getJobManager()

getFormDataValue

public String getFormDataValue(Map<String,List<org.jboss.resteasy.plugins.providers.multipart.InputPart>> formData,
 String name)
                        throws IOException

Throws:

IOException

getAction

public ServiceUtils.Action getAction(Map<String,List<org.jboss.resteasy.plugins.providers.multipart.InputPart>> formData)
                              throws IOException

Throws:

IOException

getRequestURL

public static String getRequestURL(jakarta.servlet.http.HttpServletRequest request,
 String api,
 String docId,
 String action)

isNumeric

public static boolean isNumeric(String str)

isSelf

public static String isSelf(String s,
 jakarta.ws.rs.core.UriInfo uInfo,
 String resource)

composeResponseNotFOUND

public jakarta.ws.rs.core.Response composeResponseNotFOUND(String result)

composeResponseBadRequest

public jakarta.ws.rs.core.Response composeResponseBadRequest(String result,
 Throwable thrown)

composeResponseNotFOUND

public jakarta.ws.rs.core.Response composeResponseNotFOUND(String result,
 Throwable thrown)

composeResponseError

public jakarta.ws.rs.core.Response composeResponseError(jakarta.ws.rs.core.Response.Status status,
 String result,
 Throwable thrown)

printStackTrace

public void printStackTrace(PrintWriter pw,
 Throwable thrown)

composeResponseInternalServerError

public jakarta.ws.rs.core.Response composeResponseInternalServerError(String result,
 Throwable thrown)

composeResponseSeeOther

public jakarta.ws.rs.core.Response.ResponseBuilder composeResponseSeeOther(String uri)

composeResponseOK

public static jakarta.ws.rs.core.Response.ResponseBuilder composeResponseOK(Object o)

composeResponseNotAcceptable

public jakarta.ws.rs.core.Response composeResponseNotAcceptable(List<jakarta.ws.rs.core.Variant> vs)

composeResponseNotFoundDocument

public jakarta.ws.rs.core.Response composeResponseNotFoundDocument(String msg)

composeResponseNotFoundResource

public jakarta.ws.rs.core.Response composeResponseNotFoundResource(String msg)

composeResponseNotFoundConstraintResource

public jakarta.ws.rs.core.Response composeResponseNotFoundConstraintResource(String msg)

composeResponseNotFoundType

public jakarta.ws.rs.core.Response composeResponseNotFoundType(String msg)

composeResponseNotFoundSummarisation

public jakarta.ws.rs.core.Response composeResponseNotFoundSummarisation(String msg)

doProcessFile

public DocumentResource doProcessFile(InputStream inputStream,
 String mediaType)

doProcessFile

public boolean doProcessFile(DocumentResource dr,
 boolean known)

getDocumentFromCacheOrStore

public Document getDocumentFromCacheOrStore(String storageId)
                                     throws IOException

Throws:

IOException

getDocumentFromStore

public Document getDocumentFromStore(String storageId,
 DateTimeOption dateTimeOption,
 TimeZone timeZone)
                              throws IOException

Throws:

IOException

deleteFromCache

public boolean deleteFromCache(String storageId)

doProcessStatementsForm

public DocumentResource doProcessStatementsForm(List<org.jboss.resteasy.plugins.providers.multipart.InputPart> inputParts,
 List<org.jboss.resteasy.plugins.providers.multipart.InputPart> type)

doProcessFileForm

public DocumentResource doProcessFileForm(List<org.jboss.resteasy.plugins.providers.multipart.InputPart> inputParts)

doProcessURLForm

public DocumentResource doProcessURLForm(List<org.jboss.resteasy.plugins.providers.multipart.InputPart> inputParts)

getFileName

public String getFileName(jakarta.ws.rs.core.MultivaluedMap<String,String> header)

header sample { Content-Type=[image/png], Content-Disposition=[form-data; name="file"; filename="filename.extension"] }

Parameters:

header - a mapping

Returns:

a string

contentNegotiationForDocument

public jakarta.ws.rs.core.Response contentNegotiationForDocument(jakarta.ws.rs.core.Request request,
 String msg,
 String uriPath)
                                                          throws IllegalArgumentException

Throws:

IllegalArgumentException

contentNegotiationForDocument

public jakarta.ws.rs.core.Response contentNegotiationForDocument(jakarta.ws.rs.core.Request request,
 String path)
                                                          throws IllegalArgumentException

Throws:

IllegalArgumentException

loadConfigFromSystem

public static Map<String,String> loadConfigFromSystem(Map<String,String> defaultConfiguration)

loadConfigFromEnvironment

public static Map<String,String> loadConfigFromEnvironment(Map<String,String> defaultConfiguration)