Project

General

Profile

« Previous | Next » 

Revision 32142

Added by Marek Horst over 9 years ago

#938 creating icm-functionality-api 1.0.0 branch

View differences:

modules/icm-functionality-api/branches/1.0.0/deploy.info
1
{"type_source": "SVN", "goal": "package -U -T 4C source:jar", "url": "http://svn-public.driver.research-infrastructures.eu/driver/dnet40/modules/icm-functionality-api/trunk/", "deploy_repository": "dnet4-snapshots", "version": "4", "mail": "sandro.labruzzo@isti.cnr.it,michele.artini@isti.cnr.it, claudio.atzori@isti.cnr.it, alessia.bardi@isti.cnr.it", "deploy_repository_url": "http://maven.research-infrastructures.eu/nexus/content/repositories/dnet4-snapshots", "name": "icm-functionality-api"}
modules/icm-functionality-api/branches/1.0.0/src/main/java/eu/dnetlib/data/index/Array1.java
1
/**
2
 * Copyright 2008-2009 DRIVER PROJECT (ICM UW)
3
 * Original author: Marek Horst
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 *      http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 */
17
package eu.dnetlib.data.index;
18

  
19
import java.util.ArrayList;
20
import java.util.List;
21
import javax.xml.bind.annotation.XmlAccessType;
22
import javax.xml.bind.annotation.XmlAccessorType;
23
import javax.xml.bind.annotation.XmlElement;
24
import javax.xml.bind.annotation.XmlType;
25

  
26
/**
27
 * Array1 class.
28
 * @author Marek Horst
29
 * @version 0.0.1
30
 *
31
 */
32
@XmlAccessorType(XmlAccessType.FIELD)
33
@XmlType(name = "array2", propOrder = {
34
    "item"
35
})
36
@Deprecated
37
public class Array1 {
38

  
39
    @XmlElement(required = true)
40
    protected List<String> item;
41

  
42
    /**
43
     * Gets the value of the element property.
44
     * 
45
     * <p>
46
     * This accessor method returns a reference to the live list,
47
     * not a snapshot. Therefore any modification you make to the
48
     * returned list will be present inside the JAXB object.
49
     * This is why there is not a <CODE>set</CODE> method for the element property.
50
     * 
51
     * <p>
52
     * For example, to add a new item, do as follows:
53
     * <pre>
54
     *    getElement().add(newItem);
55
     * </pre>
56
     * 
57
     * 
58
     * <p>
59
     * Objects of the following type(s) are allowed in the list
60
     * {@link String }
61
     * 
62
     * 
63
     */
64
    public List<String> getItem() {
65
        if (item == null) {
66
            item = new ArrayList<String>();
67
        }
68
        return this.item;
69
    }
70

  
71
}
modules/icm-functionality-api/branches/1.0.0/src/main/java/eu/dnetlib/data/index/IIndexService.java
1
/**
2
 * Copyright 2008-2009 DRIVER PROJECT (ICM UW)
3
 * Original author: Marek Horst
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 *      http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 */
17
package eu.dnetlib.data.index;
18

  
19

  
20
import javax.jws.WebMethod;
21
import javax.jws.WebParam;
22
import javax.jws.WebService;
23
import javax.jws.soap.SOAPBinding;
24
import javax.xml.ws.wsaddressing.W3CEndpointReference;
25

  
26
import eu.dnetlib.common.ws.dataprov.IDataProviderExt;
27
import eu.dnetlib.data.index.ws.nh.INotificationHandler;
28

  
29
/**
30
 * Main Driver Index Service interface.
31
 * @author Marek Horst
32
 * @version 0.0.1
33
 *
34
 */
35
@WebService(targetNamespace = "http://services.dnetlib.eu/")
36
@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, 
37
		parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)
