eu.dnetlib.api.data

Interface DatasourceManagerService

All Superinterfaces:

DriverService

public interface DatasourceManagerService
extends DriverService

Method Summary

Modifier and Type	Method and Description
boolean	addDatasource(eu.dnetlib.domain.data.Repository repository) Register a datasource.
boolean	addInterface(String dsId, eu.dnetlib.domain.data.RepositoryInterface iface) Add an interface to a datasource.
boolean	deleteAccessParamOrExtraField(String dsId, String ifaceId, String field) delete a generic extra field or an access param of an interface.
boolean	deleteDatasource(String dsId) Delete a datasource.
boolean	deleteInterface(String dsId, String ifaceId) Delete the interface of a datasource.
Date	findNextScheduledExecution(String dsId, String ifaceId) Calculate the next execution date of a related metaworkflow
eu.dnetlib.domain.data.Repository	getDatasource(String dsId) Returns a datasource.
List<eu.dnetlib.domain.data.Repository>	listAllDatasources() Returns all the datasources.
List<eu.dnetlib.domain.data.Repository>	listDatasourcesUsingFilter(String compliance, String contentDescription, String iisProcessingWorkflow, String collectedFrom) Returns the datasources with some properties.
boolean	setIisProcessingWorkflow(String dsId, String ifaceId, String wf) update the "iis_processing_workflow" property of an interface.
boolean	updateAccessParam(String dsId, String ifaceId, String field, String value, boolean preserveOriginal) Update an access param of an interface.
boolean	updateActivationStatus(String dsId, String ifaceId, boolean active) update the activation status of an interface (true = there is a related wf).
boolean	updateBaseUrl(String dsId, String ifaceId, String baseUrl) update the baseUrl of an interface.
boolean	updateContentDescription(String dsId, String ifaceId, String desc) update the "contentDescription" property of an interface.
boolean	updateExtraField(String dsId, String ifaceId, String field, String value, boolean preserveOriginal) Set a generic extra field of an interface.
boolean	updateLevelOfCompliance(String dsId, String ifaceId, String level) updates the level of compliance of a datasource.
boolean	updateSQL(String dsId, String sql, boolean delete) Perform a generic SQL update on a datasource.

Methods inherited from interface eu.dnetlib.api.DriverService

identify, notify

Method Detail

addDatasource

boolean addDatasource(eu.dnetlib.domain.data.Repository repository)
               throws DatasourceManagerServiceException

Register a datasource.

Parameters:

ds - the new datasource

Throws:

DatasourceManagerServiceException

deleteDatasource

boolean deleteDatasource(String dsId)
                  throws DatasourceManagerServiceException

Delete a datasource.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

Throws:

DatasourceManagerServiceException

getDatasource

eu.dnetlib.domain.data.Repository getDatasource(String dsId)
                                         throws DatasourceManagerServiceException

Returns a datasource.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

Throws:

DatasourceManagerServiceException

listAllDatasources

List<eu.dnetlib.domain.data.Repository> listAllDatasources()
                                                    throws DatasourceManagerServiceException

Returns all the datasources.

Returns:

a list of XML profiles

Throws:

DatasourceManagerServiceException

listDatasourcesUsingFilter

List<eu.dnetlib.domain.data.Repository> listDatasourcesUsingFilter(String compliance,
                                                                   String contentDescription,
                                                                   String iisProcessingWorkflow,
                                                                   String collectedFrom)
                                                            throws DatasourceManagerServiceException

Returns the datasources with some properties.

Parameters:

compliance - the level of compliance (or NULL to skip the test)

fileManagementMode - the fileManagementMode property (or NULL to skip the test)

contentDescription - the contentDescription property (or NULL to skip the test)

iisProcessingWorkflow - the iisProcessingWorkflow property (or NULL to skip the test)

Returns:

a list of XML profiles

Throws:

DatasourceManagerServiceException

updateLevelOfCompliance

boolean updateLevelOfCompliance(String dsId,
                                String ifaceId,
                                String level)
                         throws DatasourceManagerServiceException

updates the level of compliance of a datasource.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifaceId - the interface id

level - the new level of compliance

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

updateBaseUrl

boolean updateBaseUrl(String dsId,
                      String ifaceId,
                      String baseUrl)
               throws DatasourceManagerServiceException

update the baseUrl of an interface.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifaceId - the interface id

baseUrl - the new value

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

updateActivationStatus

boolean updateActivationStatus(String dsId,
                               String ifaceId,
                               boolean active)
                        throws DatasourceManagerServiceException

update the activation status of an interface (true = there is a related wf).

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifaceId - the interface id

active - true if there is a related wf

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

updateContentDescription

boolean updateContentDescription(String dsId,
                                 String ifaceId,
                                 String desc)
                          throws DatasourceManagerServiceException

update the "contentDescription" property of an interface.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifaceId - the interface id

desc - the new value

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

setIisProcessingWorkflow

boolean setIisProcessingWorkflow(String dsId,
                                 String ifaceId,
                                 String wf)
                          throws DatasourceManagerServiceException

update the "iis_processing_workflow" property of an interface.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifaceId - the interface id

wf - the new value

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

updateExtraField

boolean updateExtraField(String dsId,
                         String ifaceId,
                         String field,
                         String value,
                         boolean preserveOriginal)
                  throws DatasourceManagerServiceException

Set a generic extra field of an interface.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifaceId - the interface id

field - the field name

value - the new value (or null for removing it)

preserveOriginal - preserve the original value in the DB (the value is stored in the "edited" column)

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

updateAccessParam

boolean updateAccessParam(String dsId,
                          String ifaceId,
                          String field,
                          String value,
                          boolean preserveOriginal)
                   throws DatasourceManagerServiceException

Update an access param of an interface.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifaceId - the interface id

field - the field name

value - the new value (or null for removing it)

preserveOriginal - preserve the original value in the DB (the value is stored in the "edited" column)

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

deleteAccessParamOrExtraField

boolean deleteAccessParamOrExtraField(String dsId,
                                      String ifaceId,
                                      String field)
                               throws DatasourceManagerServiceException

delete a generic extra field or an access param of an interface.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifaceId - the interface id

field - the field name

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

addInterface

boolean addInterface(String dsId,
                     eu.dnetlib.domain.data.RepositoryInterface iface)
              throws DatasourceManagerServiceException

Add an interface to a datasource.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

iface - the interface description

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

deleteInterface

boolean deleteInterface(String dsId,
                        String ifaceId)
                 throws DatasourceManagerServiceException

Delete the interface of a datasource.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifcId - the id of the interface

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

updateSQL

boolean updateSQL(String dsId,
                  String sql,
                  boolean delete)
           throws DatasourceManagerServiceException

Perform a generic SQL update on a datasource.

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

sql - the sql query to insert/update/delete the datasource

delete - true if the profile must be deleted

Returns:

true if the operation ends successfully

Throws:

DatasourceManagerServiceException

findNextScheduledExecution

Date findNextScheduledExecution(String dsId,
                                String ifaceId)
                         throws DatasourceManagerServiceException

Calculate the next execution date of a related metaworkflow

Parameters:

dsId - the OpenAireDataSourceId (example: opendoar____::2101)

ifcId - the id of the interface

Returns:

the date of the next scheduled execution (or null)

Throws:

DatasourceManagerServiceException