Index

B C D E F G H I J L M P R S U V W 
All Classes and Interfaces|All Packages|Serialized Form

B

BaseWrapper - Class in de.dlr.proseo.basewrap
prosEO Base Processor Wrapper - for processors conforming to ESA's "Generic IPF Interface Specification" (MMFI-GSEG-EOPG-TN-07-0003, V.1.8)
BaseWrapper() - Constructor for class de.dlr.proseo.basewrap.BaseWrapper
 
BaseWrapper.ENV_VARS - Enum Class in de.dlr.proseo.basewrap
Enumeration with valid environment variable names (available for wrapper subclasses).
BaseWrapper.WrapperException - Exception Class in de.dlr.proseo.basewrap
Class for raising wrapper-generated runtime exceptions
bytesToHex(byte[]) - Static method in class de.dlr.proseo.basewrap.MD5Util
Generate a string of hex digits (upper-case) representing the given byte array

C

CONTAINER_JOF_PATH - Variable in class de.dlr.proseo.basewrap.BaseWrapper
Auto-created path/filename of JobOrderFile within container (according to Generic IPF Interface Specifications)
CONTAINER_OUTPUTS_PATH_PREFIX - Static variable in class de.dlr.proseo.basewrap.BaseWrapper
Directory prefix of produced output data (available for wrapper subclasses)
createIngestorProduct(Path) - Method in class de.dlr.proseo.basewrap.BaseWrapper
Create a REST interface product for product ingestion from the given output file path; sets attributes mountPoint, filePath, productFileName, fileSize, checksum and checksumTime

D

de.dlr.proseo.basewrap - package de.dlr.proseo.basewrap
prosEO Sample Processor Wrapper package containing wrapper procedures for processors conforming to ESA's "Generic IPF Interface Specification" (MMFI-GSEG-EOPG-TN-07-0003, V.1.8)
de.dlr.proseo.basewrap.rest - package de.dlr.proseo.basewrap.rest
Classes for the base wrapper's REST connections.
DELETE - Enum constant in enum class de.dlr.proseo.basewrap.rest.RestOps.HttpMethod
 

E

ENV_FILECHECK_MAX_CYCLES - Variable in class de.dlr.proseo.basewrap.BaseWrapper
Variables to control max cycles and wait time to check file size of fetched input files
ENV_FILECHECK_WAIT_TIME - Variable in class de.dlr.proseo.basewrap.BaseWrapper
 
ENV_INGESTOR_ENDPOINT - Variable in class de.dlr.proseo.basewrap.BaseWrapper
HTTP endpoint for Ingestor callback (available for wrapper subclasses)
ENV_JOBORDER_VERSION - Variable in class de.dlr.proseo.basewrap.BaseWrapper
The Job Order File format version to be used
ENV_LOCAL_FS_MOUNT - Variable in class de.dlr.proseo.basewrap.BaseWrapper
Mount point of shared local file system (available for wrapper subclasses)
ENV_PROCESSING_FACILITY_NAME - Variable in class de.dlr.proseo.basewrap.BaseWrapper
Name of the Processing Facility this wrapper is running in (available for wrapper subclasses)
ENV_PROCESSOR_SHELL_COMMAND - Variable in class de.dlr.proseo.basewrap.BaseWrapper
Shell command to run the processor (with path to Job Order File as sole parameter)
ENV_PROSEO_PW - Variable in class de.dlr.proseo.basewrap.BaseWrapper
Password for prosEO Control Instance (available for wrapper subclasses)
ENV_PROSEO_USER - Variable in class de.dlr.proseo.basewrap.BaseWrapper
User name for prosEO Control Instance (available for wrapper subclasses)
extractProseoMessage(HttpResponseInfo) - Method in class de.dlr.proseo.basewrap.BaseWrapper
Extracts the prosEO-compliant message from the "Warning" header, if any

F

FILECHECK_MAX_CYCLES - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
FILECHECK_WAIT_TIME - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 

G

GET - Enum constant in enum class de.dlr.proseo.basewrap.rest.RestOps.HttpMethod
 
gethttpCode() - Method in class de.dlr.proseo.basewrap.rest.HttpResponseInfo
Gets the HTTP code
gethttpResponse() - Method in class de.dlr.proseo.basewrap.rest.HttpResponseInfo
Gets the HTTP response
getHttpWarning() - Method in class de.dlr.proseo.basewrap.rest.HttpResponseInfo
Gets the HTTP warning

H

HEAD - Enum constant in enum class de.dlr.proseo.basewrap.rest.RestOps.HttpMethod
 
HttpResponseInfo - Class in de.dlr.proseo.basewrap.rest
A class to hold information extracted from a HTTP response.
HttpResponseInfo() - Constructor for class de.dlr.proseo.basewrap.rest.HttpResponseInfo
 

I

