forked from gooddata/gooddata-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPollHandler.java
More file actions
89 lines (77 loc) · 2.12 KB
/
PollHandler.java
File metadata and controls
89 lines (77 loc) · 2.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
* Copyright (C) 2004-2017, GoodData(R) Corporation. All rights reserved.
* This source code is licensed under the BSD-style license found in the
* LICENSE.txt file in the root directory of this source tree.
*/
package com.gooddata;
import org.springframework.http.client.ClientHttpResponse;
import java.io.IOException;
import java.net.URI;
/**
* For internal use by services employing polling.<p>
* @param <P> polling type
* @param <R> result type
*
* @see com.gooddata.FutureResult
*/
public interface PollHandler<P,R> {
/**
* Get URI used for polling.
*
* @return URI string
*/
String getPollingUri();
/**
* Get URI used for polling.
*
* @return URI string
*/
default URI getPolling() {
return URI.create(getPollingUri());
}
/**
* Get class of result after polling.
*
* @return result class
*/
Class<R> getResultClass();
/**
* Get class of the polling object.
*
* @return polling class
*/
Class<P> getPollClass();
/**
* Returns true when the polling is done, false otherwise.
*
* @return true when the polling is done, false otherwise
*/
boolean isDone();
/**
* Return result after polling.
*
* @return result after polling
*/
R getResult();
/**
* Check single polling response if whole polling process should finish.
*
* @param response client side HTTP response
* @return true if polling should finish, false otherwise
* @throws IOException when there's a problem extracting data from response
*/
boolean isFinished(ClientHttpResponse response) throws IOException;
/**
* Handle result of single polling request.
*
* @param pollResult result of polling request
*/
void handlePollResult(P pollResult);
/**
* Handle exception while polling.
* The implementing class should throw instance of {@link com.gooddata.GoodDataException}
* (or ancestor) with the given argument as cause.
* @param e the exception
*/
void handlePollException(GoodDataRestException e);
}