Revision 47024
Added by Antonis Lempesis over 7 years ago
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/data/SimilarityService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.data; |
|
2 |
|
|
3 |
import java.util.List; |
|
4 |
|
|
5 |
import eu.dnetlib.api.DriverService; |
|
6 |
import eu.dnetlib.domain.data.SimilarDocument; |
|
7 |
|
|
8 |
public interface SimilarityService extends DriverService { |
|
9 |
|
|
10 |
/** |
|
11 |
* Returns a list of similar documents which are similar to document with |
|
12 |
* specified id. No additional values are returned (only ids and score) |
|
13 |
* |
|
14 |
* @param id The specified id |
|
15 |
* @return a list of {@link SimilarDocument} |
|
16 |
*/ |
|
17 |
public List<SimilarDocument> getSimilarDocuments(String id) |
|
18 |
throws SimilarityServiceException; |
|
19 |
|
|
20 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/data/PublisherServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.data; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverServiceException; |
|
4 |
|
|
5 |
public class PublisherServiceException extends DriverServiceException { |
|
6 |
|
|
7 |
private static final long serialVersionUID = 6956403917254162285L; |
|
8 |
|
|
9 |
public PublisherServiceException(String message) { |
|
10 |
super(message); |
|
11 |
} |
|
12 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/data/MDStoreService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.data; |
|
2 |
|
|
3 |
import java.util.List; |
|
4 |
|
|
5 |
import eu.dnetlib.api.DriverService; |
|
6 |
import eu.dnetlib.domain.EPR; |
|
7 |
|
|
8 |
/** |
|
9 |
* Created by antleb on 9/8/14. |
|
10 |
*/ |
|
11 |
public interface MDStoreService extends DriverService { |
|
12 |
|
|
13 |
public EPR deliverMDRecords(String mdStoreId, String from, String until, String recordsFilter) throws MDStoreServiceException; |
|
14 |
|
|
15 |
public String deliverRecord(String mdStoreId, String recordId) throws MDStoreServiceException; |
|
16 |
|
|
17 |
public List<String> getListOfMDStores() throws MDStoreServiceException; |
|
18 |
|
|
19 |
public List<String> listMDStores(String format, String layout, String interpretation) throws MDStoreServiceException; |
|
20 |
|
|
21 |
public EPR bulkDeliverMDRecords(String format, String layout, String interpretation) throws MDStoreServiceException; |
|
22 |
|
|
23 |
public boolean storeMDRecordsFromRS(String mdStoreId, String resultSetId, String storingType) throws MDStoreServiceException; |
|
24 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/ActionManagerService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import java.util.List; |
|
4 |
|
|
5 |
import eu.dnetlib.actionmanager.common.Agent; |
|
6 |
import eu.dnetlib.actionmanager.common.Operation; |
|
7 |
import eu.dnetlib.actionmanager.common.Provenance; |
|
8 |
import eu.dnetlib.actionmanager.rmi.ActionManagerException; |
|
9 |
import eu.dnetlib.actionmanager.set.ActionManagerSet; |
|
10 |
import eu.dnetlib.api.DriverService; |
|
11 |
|
|
12 |
public interface ActionManagerService extends DriverService { |
|
13 |
public String createSet(ActionManagerSet set) throws ActionManagerException; |
|
14 |
|
|
15 |
public List<ActionManagerSet> ListSets() throws ActionManagerException; |
|
16 |
|
|
17 |
public String createAction( |
|
18 |
String splitRuleId, |
|
19 |
String set, |
|
20 |
Agent agent, |
|
21 |
Operation operation, |
|
22 |
String infoPackage, |
|
23 |
Provenance provenance, |
|
24 |
String trust, |
|
25 |
String nsprefix) throws ActionManagerException; |
|
26 |
|
|
27 |
public String updateAction( |
|
28 |
String actionId, |
|
29 |
String splitRuleId, |
|
30 |
String set, |
|
31 |
Agent agent, |
|
32 |
Operation operation, |
|
33 |
String infoPackage, |
|
34 |
Provenance provenance, |
|
35 |
String trust, |
|
36 |
String nsprefix) throws ActionManagerException; |
|
37 |
|
|
38 |
public boolean deleteAction(String actionId) throws ActionManagerException; |
|
39 |
|
|
40 |
public List<String> getActionsByAgent(String agentId, int limit) |
|
41 |
throws ActionManagerException; |
|
42 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/HostingNodeManagerService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverService; |
|
4 |
|
|
5 |
public interface HostingNodeManagerService extends DriverService { |
|
6 |
|
|
7 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/data/DatasourceManagerService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.data; |
|
2 |
|
|
3 |
import java.util.Date; |
|
4 |
import java.util.List; |
|
5 |
|
|
6 |
import javax.jws.WebParam; |
|
7 |
|
|
8 |
import eu.dnetlib.api.DriverService; |
|
9 |
import eu.dnetlib.domain.data.Repository; |
|
10 |
import eu.dnetlib.domain.data.RepositoryInterface; |
|
11 |
|
|
12 |
public interface DatasourceManagerService extends DriverService { |
|
13 |
|
|
14 |
/** |
|
15 |
* Register a datasource. |
|
16 |
* |
|
17 |
* @param ds |
|
18 |
* the new datasource |
|
19 |
* @throws DatasourceManagerServiceException |
|
20 |
*/ |
|
21 |
public boolean addDatasource(Repository repository) |
|
22 |
throws DatasourceManagerServiceException; |
|
23 |
|
|
24 |
/** |
|
25 |
* Delete a datasource. |
|
26 |
* |
|
27 |
* @param dsId |
|
28 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
29 |
* @throws DatasourceManagerServiceException |
|
30 |
*/ |
|
31 |
public boolean deleteDatasource(String dsId) |
|
32 |
throws DatasourceManagerServiceException; |
|
33 |
|
|
34 |
/** |
|
35 |
* Returns a datasource. |
|
36 |
* |
|
37 |
* @param dsId |
|
38 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
39 |
* @throws DatasourceManagerServiceException |
|
40 |
*/ |
|
41 |
public Repository getDatasource(String dsId) |
|
42 |
throws DatasourceManagerServiceException; |
|
43 |
|
|
44 |
/** |
|
45 |
* Returns all the datasources. |
|
46 |
* |
|
47 |
* @return a list of XML profiles |
|
48 |
* @throws DatasourceManagerServiceException |
|
49 |
*/ |
|
50 |
public List<Repository> listAllDatasources() |
|
51 |
throws DatasourceManagerServiceException; |
|
52 |
|
|
53 |
/** |
|
54 |
* Returns the datasources with some properties. |
|
55 |
* |
|
56 |
* @param compliance |
|
57 |
* the level of compliance (or NULL to skip the test) |
|
58 |
* @param fileManagementMode |
|
59 |
* the fileManagementMode property (or NULL to skip the test) |
|
60 |
* @param contentDescription |
|
61 |
* the contentDescription property (or NULL to skip the test) |
|
62 |
* @param iisProcessingWorkflow |
|
63 |
* the iisProcessingWorkflow property (or NULL to skip the test) |
|
64 |
* @return a list of XML profiles |
|
65 |
* @throws DatasourceManagerServiceException |
|
66 |
*/ |
|
67 |
public List<Repository> listDatasourcesUsingFilter(String compliance, |
|
68 |
String contentDescription, String iisProcessingWorkflow, String collectedFrom) |
|
69 |
throws DatasourceManagerServiceException; |
|
70 |
|
|
71 |
/** |
|
72 |
* updates the level of compliance of a datasource. |
|
73 |
* |
|
74 |
* @param dsId |
|
75 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
76 |
* @param ifaceId |
|
77 |
* the interface id |
|
78 |
* @param level |
|
79 |
* the new level of compliance |
|
80 |
* @return true if the operation ends successfully |
|
81 |
* @throws DatasourceManagerServiceException |
|
82 |
*/ |
|
83 |
public boolean updateLevelOfCompliance(String dsId, String ifaceId, |
|
84 |
String level) throws DatasourceManagerServiceException; |
|
85 |
|
|
86 |
/** |
|
87 |
* update the baseUrl of an interface. |
|
88 |
* |
|
89 |
* @param dsId |
|
90 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
91 |
* @param ifaceId |
|
92 |
* the interface id |
|
93 |
* @param baseUrl |
|
94 |
* the new value |
|
95 |
* @return true if the operation ends successfully |
|
96 |
* @throws DatasourceManagerServiceException |
|
97 |
*/ |
|
98 |
public boolean updateBaseUrl(String dsId, String ifaceId, String baseUrl) |
|
99 |
throws DatasourceManagerServiceException; |
|
100 |
|
|
101 |
/** |
|
102 |
* update the activation status of an interface (true = there is a related |
|
103 |
* wf). |
|
104 |
* |
|
105 |
* @param dsId |
|
106 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
107 |
* @param ifaceId |
|
108 |
* the interface id |
|
109 |
* @param active |
|
110 |
* true if there is a related wf |
|
111 |
* @return true if the operation ends successfully |
|
112 |
* @throws DatasourceManagerServiceException |
|
113 |
*/ |
|
114 |
public boolean updateActivationStatus(String dsId, String ifaceId, |
|
115 |
boolean active) throws DatasourceManagerServiceException; |
|
116 |
|
|
117 |
/** |
|
118 |
* update the "contentDescription" property of an interface. |
|
119 |
* |
|
120 |
* @param dsId |
|
121 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
122 |
* @param ifaceId |
|
123 |
* the interface id |
|
124 |
* @param desc |
|
125 |
* the new value |
|
126 |
* @return true if the operation ends successfully |
|
127 |
* @throws DatasourceManagerServiceException |
|
128 |
*/ |
|
129 |
public boolean updateContentDescription(String dsId, String ifaceId, |
|
130 |
String desc) throws DatasourceManagerServiceException; |
|
131 |
|
|
132 |
/** |
|
133 |
* update the "iis_processing_workflow" property of an interface. |
|
134 |
* |
|
135 |
* @param dsId |
|
136 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
137 |
* @param ifaceId |
|
138 |
* the interface id |
|
139 |
* @param wf |
|
140 |
* the new value |
|
141 |
* @return true if the operation ends successfully |
|
142 |
* @throws DatasourceManagerServiceException |
|
143 |
*/ |
|
144 |
public boolean setIisProcessingWorkflow(String dsId, String ifaceId, |
|
145 |
String wf) throws DatasourceManagerServiceException; |
|
146 |
|
|
147 |
/** |
|
148 |
* Set a generic extra field of an interface. |
|
149 |
* |
|
150 |
* @param dsId |
|
151 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
152 |
* @param ifaceId |
|
153 |
* the interface id |
|
154 |
* @param field |
|
155 |
* the field name |
|
156 |
* @param value |
|
157 |
* the new value (or null for removing it) |
|
158 |
* @param preserveOriginal |
|
159 |
* preserve the original value in the DB (the value is stored in |
|
160 |
* the "edited" column) |
|
161 |
* @return true if the operation ends successfully |
|
162 |
* @throws DatasourceManagerServiceException |
|
163 |
*/ |
|
164 |
public boolean updateExtraField(String dsId, String ifaceId, String field, |
|
165 |
String value, boolean preserveOriginal) |
|
166 |
throws DatasourceManagerServiceException; |
|
167 |
|
|
168 |
/** |
|
169 |
* Update an access param of an interface. |
|
170 |
* |
|
171 |
* @param dsId |
|
172 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
173 |
* @param ifaceId |
|
174 |
* the interface id |
|
175 |
* @param field |
|
176 |
* the field name |
|
177 |
* @param value |
|
178 |
* the new value (or null for removing it) |
|
179 |
* @param preserveOriginal |
|
180 |
* preserve the original value in the DB (the value is stored in |
|
181 |
* the "edited" column) |
|
182 |
* @return true if the operation ends successfully |
|
183 |
* @throws DatasourceManagerServiceException |
|
184 |
*/ |
|
185 |
public boolean updateAccessParam(String dsId, String ifaceId, String field, |
|
186 |
String value, boolean preserveOriginal) |
|
187 |
throws DatasourceManagerServiceException; |
|
188 |
|
|
189 |
/** |
|
190 |
* delete a generic extra field or an access param of an interface. |
|
191 |
* |
|
192 |
* @param dsId |
|
193 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
194 |
* @param ifaceId |
|
195 |
* the interface id |
|
196 |
* @param field |
|
197 |
* the field name |
|
198 |
* @return true if the operation ends successfully |
|
199 |
* @throws DatasourceManagerServiceException |
|
200 |
*/ |
|
201 |
public boolean deleteAccessParamOrExtraField(String dsId, String ifaceId, |
|
202 |
String field) throws DatasourceManagerServiceException; |
|
203 |
|
|
204 |
/** |
|
205 |
* Add an interface to a datasource. |
|
206 |
* |
|
207 |
* @param dsId |
|
208 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
209 |
* @param iface |
|
210 |
* the interface description |
|
211 |
* @return true if the operation ends successfully |
|
212 |
* @throws DatasourceManagerServiceException |
|
213 |
*/ |
|
214 |
public boolean addInterface(String dsId, RepositoryInterface iface) |
|
215 |
throws DatasourceManagerServiceException; |
|
216 |
|
|
217 |
/** |
|
218 |
* Delete the interface of a datasource. |
|
219 |
* |
|
220 |
* @param dsId |
|
221 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
222 |
* @param ifcId |
|
223 |
* the id of the interface |
|
224 |
* @return true if the operation ends successfully |
|
225 |
* @throws DatasourceManagerServiceException |
|
226 |
*/ |
|
227 |
public boolean deleteInterface(String dsId, String ifaceId) |
|
228 |
throws DatasourceManagerServiceException; |
|
229 |
|
|
230 |
/** |
|
231 |
* Perform a generic SQL update on a datasource. |
|
232 |
* |
|
233 |
* @param dsId |
|
234 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
235 |
* @param sql |
|
236 |
* the sql query to insert/update/delete the datasource |
|
237 |
* @param delete |
|
238 |
* true if the profile must be deleted |
|
239 |
* @return true if the operation ends successfully |
|
240 |
* @throws DatasourceManagerServiceException |
|
241 |
*/ |
|
242 |
public boolean updateSQL(String dsId, String sql, boolean delete) |
|
243 |
throws DatasourceManagerServiceException; |
|
244 |
|
|
245 |
/** |
|
246 |
* Calculate the next execution date of a related metaworkflow |
|
247 |
* |
|
248 |
* @param dsId |
|
249 |
* the OpenAireDataSourceId (example: opendoar____::2101) |
|
250 |
* @param ifcId |
|
251 |
* the id of the interface |
|
252 |
* @return the date of the next scheduled execution (or null) |
|
253 |
* @throws DatasourceManagerServiceException |
|
254 |
*/ |
|
255 |
public Date findNextScheduledExecution(@WebParam(name = "dsId") String dsId, @WebParam(name = "ifaceId") String ifaceId) throws DatasourceManagerServiceException; |
|
256 |
|
|
257 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/ISLookUpService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import java.util.List; |
|
4 |
|
|
5 |
import eu.dnetlib.api.DriverService; |
|
6 |
import eu.dnetlib.domain.EPR; |
|
7 |
|
|
8 |
public interface ISLookUpService extends DriverService { |
|
9 |
|
|
10 |
public EPR searchProfile(String XQuery) throws ISLookUpServiceException; |
|
11 |
|
|
12 |
public List<String> quickSearchProfile(String XQuery) |
|
13 |
throws ISLookUpServiceException; |
|
14 |
|
|
15 |
public String getResourceProfile(String profId) |
|
16 |
throws ISLookUpServiceException; |
|
17 |
|
|
18 |
public String getResourceProfileByQuery(String XQuery) |
|
19 |
throws ISLookUpServiceException; |
|
20 |
|
|
21 |
public List<String> listResourceTypes() throws ISLookUpServiceException; |
|
22 |
|
|
23 |
public String getResourceTypeSchema(String resourceType) |
|
24 |
throws ISLookUpServiceException; |
|
25 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/pom.xml | ||
---|---|---|
1 |
<?xml version="1.0" ?> |
|
2 |
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> |
|
3 |
<parent> |
|
4 |
<groupId>eu.dnetlib</groupId> |
|
5 |
<artifactId>dnet-parent</artifactId> |
|
6 |
<version>1.0.0</version> |
|
7 |
</parent> |
|
8 |
<modelVersion>4.0.0</modelVersion> |
|
9 |
<groupId>eu.dnetlib</groupId> |
|
10 |
<artifactId>uoa-api</artifactId> |
|
11 |
<packaging>jar</packaging> |
|
12 |
<version>1.2.1</version> |
|
13 |
<scm> |
|
14 |
<developerConnection>scm:svn:https://svn.driver.research-infrastructures.eu/driver/dnet40/modules/uoa-api/tags/uoa-api-1.2.1</developerConnection> |
|
15 |
</scm> |
|
16 |
<dependencies> |
|
17 |
<dependency> |
|
18 |
<groupId>eu.dnetlib</groupId> |
|
19 |
<artifactId>dnet-actionmanager-api</artifactId> |
|
20 |
<version>[3.0.0, 4.0.0)</version> |
|
21 |
</dependency> |
|
22 |
<dependency> |
|
23 |
<groupId>eu.dnetlib</groupId> |
|
24 |
<artifactId>uoa-domain</artifactId> |
|
25 |
<version>[1.0.0, 2.0.0)</version> |
|
26 |
</dependency> |
|
27 |
<dependency> |
|
28 |
<groupId>junit</groupId> |
|
29 |
<artifactId>junit</artifactId> |
|
30 |
<version>[0.0.0,)</version> |
|
31 |
<scope>test</scope> |
|
32 |
</dependency> |
|
33 |
</dependencies> |
|
34 |
</project> |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/ISLookUpServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverServiceException; |
|
4 |
|
|
5 |
public class ISLookUpServiceException extends DriverServiceException { |
|
6 |
private static final long serialVersionUID = 2971319868850757633L; |
|
7 |
|
|
8 |
public ISLookUpServiceException() { |
|
9 |
super(); |
|
10 |
} |
|
11 |
|
|
12 |
public ISLookUpServiceException(String message, Throwable cause) { |
|
13 |
super(message, cause); |
|
14 |
} |
|
15 |
|
|
16 |
public ISLookUpServiceException(String message) { |
|
17 |
super(message); |
|
18 |
} |
|
19 |
|
|
20 |
public ISLookUpServiceException(Throwable cause) { |
|
21 |
super(cause); |
|
22 |
} |
|
23 |
|
|
24 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/ValidatorService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
import java.util.List; |
|
4 |
|
|
5 |
import eu.dnetlib.api.DriverService; |
|
6 |
import eu.dnetlib.domain.functionality.validator.JobForValidation; |
|
7 |
import eu.dnetlib.domain.functionality.validator.RuleSet; |
|
8 |
import eu.dnetlib.domain.functionality.validator.StoredJob; |
|
9 |
|
|
10 |
public interface ValidatorService extends DriverService { |
|
11 |
|
|
12 |
StoredJob getStoredJob(int jobId, String groupBy) throws ValidatorServiceException; |
|
13 |
|
|
14 |
List<StoredJob> getStoredJobs(String userMail, String jobType, Integer offset, Integer limit, String dateFrom, String dateTo) throws ValidatorServiceException; |
|
15 |
|
|
16 |
int getStoredJobsTotalNumber(String userMail, String jobType) throws ValidatorServiceException; |
|
17 |
|
|
18 |
List<StoredJob> getStoredJobsNew(String userMail, String jobType, Integer offset, Integer limit, String dateFrom, String dateTo, String jobStatus) throws ValidatorServiceException; |
|
19 |
|
|
20 |
int getStoredJobsTotalNumberNew(String userMail, String jobType, String jobStatus) throws ValidatorServiceException; |
|
21 |
|
|
22 |
List<RuleSet> getRuleSets() throws ValidatorServiceException; |
|
23 |
|
|
24 |
void submitValidationJob(JobForValidation job) throws ValidatorServiceException; |
|
25 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/LocalDownloadManagerService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverService; |
|
4 |
|
|
5 |
public interface LocalDownloadManagerService extends DriverService { |
|
6 |
|
|
7 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/data/SearchService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.data; |
|
2 |
|
|
3 |
import java.util.Collection; |
|
4 |
|
|
5 |
import eu.dnetlib.api.DriverService; |
|
6 |
import eu.dnetlib.domain.data.FormattedSearchResult; |
|
7 |
import eu.dnetlib.domain.data.SearchResult; |
|
8 |
import eu.dnetlib.domain.data.SuggestiveResult; |
|
9 |
|
|
10 |
public interface SearchService extends DriverService { |
|
11 |
|
|
12 |
/** |
|
13 |
* Returns search results for given query containing the request parameters and |
|
14 |
* the list of search result XML records as it is derived after the application of |
|
15 |
* the xslt tranfrormer. |
|
16 |
* |
|
17 |
* @param queryText the query |
|
18 |
* @param transformer the name of the xslt transformer for search results |
|
19 |
* @param locale the locale |
|
20 |
* @param page the search result page |
|
21 |
* @param size the search result page size |
|
22 |
* @return {@link SearchResult} containing the request parameters and the list of |
|
23 |
* search result xml records |
|
24 |
* |
|
25 |
* @throws SearchServiceException |
|
26 |
*/ |
|
27 |
public SearchResult search(String queryText, String transformer, |
|
28 |
String locale, int page, int size) throws SearchServiceException; |
|
29 |
|
|
30 |
/** |
|
31 |
* Returns refine results of given query containing the request parameters and |
|
32 |
* the list of refine XML records as it is derived after the application of |
|
33 |
* the xslt transfrormer. |
|
34 |
* @param queryText the query |
|
35 |
* @param transformer the name of the xslt transformer for refine results |
|
36 |
* @param format the format |
|
37 |
* @param locale the locale |
|
38 |
* @param fields the fields to include in refine results |
|
39 |
* @return {@link SearchResult} containing the request parameters and the list of refine xml records |
|
40 |
* |
|
41 |
* @throws SearchServiceException |
|
42 |
*/ |
|
43 |
public SearchResult refine(String queryText, String transformer, |
|
44 |
String locale, Collection<String> fields) throws SearchServiceException; |
|
45 |
|
|
46 |
/** |
|
47 |
* Returns search and refine results containing the request parameters, the list |
|
48 |
* of XML search records and the list of XML refine records as it is derived after |
|
49 |
* the application of the xslt tranfrormers. |
|
50 |
* @param queryText the query |
|
51 |
* @param searchTransformer the xslt transformer of search results |
|
52 |
* @param refineTransformer the xslt transformer of refine results |
|
53 |
* @param format the format |
|
54 |
* @param locale the locale |
|
55 |
* @param page the search result page |
|
56 |
* @param size the search result page size |
|
57 |
* @param fields the fields to include in refine |
|
58 |
* @return {@link SearchResult} containing the request parameters, the list |
|
59 |
* of search records and the list of refine records |
|
60 |
* |
|
61 |
* @throws SearchServiceException |
|
62 |
*/ |
|
63 |
public SearchResult searchNrefine(String queryText, String searchTransformer, String refineTransformer, |
|
64 |
String locale, int page, int size, Collection<String> fields) throws SearchServiceException; |
|
65 |
|
|
66 |
/** |
|
67 |
* Returns a {@link FormattedSearchResult} containing the formatted results of search |
|
68 |
* @param queryText the query |
|
69 |
* @param transformer the name of the transformer for refine results |
|
70 |
* @param format the format |
|
71 |
* @param locale the locale |
|
72 |
* @param fields the fields to include in refine results |
|
73 |
* @return {@link FormattedSearchResult} containing the formatted results of refine |
|
74 |
* |
|
75 |
* @throws SearchServiceException */ |
|
76 |
public FormattedSearchResult search(String queryText, String transformer, String format, |
|
77 |
String locale, int page, int size) throws SearchServiceException; |
|
78 |
|
|
79 |
/** |
|
80 |
* Returns a {@link FormattedSearchResult} containing the formatted results of refine |
|
81 |
* @param queryText the query |
|
82 |
* @param searchTransformer the transformer of search results |
|
83 |
* @param refineTransformer the transformer of refine results |
|
84 |
* @param format the format |
|
85 |
* @param locale the locale |
|
86 |
* @param page the search result page |
|
87 |
* @param size the search result page size |
|
88 |
* @param fields the fields to include in refine |
|
89 |
* @return {@link FormattedSearchResult} containing the formatted results of refine and search |
|
90 |
* @throws SearchServiceException |
|
91 |
*/ |
|
92 |
public FormattedSearchResult refine(String queryText, String refineTransformer, |
|
93 |
String format, String locale, Collection<String> fields) |
|
94 |
throws SearchServiceException; |
|
95 |
|
|
96 |
/** |
|
97 |
* Returns a {@link FormattedSearchResult} containing the formatted results of refine and search |
|
98 |
* @param queryText the query |
|
99 |
* @param searchTransformer the transformer of search results |
|
100 |
* @param refineTransformer the transformer of refine results |
|
101 |
* @param format the format |
|
102 |
* @param locale the locale |
|
103 |
* @param page the search result page |
|
104 |
* @param size the search result page size |
|
105 |
* @param fields the fields to include in refine |
|
106 |
* @return {@link FormattedSearchResult} containing the formatted results of refine and search */ |
|
107 |
public FormattedSearchResult searchNrefine(String queryText, String searchTransformer, String refineTransformer, |
|
108 |
String format, String locale, int page, int size, Collection<String> fields) throws SearchServiceException; |
|
109 |
|
|
110 |
public SuggestiveResult suggestiveSearch(String query) throws SearchServiceException; |
|
111 |
|
|
112 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/data/IndexService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.data; |
|
2 |
|
|
3 |
import java.util.List; |
|
4 |
|
|
5 |
import eu.dnetlib.api.DriverService; |
|
6 |
import eu.dnetlib.domain.EPR; |
|
7 |
import eu.dnetlib.domain.data.Hint; |
|
8 |
|
|
9 |
public interface IndexService extends DriverService { |
|
10 |
|
|
11 |
public EPR indexLookup(String id, String query, String mdformat, |
|
12 |
String layout) throws IndexServiceException; |
|
13 |
|
|
14 |
public Hint suggestiveSearch(String id, String query, |
|
15 |
String mdformat, String layout, String heuristicProfileName) |
|
16 |
throws IndexServiceException; |
|
17 |
|
|
18 |
public EPR getBrowsingStatistics(String query, String index, |
|
19 |
String mdFormatId, String layoutId) throws IndexServiceException; |
|
20 |
|
|
21 |
public List<String> getListOfIndices() throws IndexServiceException; |
|
22 |
|
|
23 |
public String getIndexStatistics(String index) throws IndexServiceException; |
|
24 |
|
|
25 |
public String getListOfIndicesCSV() throws IndexServiceException; |
|
26 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/ISSNService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import java.util.List; |
|
4 |
|
|
5 |
import eu.dnetlib.api.DriverService; |
|
6 |
import eu.dnetlib.domain.EPR; |
|
7 |
|
|
8 |
public interface ISSNService extends DriverService { |
|
9 |
String getCurrentMessage(String topic) throws ISSNServiceException; |
|
10 |
|
|
11 |
boolean pauseSubscription(String subscrId) throws ISSNServiceException; |
|
12 |
|
|
13 |
boolean renew(String subscrId, int terminationTime) throws ISSNServiceException; |
|
14 |
|
|
15 |
boolean resumeSubscription(String subscrId) throws ISSNServiceException; |
|
16 |
|
|
17 |
String subscribe( |
|
18 |
EPR consumerReference, |
|
19 |
String topicExpression, |
|
20 |
int initialTerminationTime) throws ISSNServiceException; |
|
21 |
|
|
22 |
boolean unsubscribe(String subscrId) throws ISSNServiceException; |
|
23 |
|
|
24 |
boolean actionCreatePerformed( |
|
25 |
String resourceType, |
|
26 |
String profileId, |
|
27 |
String profile) throws ISSNServiceException; |
|
28 |
|
|
29 |
boolean actionUpdatePerformed( |
|
30 |
String resourceType, |
|
31 |
String profileId, |
|
32 |
String profileBefore, |
|
33 |
String profileAfter) throws ISSNServiceException; |
|
34 |
|
|
35 |
boolean actionDeletePerformed(String resourceType, String profileId) |
|
36 |
throws ISSNServiceException; |
|
37 |
|
|
38 |
List<String> listSubscriptions(); |
|
39 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/data/SimilarityServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.data; |
|
2 |
|
|
3 |
public class SimilarityServiceException extends Exception { |
|
4 |
|
|
5 |
private static final long serialVersionUID = -4552557846773396398L; |
|
6 |
|
|
7 |
public SimilarityServiceException() { |
|
8 |
super(); |
|
9 |
|
|
10 |
} |
|
11 |
|
|
12 |
public SimilarityServiceException(String message, Throwable cause) { |
|
13 |
super(message, cause); |
|
14 |
|
|
15 |
} |
|
16 |
|
|
17 |
public SimilarityServiceException(String message) { |
|
18 |
super(message); |
|
19 |
|
|
20 |
} |
|
21 |
|
|
22 |
public SimilarityServiceException(Throwable cause) { |
|
23 |
super(cause); |
|
24 |
|
|
25 |
} |
|
26 |
|
|
27 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/DriverServiceEndpoint.java | ||
---|---|---|
1 |
package eu.dnetlib.api; |
|
2 |
|
|
3 |
public interface DriverServiceEndpoint<S extends DriverService> { |
|
4 |
|
|
5 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/AlertService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
import java.net.URI; |
|
4 |
import java.net.URL; |
|
5 |
import java.util.Date; |
|
6 |
import java.util.SortedSet; |
|
7 |
|
|
8 |
import eu.dnetlib.api.DriverService; |
|
9 |
import eu.dnetlib.domain.functionality.AlertSubscription; |
|
10 |
import eu.dnetlib.domain.functionality.AlertTemplate; |
|
11 |
import eu.dnetlib.domain.functionality.NotificationEvent; |
|
12 |
import eu.dnetlib.domain.functionality.ObjectPage; |
|
13 |
import eu.dnetlib.domain.functionality.ResultPage; |
|
14 |
|
|
15 |
/** |
|
16 |
* This interface declares the available methods of alert service. Alert service is used to manage templates and subscriptions. |
|
17 |
* @author thanos@di.uoa.gr |
|
18 |
* @see eu.dnetlib.domain.functionality.AlertTemplate |
|
19 |
* @see eu.dnetlib.domain.functionality.AlertSubscription |
|
20 |
* @see eu.dnetlib.domain.functionality.NotificationEvent |
|
21 |
* @see AlertServiceException |
|
22 |
* |
|
23 |
*/ |
|
24 |
public interface AlertService extends DriverService { |
|
25 |
/** |
|
26 |
* Retrieve all the supported modes in which alerts can be sent. |
|
27 |
* @return a sorted set containing all the supported modes in which alerts can be sent |
|
28 |
*/ |
|
29 |
public SortedSet<String> getSupportedAlertModes(); |
|
30 |
|
|
31 |
/** |
|
32 |
* Retrieve a page of templates. |
|
33 |
* @param pageNumber the number of the page to retrieve |
|
34 |
* @param pageSize the size of the page to retrieve |
|
35 |
* @return an object page containing templates |
|
36 |
* @throws AlertServiceException if any errors occur |
|
37 |
*/ |
|
38 |
public ObjectPage<AlertTemplate> getTemplates(final int pageNumber, final int pageSize) throws AlertServiceException; |
|
39 |
|
|
40 |
/** |
|
41 |
* Add a template. |
|
42 |
* @param template the template to add |
|
43 |
* @throws AlertServiceException if any errors occur |
|
44 |
*/ |
|
45 |
public void addTemplate(final AlertTemplate template) throws AlertServiceException; |
|
46 |
|
|
47 |
/** |
|
48 |
* Remove a template. |
|
49 |
* @param templateId the unique identifier of the template to remove |
|
50 |
* @throws AlertServiceException if any errors occur |
|
51 |
*/ |
|
52 |
public void removeTemplate(final String templateId) throws AlertServiceException; |
|
53 |
|
|
54 |
/** |
|
55 |
* Retrieve a page of subscriptions. |
|
56 |
* @param pageNumber the number of the page to retrieve |
|
57 |
* @param pageSize the size of the page to retrieve |
|
58 |
* @return an object page containing subscriptions |
|
59 |
* @throws AlertServiceException if any errors occur |
|
60 |
*/ |
|
61 |
public ObjectPage<AlertSubscription> getSubscriptions(final int pageNumber, final int pageSize) throws AlertServiceException; |
|
62 |
|
|
63 |
/** |
|
64 |
* Retrieve some subscriptions by alert mode and subscriber. |
|
65 |
* @param alertMode the alert mode of the subscriptions to retrieve |
|
66 |
* @param subscriber the subscriber URI of the subscriptions to retrieve (prefix match) |
|
67 |
* @param limit the maximum number of subscriptions to retrieve |
|
68 |
* @param offset the offset to start at |
|
69 |
* @return a list of subscriptions |
|
70 |
* @throws AlertServiceException if any errors occur |
|
71 |
*/ |
|
72 |
public SortedSet<AlertSubscription> getSubscriptions(final String alerMode, final String subscriber, final int limit, final int offset) throws AlertServiceException; |
|
73 |
|
|
74 |
/** |
|
75 |
* Add a new subscription. |
|
76 |
* @param subscription the subscription to add |
|
77 |
* @throws AlertServiceException if any errors occur |
|
78 |
*/ |
|
79 |
public void addSubscription(final AlertSubscription subscription) throws AlertServiceException; |
|
80 |
|
|
81 |
/** |
|
82 |
* Enable a subscription. |
|
83 |
* @param templateId the unique identifier of the template of the subscription to enable |
|
84 |
* @param notificationService the URL of the notification service of the subscription to enable |
|
85 |
* @param queryId the unique identifier of the notification query of the subscription to enable |
|
86 |
* @param resultId the unique identifier of the result of the subscription to enable |
|
87 |
* @param alertMode the alert mode of the subscription to enable |
|
88 |
* @param subscriber the URI of the subscriber of the subscription to enable |
|
89 |
* @throws AlertServiceException if any errors occur |
|
90 |
*/ |
|
91 |
public void enableSubscription(final String templateId, final URL notificationService, final String queryId, final String resultId, final String alertMode, final URI subscriber) throws AlertServiceException; |
|
92 |
|
|
93 |
/** |
|
94 |
* Disable a subscription. |
|
95 |
* @param templateId the unique identifier of the template the subscription to disable |
|
96 |
* @param notificationService the URL of the notification service of the subscription to disable |
|
97 |
* @param queryId the unique identifier of the notification query of the subscription to disable |
|
98 |
* @param resultId the unique identifier of the result of the subscription to disable |
|
99 |
* @param alertMode the alert mode of the subscription to disable |
|
100 |
* @param subscriber the URI of the subscriber of the subscription to disable |
|
101 |
* @throws AlertServiceException if any errors occur |
|
102 |
*/ |
|
103 |
public void disableSubscription(final String templateId, final URL notificationService, final String queryId, final String resultId, final String alertMode, final URI subscriber) throws AlertServiceException; |
|
104 |
|
|
105 |
/** |
|
106 |
* Remove a subscription. |
|
107 |
* @param templateId the unique identifier of the template of the subscription to remove |
|
108 |
* @param notificationService the URL of the notification service of the subscription to remove |
|
109 |
* @param queryId the unique identifier of the notification query of the subscription to remove |
|
110 |
* @param resultId the unique identifier of the result of the subscription to remove |
|
111 |
* @param alertMode the alert mode of the subscription to remove |
|
112 |
* @param subscriber the URI of the subscriber of the subscription to remove |
|
113 |
* @throws AlertServiceException if any errors occur |
|
114 |
*/ |
|
115 |
public void removeSubscription(final String templateId, final URL notificationService, final String queryId, final String resultId, final String alertMode, final URI subscriber) throws AlertServiceException; |
|
116 |
|
|
117 |
/** |
|
118 |
* Count the results of an alert. |
|
119 |
* @param templateId the unique identifier of the template of the alert results to count |
|
120 |
* @param notificationService the URL of the notification service of the alert results to count |
|
121 |
* @param queryId the unique identifier of the notification query of the alert results to count |
|
122 |
* @param date the date that corresponds to the notification event of the alert results to count |
|
123 |
* @param resultId the unique identifier of the notification result of the alert results to count |
|
124 |
* @return the total number of the specified alert results |
|
125 |
* @throws AlertServiceException if any errors occur |
|
126 |
*/ |
|
127 |
public int countAlertResults(final URL notificationService, final String queryId, final Date date, final String resultId) throws AlertServiceException; |
|
128 |
|
|
129 |
/** |
|
130 |
* Retrieve the results of an alert. |
|
131 |
* @param notificationService the URL of the notification service of the alert results to retrieve |
|
132 |
* @param queryId the unique identfier of the notification query of the alert results to retrieve |
|
133 |
* @param resultId the unique identifier of the notification result of the alert results to retrieve |
|
134 |
* @param fromDate the date from which to retrieve alert results |
|
135 |
* @param toDate the date up to which to retrieve alert results |
|
136 |
* @param limit the maximum number of alert results to retrieve |
|
137 |
* @param offset the offset to start at |
|
138 |
* @return a result page |
|
139 |
* @throws AlertServiceException if any errors occur |
|
140 |
*/ |
|
141 |
public ResultPage getAlertResults(final URL notificationService, final String queryId, final String resultId, final Date fromDate, final Date toDate, final int limit, final int offset) throws AlertServiceException; |
|
142 |
|
|
143 |
/** |
|
144 |
* Alert this service about an event generated by a notification service. |
|
145 |
* @param notificationService the URL of the notification service |
|
146 |
* @param event the notification event |
|
147 |
* @throws AlertServiceException if any errors occur |
|
148 |
*/ |
|
149 |
public void alert(final URL notificationService, final NotificationEvent event) throws AlertServiceException; |
|
150 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/data/IndexServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.data; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverServiceException; |
|
4 |
|
|
5 |
public class IndexServiceException extends DriverServiceException { |
|
6 |
private static final long serialVersionUID = 3390962667213486580L; |
|
7 |
|
|
8 |
public IndexServiceException(String message) { |
|
9 |
super(message); |
|
10 |
} |
|
11 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/A2Service.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverService; |
|
4 |
//import eu.dnetlib.enabling.aas.rmi.AuthenticateRequest; |
|
5 |
//import eu.dnetlib.enabling.aas.rmi.AuthenticateResp; |
|
6 |
//import eu.dnetlib.enabling.aas.rmi.AuthorizeRequest; |
|
7 |
//import eu.dnetlib.enabling.aas.rmi.AuthorizeResp; |
|
8 |
//import eu.dnetlib.enabling.aas.rmi.InvalidateRequest; |
|
9 |
//import eu.dnetlib.enabling.aas.rmi.InvalidateResp; |
|
10 |
|
|
11 |
|
|
12 |
//TODO: remove??? |
|
13 |
|
|
14 |
public interface A2Service extends DriverService { |
|
15 |
|
|
16 |
// public AuthenticateResp authenticate( |
|
17 |
// AuthenticateRequest authenticationRequest); |
|
18 |
// |
|
19 |
// public AuthorizeResp authorize(AuthorizeRequest authorizationRequest); |
|
20 |
// |
|
21 |
// public InvalidateResp invalidate(InvalidateRequest invalidationRequest); |
|
22 |
|
|
23 |
public boolean validate(String profId, String secProfId); |
|
24 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/deploy.info | ||
---|---|---|
1 |
|
|
2 |
{ |
|
3 |
"type_source": "SVN", |
|
4 |
"goal": "package -U -T 4C source:jar", |
|
5 |
"url": "http://svn-public.driver.research-infrastructures.eu/driver/dnet40/modules/uoa-api/trunk", |
|
6 |
"deploy_repository": "dnet4-snapshots", |
|
7 |
"version": "4", |
|
8 |
"mail": "antleb@di.uoa.gr, kiatrop@di.uoa.gr", |
|
9 |
"deploy_repository_url": "http://maven.research-infrastructures.eu/nexus/content/repositories/dnet4-snapshots", |
|
10 |
"name": "uoa-api" |
|
11 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/HostingContextManagerService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverService; |
|
4 |
|
|
5 |
public interface HostingContextManagerService extends DriverService { |
|
6 |
|
|
7 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/NotificationService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
import java.net.URL; |
|
4 |
import java.util.Date; |
|
5 |
import java.util.SortedSet; |
|
6 |
|
|
7 |
import eu.dnetlib.api.DriverService; |
|
8 |
import eu.dnetlib.domain.functionality.NotificationEvent; |
|
9 |
import eu.dnetlib.domain.functionality.NotificationQuery; |
|
10 |
import eu.dnetlib.domain.functionality.NotificationResult; |
|
11 |
import eu.dnetlib.domain.functionality.NotificationSchedule; |
|
12 |
import eu.dnetlib.domain.functionality.NotificationSubscription; |
|
13 |
import eu.dnetlib.domain.functionality.ObjectPage; |
|
14 |
import eu.dnetlib.domain.functionality.ResultPage; |
|
15 |
|
|
16 |
/** |
|
17 |
* This interface declares the available methods of notification service. Alert service is used to manage queries, schedules, events, results and subscriptions. |
|
18 |
* @author thanos@di.uoa.gr |
|
19 |
* @see eu.dnetlib.domain.functionality.NotificationQuery |
|
20 |
* @see eu.dentlib.domain.functionality.NotificationSchedule |
|
21 |
* @see eu.dnetlib.domain.functionality.NotificationEvent |
|
22 |
* @see eu.dnetlib.domain.functionality.NotificationResult |
|
23 |
* @see eu.dnetlib.domain.functionality.NotificationSubscription |
|
24 |
* @see NotificationServiceException |
|
25 |
* |
|
26 |
*/ |
|
27 |
public interface NotificationService extends DriverService { |
|
28 |
/** |
|
29 |
* Retrieve all the supported languages in which queries can be expressed. |
|
30 |
* @return a set containing all the supported languages in which queries can be expressed |
|
31 |
*/ |
|
32 |
public SortedSet<String> getSupportedQueryLanguages(); |
|
33 |
|
|
34 |
/** |
|
35 |
* Retrieve a page of queries. |
|
36 |
* @param pageNumber the number of the page to retrieve |
|
37 |
* @param pageSize the size of the page to retrieve |
|
38 |
* @return an object page containing queries |
|
39 |
* @throws NotificationServiceException if any errors occur |
|
40 |
*/ |
|
41 |
public ObjectPage<NotificationQuery> getQueries(final int pageNumber, final int pageSize) throws NotificationServiceException; |
|
42 |
|
|
43 |
/** |
|
44 |
* Add a query. |
|
45 |
* @param query the query to add |
|
46 |
* @throws NotificationServiceException if any errors occur |
|
47 |
*/ |
|
48 |
public void addQuery(final NotificationQuery query) throws NotificationServiceException; |
|
49 |
|
|
50 |
/** |
|
51 |
* Remove a query. |
|
52 |
* @param queryId the unique identifier of the query to remove |
|
53 |
* @throws NotificationServiceException if any errors occur |
|
54 |
*/ |
|
55 |
public void removeQuery(final String queryId) throws NotificationServiceException; |
|
56 |
|
|
57 |
/** |
|
58 |
* Execute a query and return the generated result. |
|
59 |
* @param queryId the unique identifier of the query to execute |
|
60 |
* @param resultId the unique result identifier to use |
|
61 |
* @param fromDate the from date to use |
|
62 |
* @param toDate the to date to use |
|
63 |
* @param limit the limit to use |
|
64 |
* @param offset the offset to use |
|
65 |
* @return a result page containing the generated result |
|
66 |
* @throws NotificationServiceException if any errors occur |
|
67 |
*/ |
|
68 |
public ResultPage executeQuery(final String queryId, final String resultId, final Date fromDate, final Date toDate, final int limit, final int offset) throws NotificationServiceException; |
|
69 |
|
|
70 |
/** |
|
71 |
* Retrieve a page of schedules. |
|
72 |
* @param pageNumber the number of the page to retrieve |
|
73 |
* @param pageSize the size of the page to retrieve |
|
74 |
* @return an object page containing schedules |
|
75 |
* @throws NotificationServiceException if any errors occur |
|
76 |
*/ |
|
77 |
public ObjectPage<NotificationSchedule> getSchedules(final int pageNumber, final int pageSize) throws NotificationServiceException; |
|
78 |
|
|
79 |
/** |
|
80 |
* Add a schedule. |
|
81 |
* @param schedule the schedule to add |
|
82 |
* @throws NotificationServiceException if any errors occur |
|
83 |
*/ |
|
84 |
public void addSchedule(final NotificationSchedule schedule) throws NotificationServiceException; |
|
85 |
|
|
86 |
/** |
|
87 |
* Enable a schedule. |
|
88 |
* @param queryId the unique identifier of the query whose schedule to enable |
|
89 |
* @throws NotificationServiceException if any errors occur |
|
90 |
*/ |
|
91 |
public void enableSchedule(final String queryId) throws NotificationServiceException; |
|
92 |
|
|
93 |
/** |
|
94 |
* Disable a schedule. |
|
95 |
* @param queryId the unique identifier of the query whose schedule to disable |
|
96 |
* @throws NotificationServiceException if any errors occur |
|
97 |
*/ |
|
98 |
public void disableSchedule(final String queryId) throws NotificationServiceException; |
|
99 |
|
|
100 |
/** |
|
101 |
* Remove a schedule. |
|
102 |
* @param queryId the unique identifier of the query of the schedule to remove |
|
103 |
* @throws NotificationServiceException if any errors occur |
|
104 |
*/ |
|
105 |
public void removeSchedule(final String queryId) throws NotificationServiceException; |
|
106 |
|
|
107 |
/** |
|
108 |
* Retrieve a page of events. |
|
109 |
* @param pageNumber the number of the page to retrieve |
|
110 |
* @param pageSize the size of the page to retrieve |
|
111 |
* @return an object page containing events |
|
112 |
* @throws NotificationServiceException if any errors occur |
|
113 |
*/ |
|
114 |
public ObjectPage<NotificationEvent> getEvents(final int pageNumber, final int pageSize) throws NotificationServiceException; |
|
115 |
|
|
116 |
/** |
|
117 |
* Retrieve a page of results. |
|
118 |
* @param pageNumber the number of the page to retrieve |
|
119 |
* @param pageSize the size of the page to retrieve |
|
120 |
* @return an object page containing results |
|
121 |
* @throws NotificationServiceException if any errors occur |
|
122 |
*/ |
|
123 |
public ObjectPage<NotificationResult> getResults(final int pageNumber, final int pageSize) throws NotificationServiceException; |
|
124 |
|
|
125 |
/** |
|
126 |
* Retrieve a result of an event of a query. |
|
127 |
* @param queryId the unique identifier of the query of the event of the result to retrieve |
|
128 |
* @param date the date corresponding to the event of the result to retrieve |
|
129 |
* @param resultId the unique identifier of the result to retrieve |
|
130 |
* @return the specified result of the specified event of the specified query or null if no such result exists |
|
131 |
* @throws NotificationServiceException if any errors occur |
|
132 |
*/ |
|
133 |
public NotificationResult getResult(final String queryId, final Date date, final String resultId) throws NotificationServiceException; |
|
134 |
|
|
135 |
/** |
|
136 |
* Retrieve a result of the previous event of an event of a query. |
|
137 |
* @param queryId the unique identifier of the query of the event of the result to retrieve |
|
138 |
* @param date the date corresponding to the next event of the event whose result to retrieve |
|
139 |
* @param resultId the unique identifier of the result to retrieve |
|
140 |
* @return the specified result of the previous event of the specified event of the specified query or null if no such result exists |
|
141 |
* @throws NotificationServiceException if any errors occur |
|
142 |
*/ |
|
143 |
public NotificationResult getPreviousResult(final String queryId, final Date date, final String resultId) throws NotificationServiceException; |
|
144 |
|
|
145 |
/** |
|
146 |
* Retrieve a page of subscriptions. |
|
147 |
* @param pageNumber the number of the page to retrieve |
|
148 |
* @param pageSize the size of the page to retrieve |
|
149 |
* @return an object page containign subscriptions |
|
150 |
* @throws NotificationServiceException if any errors occur |
|
151 |
*/ |
|
152 |
public ObjectPage<NotificationSubscription> getSubscriptions(final int pageNumber, final int pageSize) throws NotificationServiceException; |
|
153 |
|
|
154 |
/** |
|
155 |
* Add a subscription. |
|
156 |
* @param subscription the subscription to add |
|
157 |
* @throws NotificationServiceException if any errors occur |
|
158 |
*/ |
|
159 |
public void addSubscription(final NotificationSubscription subscription) throws NotificationServiceException; |
|
160 |
|
|
161 |
/** |
|
162 |
* Enable a subscription. |
|
163 |
* @param queryId the unique identifier of the query of the schedule of the subscription to enable |
|
164 |
* @param alertService the URL of the alert service of the subscription to enable |
|
165 |
* @throws NotificationServiceException if any errors occur |
|
166 |
*/ |
|
167 |
public void enableSubscription(final String queryId, final URL alertService) throws NotificationServiceException; |
|
168 |
|
|
169 |
/** |
|
170 |
* Disable a subscription. |
|
171 |
* @param queryId the unique identifier of the query of the schedule of the subscription to disable |
|
172 |
* @param alertService the URL of the alert service of the subscription to disable |
|
173 |
* @throws NotificationServiceException if any errors occur |
|
174 |
*/ |
|
175 |
public void disableSubscription(final String queryId, final URL alertService) throws NotificationServiceException; |
|
176 |
|
|
177 |
/** |
|
178 |
* Remove a subscription. |
|
179 |
* @param queryId the unique identifier of the query of the schedule of the subscription to remove |
|
180 |
* @param alertService the URL of the alert service of the subscription to remove |
|
181 |
* @throws NotificationServiceException if any errors occur |
|
182 |
*/ |
|
183 |
public void removeSubscription(final String queryId, final URL alertService) throws NotificationServiceException; |
|
184 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/ConversionService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverService; |
|
4 |
import eu.dnetlib.domain.functionality.ConversionStatus; |
|
5 |
|
|
6 |
public interface ConversionService extends DriverService { |
|
7 |
|
|
8 |
/** |
|
9 |
* Adds a conversion job |
|
10 |
* @param fileUrl the url of the file to be converted |
|
11 |
* @param format the desired format |
|
12 |
* @return the {@link ConversionStatus} of the conversion job |
|
13 |
* @throws ConversionServiceException |
|
14 |
*/ |
|
15 |
public ConversionStatus addJob(String fileUrl, String format) |
|
16 |
throws ConversionServiceException; |
|
17 |
/** |
|
18 |
* The {@link ConversionStatus} of a conversion job |
|
19 |
* @param conversionId the id of the conversion job |
|
20 |
* @return the {@link ConversionStatus} |
|
21 |
* @throws ConversionServiceException |
|
22 |
*/ |
|
23 |
public ConversionStatus getStatus(String conversionId) |
|
24 |
throws ConversionServiceException; |
|
25 |
|
|
26 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/ResultSetService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import java.util.List; |
|
4 |
|
|
5 |
import eu.dnetlib.api.DriverService; |
|
6 |
import eu.dnetlib.domain.EPR; |
|
7 |
|
|
8 |
public interface ResultSetService extends DriverService { |
|
9 |
|
|
10 |
EPR createPullRSEPR(EPR dataProviderEPR, String bdId, int initialPageSize, |
|
11 |
int expiryTime, String styleSheet, Integer keepAliveTime, |
|
12 |
Integer total); |
|
13 |
|
|
14 |
EPR createPullRS(String dataProviderServiceAddress, String bdId, |
|
15 |
int initialPageSize, int expiryTime, String styleSheet, |
|
16 |
Integer keepAliveTime, Integer total); |
|
17 |
|
|
18 |
void closeRS(String rsId); |
|
19 |
|
|
20 |
List<String> getResult(String rsId, int fromPosition, int toPosition, |
|
21 |
String requestMode) throws ResultSetServiceException; |
|
22 |
|
|
23 |
int getNumberOfElements(String rsId) throws ResultSetServiceException; |
|
24 |
|
|
25 |
EPR createPushRS(int expiryTime, int keepAliveTime) |
|
26 |
throws ResultSetServiceException; |
|
27 |
|
|
28 |
String populateRS(String rsId, List<String> elements) |
|
29 |
throws ResultSetServiceException; |
|
30 |
|
|
31 |
String getRSStatus(String rsId) throws ResultSetServiceException; |
|
32 |
|
|
33 |
String getProperty(String rsId, String name) |
|
34 |
throws ResultSetServiceException; |
|
35 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/ConversionServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
@SuppressWarnings("serial") |
|
4 |
public class ConversionServiceException extends Exception { |
|
5 |
public ConversionServiceException() { |
|
6 |
super(); |
|
7 |
} |
|
8 |
|
|
9 |
public ConversionServiceException(String message, Throwable cause) { |
|
10 |
super(message, cause); |
|
11 |
} |
|
12 |
|
|
13 |
public ConversionServiceException(String message) { |
|
14 |
super(message); |
|
15 |
} |
|
16 |
|
|
17 |
public ConversionServiceException(Throwable cause) { |
|
18 |
super(cause); |
|
19 |
} |
|
20 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/ISRegistryServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverServiceException; |
|
4 |
|
|
5 |
public class ISRegistryServiceException extends DriverServiceException { |
|
6 |
private static final long serialVersionUID = 4179398986751223317L; |
|
7 |
|
|
8 |
public ISRegistryServiceException(Throwable cause) { |
|
9 |
super(cause); |
|
10 |
} |
|
11 |
|
|
12 |
public ISRegistryServiceException() { |
|
13 |
super(); |
|
14 |
} |
|
15 |
|
|
16 |
public ISRegistryServiceException(String message, Throwable cause) { |
|
17 |
super(message, cause); |
|
18 |
} |
|
19 |
|
|
20 |
public ISRegistryServiceException(String message) { |
|
21 |
super(message); |
|
22 |
} |
|
23 |
|
|
24 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/AlertServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
/** |
|
4 |
* This exception is thrown by alert service if any errors occur. |
|
5 |
* @author thanos@di.uoa.gr |
|
6 |
* @see AlertService |
|
7 |
* |
|
8 |
*/ |
|
9 |
public class AlertServiceException extends Exception { |
|
10 |
private static final long serialVersionUID = 1L; |
|
11 |
|
|
12 |
/** |
|
13 |
* Construct a new alert service exception with the specified message and cause. |
|
14 |
* @param message the message |
|
15 |
* @param cause the cause |
|
16 |
*/ |
|
17 |
public AlertServiceException(final String message, final Throwable cause) { |
|
18 |
super(message, cause); |
|
19 |
} |
|
20 |
|
|
21 |
/** |
|
22 |
* Construct a new alert service exception with the specified message. |
|
23 |
* @param message the message |
|
24 |
*/ |
|
25 |
public AlertServiceException(final String message) { |
|
26 |
super(message); |
|
27 |
} |
|
28 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/enabling/ISSNServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.enabling; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverServiceException; |
|
4 |
|
|
5 |
public class ISSNServiceException extends DriverServiceException { |
|
6 |
private static final long serialVersionUID = -5921523712725388939L; |
|
7 |
|
|
8 |
public ISSNServiceException(String mesg) { |
|
9 |
super(mesg); |
|
10 |
} |
|
11 |
|
|
12 |
public ISSNServiceException(String mesg, Throwable cause) { |
|
13 |
super(mesg, cause); |
|
14 |
} |
|
15 |
|
|
16 |
public ISSNServiceException(Throwable cause) { |
|
17 |
super(cause); |
|
18 |
} |
|
19 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/NotificationServiceException.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
/** |
|
4 |
* This exception is thrown by notification service if any errors occur. |
|
5 |
* @author thanos@di.uoa.gr |
|
6 |
* @see NotificationService |
|
7 |
* |
|
8 |
*/ |
|
9 |
public class NotificationServiceException extends Exception { |
|
10 |
private static final long serialVersionUID = 1L; |
|
11 |
|
|
12 |
/** |
|
13 |
* Construct a new notification service exception with the specified message and cause. |
|
14 |
* @param message the message |
|
15 |
* @param cause the cause |
|
16 |
*/ |
|
17 |
public NotificationServiceException(final String message, final Throwable cause) { |
|
18 |
super(message, cause); |
|
19 |
} |
|
20 |
|
|
21 |
/** |
|
22 |
* Construct a new notification service exception with the specified message. |
|
23 |
* @param message the message |
|
24 |
*/ |
|
25 |
public NotificationServiceException(final String message) { |
|
26 |
super(message); |
|
27 |
} |
|
28 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/DriverService.java | ||
---|---|---|
1 |
package eu.dnetlib.api; |
|
2 |
|
|
3 |
import eu.dnetlib.domain.ServiceIdentity; |
|
4 |
import eu.dnetlib.domain.enabling.Notification; |
|
5 |
|
|
6 |
/** |
|
7 |
* The basic interface that all DRIVER services must implement. |
|
8 |
*/ |
|
9 |
public interface DriverService { |
|
10 |
/** |
|
11 |
* Identifies the service's version. |
|
12 |
* |
|
13 |
* @return the service's identification |
|
14 |
*/ |
|
15 |
public ServiceIdentity identify(); |
|
16 |
|
|
17 |
public void notify(Notification notification) throws DriverServiceException; |
|
18 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/MadgikValidator.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
import eu.dnetlib.api.DriverService; |
|
4 |
|
|
5 |
public interface MadgikValidator extends DriverService { |
|
6 |
|
|
7 |
} |
modules/uoa-api/tags/uoa-api-1.2.1/trunk/src/main/java/eu/dnetlib/api/functionality/RecommendationService.java | ||
---|---|---|
1 |
package eu.dnetlib.api.functionality; |
|
2 |
|
|
3 |
import java.util.Date; |
|
4 |
import java.util.List; |
|
5 |
import java.util.Set; |
|
6 |
|
|
7 |
import eu.dnetlib.api.DriverService; |
|
8 |
import eu.dnetlib.domain.functionality.Recommendation; |
|
9 |
|
|
10 |
/** |
|
11 |
* The class that manages Recommendation objects |
|
12 |
*/ |
|
13 |
public interface RecommendationService extends DriverService { |
|
14 |
|
|
15 |
/** |
|
16 |
* creates a new recommendation of type announcement |
|
17 |
* |
|
18 |
* @param recommendationText |
|
19 |
* the text of the recommendation |
|
20 |
* @param creationDate |
|
21 |
* the creation date of the announcement |
|
22 |
* @param expirationDate |
|
23 |
* the date the announcement expires |
|
24 |
* @return the id of the new recommendation |
|
25 |
* @throws RecommendationWebServiceException |
|
26 |
* if the announcement cannot be created |
|
27 |
*/ |
|
28 |
public String generateAnnouncement(int index, boolean active, |
|
29 |
String announcementTitle, String announcementText, |
|
30 |
Date creationDate, Date expirationDate) |
|
31 |
throws RecommendationServiceException; |
|
32 |
|
|
33 |
/** |
|
34 |
* Swap the index of 2 announcements |
|
35 |
* |
|
36 |
* @param announcementId1 |
|
37 |
* the id of the fist announcement |
|
38 |
* @param announcementId2 |
|
39 |
* the id of the second announcement |
|
40 |
*/ |
|
41 |
public void swapAnnouncements(String announcementId1, String announcementId2) |
|
42 |
throws RecommendationServiceException; |
|
43 |
|
|
44 |
/** |
|
45 |
* Swap the index of 2 user recommendaitons |
|
46 |
* |
|
47 |
* @param announcementId1 |
|
48 |
* the id of the fist announcement |
|
49 |
* @param announcementId2 |
|
50 |
* the id of the second announcement |
|
51 |
*/ |
|
52 |
public void swapUserRecommendations(String announcementId1, String announcementId2) |
|
53 |
throws RecommendationServiceException;; |
|
54 |
|
|
55 |
/** |
|
56 |
* Swap the index of 2 community recommendations |
|
57 |
* |
|
58 |
* @param announcementId1 |
|
59 |
* the id of the fist announcement |
|
60 |
* @param announcementId2 |
Also available in: Unified diff
[maven-release-plugin] copy for tag uoa-api-1.2.1