org.gcube.datatransformation.rest.commons

Interface DataTransformationServiceAPI

public interface DataTransformationServiceAPI

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCOPE_HEADER

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findApplicableTransformationUnits(String scope, String sourceContentTypeJSON, String targetContentTypeJSON, String createAndPublishCompositeTPJSON, Boolean pretty)
javax.ws.rs.core.Response	findAvailableTargetContentTypes(String scope, String sourceContentTypeJSON, Boolean pretty)
javax.ws.rs.core.Response	queryTransformationPrograms(String scope, String queryJSON, Boolean pretty)
javax.ws.rs.core.Response	statistics(String scope)
javax.ws.rs.core.Response	transformData(String scope, String inputJSON, String targetContentTypeJSON, String outputJSON, String createReportJSON, Boolean all, Boolean pretty)
javax.ws.rs.core.Response	transformDataWithTransformationProgram(String scope, String inputJSON, String tpIDJSON, String targetContentTypeJSON, String tProgramUnboundParametersJSON, String outputJSON, String createReportJSON, Boolean all, Boolean pretty)
javax.ws.rs.core.Response	transformDataWithTransformationUnit(String scope, String inputsJSON, String tpIDJSON, String transformationUnitIDJSON, String targetContentTypeJSON, String tProgramUnboundParametersJSON, String outputJSON, String filterSourcesJSON, String createReportJSON, Boolean all, Boolean pretty)

Field Detail

SCOPE_HEADER

static final String SCOPE_HEADER

See Also:

Constant Field Values

Method Detail

statistics

@GET
@Path(value="/statistics")
@Produces(value="application/xml; charset=UTF-8")
javax.ws.rs.core.Response statistics(@HeaderParam(value="gcube-scope")
                                                     String scope)

transformData

@POST
@Path(value="/transformData")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response transformData(@HeaderParam(value="gcube-scope")
                                                         String scope,
                                                         @FormParam(value="input")
                                                         String inputJSON,
                                                         @FormParam(value="targetContentType")
                                                         String targetContentTypeJSON,
                                                         @FormParam(value="output")
                                                         String outputJSON,
                                                         @FormParam(value="createReport")
                                                         String createReportJSON,
                                                         @QueryParam(value="all")@DefaultValue(value="false")
                                                         Boolean all,
                                                         @QueryParam(value="pretty")@DefaultValue(value="false")
                                                         Boolean pretty)

transformDataWithTransformationProgram

@POST
@Path(value="/transformDataWithTransformationProgram")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response transformDataWithTransformationProgram(@HeaderParam(value="gcube-scope")
                                                                                  String scope,
                                                                                  @FormParam(value="input")
                                                                                  String inputJSON,
                                                                                  @FormParam(value="tpID")
                                                                                  String tpIDJSON,
                                                                                  @FormParam(value="targetContentType")
                                                                                  String targetContentTypeJSON,
                                                                                  @FormParam(value="tProgramUnboundParameters")
                                                                                  String tProgramUnboundParametersJSON,
                                                                                  @FormParam(value="output")
                                                                                  String outputJSON,
                                                                                  @FormParam(value="createReport")
                                                                                  String createReportJSON,
                                                                                  @QueryParam(value="all")@DefaultValue(value="false")
                                                                                  Boolean all,
                                                                                  @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                                  Boolean pretty)

transformDataWithTransformationUnit

@POST
@Path(value="/transformDataWithTransformationUnit")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response transformDataWithTransformationUnit(@HeaderParam(value="gcube-scope")
                                                                               String scope,
                                                                               @FormParam(value="inputs")
                                                                               String inputsJSON,
                                                                               @FormParam(value="tpID")
                                                                               String tpIDJSON,
                                                                               @FormParam(value="transformationUnitID")
                                                                               String transformationUnitIDJSON,
                                                                               @FormParam(value="targetContentType")
                                                                               String targetContentTypeJSON,
                                                                               @FormParam(value="tProgramUnboundParameters")
                                                                               String tProgramUnboundParametersJSON,
                                                                               @FormParam(value="output")
                                                                               String outputJSON,
                                                                               @FormParam(value="filterSources")
                                                                               String filterSourcesJSON,
                                                                               @FormParam(value="createReport")
                                                                               String createReportJSON,
                                                                               @QueryParam(value="all")@DefaultValue(value="false")
                                                                               Boolean all,
                                                                               @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                               Boolean pretty)

findApplicableTransformationUnits

@POST
@Path(value="/findApplicableTransformationUnits")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response findApplicableTransformationUnits(@HeaderParam(value="gcube-scope")
                                                                             String scope,
                                                                             @FormParam(value="sourceContentType")
                                                                             String sourceContentTypeJSON,
                                                                             @FormParam(value="targetContentType")
                                                                             String targetContentTypeJSON,
                                                                             @FormParam(value="createAndPublishCompositeTP")
                                                                             String createAndPublishCompositeTPJSON,
                                                                             @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                             Boolean pretty)

findAvailableTargetContentTypes

@POST
@Path(value="/findAvailableTargetContentTypes")
@Produces(value="application/json; charset=UTF-8")
javax.ws.rs.core.Response findAvailableTargetContentTypes(@HeaderParam(value="gcube-scope")
                                                                           String scope,
                                                                           @FormParam(value="sourceContentType")
                                                                           String sourceContentTypeJSON,
                                                                           @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                           Boolean pretty)

queryTransformationPrograms

@POST
@Path(value="/queryTransformationPrograms")
@Produces(value="application/xml; charset=UTF-8")
javax.ws.rs.core.Response queryTransformationPrograms(@HeaderParam(value="gcube-scope")
                                                                       String scope,
                                                                       @FormParam(value="query")
                                                                       String queryJSON,
                                                                       @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                       Boolean pretty)