INGESTOR_ENDPOINT - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
ingestProduct(IngestorProduct) - Method in class de.dlr.proseo.basewrap.BaseWrapper
Ingest the given product into the prosEO metadata database and into the backend storage

J

JOB_ORDER_ID - Static variable in class de.dlr.proseo.basewrap.BaseWrapper
Order ID for job order file (according to Generic IPF Interface Specifications, sec. 4.2.2); limited to 31 bits (int), because some IPFs cannot handle larger order IDs (apparently they take the word "integer" literally)
JOBORDER_FILE - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
JOBORDER_VERSION - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 

L

LOCAL_FS_MOUNT - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 

M

main(String[]) - Static method in class de.dlr.proseo.basewrap.BaseWrapper
Main routine: Run BaseWrapper
md5Digest(File) - Static method in class de.dlr.proseo.basewrap.MD5Util
Create an (upper-case) MD5 hash string for the given file
MD5Util - Class in de.dlr.proseo.basewrap
Utility methods to efficiently calculate an MD5 hash string from a file
MD5Util() - Constructor for class de.dlr.proseo.basewrap.MD5Util
 

P

PATCH - Enum constant in enum class de.dlr.proseo.basewrap.rest.RestOps.HttpMethod
 
POST - Enum constant in enum class de.dlr.proseo.basewrap.rest.RestOps.HttpMethod
 
postFetchInputHook(JobOrder) - Method in class de.dlr.proseo.basewrap.BaseWrapper
Hook for mission-specific modifications to the job order document after fetching input data Intended for override by mission-specific wrapper classes, NO-OP in BaseWrapper.
postProcessingHook(JobOrder) - Method in class de.dlr.proseo.basewrap.BaseWrapper
Hook for mission-specific modifications to the final job order document after execution of the processor (before push of results).
preFetchInputHook(JobOrder) - Method in class de.dlr.proseo.basewrap.BaseWrapper
Hook for mission-specific modifications to the job order document before fetching input data Intended for override by mission-specific wrapper classes, NO-OP in BaseWrapper.
PROCESSING_FACILITY_NAME - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
PROCESSOR_SHELL_COMMAND - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
PROSEO_PW - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
PROSEO_USER - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
PUT - Enum constant in enum class de.dlr.proseo.basewrap.rest.RestOps.HttpMethod
 

R

REL_CONTAINER_JOF_PATH - Variable in class de.dlr.proseo.basewrap.BaseWrapper
 
restApiCall(String, String, String, String, String, Map<String, String>, RestOps.HttpMethod) - Static method in class de.dlr.proseo.basewrap.rest.RestOps
Generic REST API client (currently only supporting GET, PUT and POST)
RestOps - Class in de.dlr.proseo.basewrap.rest
Perform REST API calls to a provided endpoint.
RestOps() - Constructor for class de.dlr.proseo.basewrap.rest.RestOps
 
RestOps.HttpMethod - Enum Class in de.dlr.proseo.basewrap.rest
A collection of HTTP Methods.
retrieveProductMetadata(InputOutput) - Method in class de.dlr.proseo.basewrap.BaseWrapper
Get the product metadata for a given output element
run() - Method in class de.dlr.proseo.basewrap.BaseWrapper
Perform processing: check parameters, parse JobOrder file, fetch input files, process, push output files

S

sethttpCode(int) - Method in class de.dlr.proseo.basewrap.rest.HttpResponseInfo
Sets the HTTP code
sethttpResponse(String) - Method in class de.dlr.proseo.basewrap.rest.HttpResponseInfo
Sets the HTTP response
setHttpWarning(String) - Method in class de.dlr.proseo.basewrap.rest.HttpResponseInfo
Sets the HTTP warning
STATE_CALLBACK_ENDPOINT - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
STORAGE_ENDPOINT - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
STORAGE_PASSWORD - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 
STORAGE_USER - Enum constant in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
 

U

updateProductMetadata(InputOutput, RestProduct) - Method in class de.dlr.proseo.basewrap.BaseWrapper
Update the metadata for the product denoted in the given output element

V

valueOf(String) - Static method in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class de.dlr.proseo.basewrap.rest.RestOps.HttpMethod
Returns the enum constant of this class with the specified name.
values() - Static method in enum class de.dlr.proseo.basewrap.BaseWrapper.ENV_VARS
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class de.dlr.proseo.basewrap.rest.RestOps.HttpMethod
Returns an array containing the constants of this enum class, in the order they are declared.

W

WRAPPER_TIMESTAMP - Static variable in class de.dlr.proseo.basewrap.BaseWrapper
Deprecated.
wrapperDataDirectory - Variable in class de.dlr.proseo.basewrap.BaseWrapper
Directory for temporary/output files created by this wrapper
WrapperException() - Constructor for exception class de.dlr.proseo.basewrap.BaseWrapper.WrapperException
 
B C D E F G H I J L M P R S U V W 
All Classes and Interfaces|All Packages|Serialized Form