38
@Deprecated
39
public interface IIndexService extends INotificationHandler, IDataProviderExt {
40

  
41
	/**
42
	 * Identifies service and version.
43
	 * @return service version identifier
44
	 */
45
	@WebMethod(operationName="identify", action="identify")
46
	public String identify();
47
	
48
	/**
49
	 * Returns ResultSet EPR for the index lookup result.
50
	 * TODO make sure that WebParam names are correct, according to wsdl which is apparently not specified yet
51
	 * @param ixId
52
	 * @param query
53
	 * @param mdFormatId
54
	 * @param layoutId
55
	 * @throws IndexServiceException
56
	 * @return ResultSet EPR for the index lookup result
57
	 */
58
	@WebMethod(operationName="indexLookup", action="indexLookup")
59
	public W3CEndpointReference indexLookup(
60
			@WebParam(name="id") String ixId, 
61
			@WebParam(name="query") String query, 
62
			@WebParam(name="mdformat") String mdFormatId,
63
			@WebParam(name="layout") String layoutId)
64
		throws IndexServiceException;
65
	
66
	/**
67
	 * Returns index statistics.
68
	 * @param ixId
69
	 * @throws IndexServiceException
70
	 * @return index statistics
71
	 */
72
	@WebMethod(operationName="getIndexStatistics", action="getIndexStatistics")
73
	public String getIndexStatistics(
74
			@WebParam(name="index") String ixId)
75
		throws IndexServiceException;
76
	
77
	/**
78
	 * Returns browsing statistics.
79
	 * @param query
80
	 * @param ixId
81
	 * @throws IndexServiceException
82
	 * @return browsing statistics
83
	 */
84
	@WebMethod(operationName="getBrowsingStatistics", action="getBrowsingStatistics")
85
	public W3CEndpointReference getBrowsingStatistics(
86
			@WebParam(name="query") String query, 
87
			@WebParam(name="index") String ixId,
88
			@WebParam(name="mdformat") String mdFormatId,
89
			@WebParam(name="layout") String layoutId)
90
		throws IndexServiceException;
91
	
92
	/**
93
	 * Returns list of all stored indices.
94
	 * @return list of all stored indices
95
	 */
96
	@WebMethod(operationName="getListOfIndices", action="getListOfIndices")
97
	public String[] getListOfIndices();
98
	
99
	/**
100
	 * Returns list of all stored indices in CSV format.
101
	 * @return list of all stored indices in CSV format
102
	 */
103
	@WebMethod(operationName="getListOfIndicesCSV", action="getListOfIndicesCSV")
104
	public String getListOfIndicesCSV();
105
	
106
}
modules/icm-functionality-api/branches/1.0.0/src/main/java/eu/dnetlib/data/index/IndexServiceException.java
1
/**
2
 * Copyright 2008-2009 DRIVER PROJECT (ICM UW)
3
 * Original author: Marek Horst
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 *      http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 */
17
package eu.dnetlib.data.index;
18

  
19
/**
20
 * General index service exception.
21
 * @author Marek Horst
22
 * @version 0.0.1
23
 *
24
 */
25
@Deprecated
26
public class IndexServiceException extends Exception {
27

  
28
	/**
29
	 * 
30
	 */
31
	private static final long serialVersionUID = -6772977735282310658L;
32

  
33
	public IndexServiceException(java.lang.String arg0, java.lang.Throwable arg1) {
34
		super(arg0, arg1);
35
	}
36

  
37
	public IndexServiceException(java.lang.String arg0) {
38
		super(arg0);
39
	}
40

  
41
	public IndexServiceException(java.lang.Throwable arg0) {
42
		super(arg0);
43
	}
44

  
45
	public IndexServiceException() {
46
		super();
47
	}
48
	
49
}
modules/icm-functionality-api/branches/1.0.0/src/main/java/eu/dnetlib/data/index/ws/nh/INotificationHandler.java
1
/**
2
 * Copyright 2008-2009 DRIVER PROJECT (ICM UW)
3
 * Original author: Marek Horst
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 *      http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 */
17
package eu.dnetlib.data.index.ws.nh;
18

  
19
import javax.jws.WebMethod;
20
import javax.jws.WebParam;
21
import javax.jws.WebResult;
22

  
23
/**
24
 * Notification consumer methods.
25
 * @author Marek Horst
26
 * @version 0.0.1
27
 *
28
 */
29
@Deprecated
30
public interface INotificationHandler {
31

  
32
	/**
33
	 * Notification consumer method.
34
	 * @param subscrId
35
	 * @param topic
36
	 * @param isId
37
	 * @param message
38
	 * @return Return
39
	 */
40
	@WebMethod(operationName="notify", action="notify")
41
	@WebResult(name = "Return")
42
	public boolean notify(
43
			@WebParam(name="subscrId") String subscrId, 
44
			@WebParam(name="topic") String topic, 
45
			@WebParam(name="is_id") String isId,
46
			@WebParam(name="message") String message);
47
}
modules/icm-functionality-api/branches/1.0.0/pom.xml
1
<?xml version="1.0" encoding="UTF-8"?>
2
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
4
	<parent>
5
		<groupId>eu.dnetlib</groupId>
6
		<artifactId>dnet-parent</artifactId>
7
		<version>1.0.0-SNAPSHOT</version>
8
	</parent>
9
	<modelVersion>4.0.0</modelVersion>
10
	<groupId>eu.dnetlib</groupId>
11
	<artifactId>icm-functionality-api</artifactId>
12
	<packaging>jar</packaging>
13
	<version>1.0.0-SNAPSHOT</version>
14
	<dependencies>
15
		<dependency>
16
			<groupId>junit</groupId>
17
			<artifactId>junit</artifactId>
18
			<version>${junit.version}</version>
19
			<scope>test</scope>
20
		</dependency>
21
		<dependency>
22
			<groupId>eu.dnetlib</groupId>
23
			<artifactId>unibi-functionality-api</artifactId>
24
			<version>[1.0.0-SNAPSHOT]</version>
25
		</dependency>
26
	</dependencies>
27
</project>

Also available in: Unified diff