org.kohsuke.github.GHNotificationStream Maven / Gradle / Ivy
package org.kohsuke.github;
import java.io.IOException;
import java.util.Date;
import java.util.Iterator;
import java.util.NoSuchElementException;
// TODO: Auto-generated Javadoc
/**
* Listens to GitHub notification stream.
*
*
* This class supports two modes of retrieving notifications that can be controlled via {@link #nonBlocking(boolean)}.
*
*
* In the blocking mode, which is the default, iterator will be infinite. The call to {@link Iterator#next()} will block
* until a new notification arrives. This is useful for application that runs perpetually and reacts to notifications.
*
*
* In the non-blocking mode, the iterator will only report the set of notifications initially retrieved from GitHub,
* then quit. This is useful for a batch application to process the current set of notifications.
*
* @author Kohsuke Kawaguchi
* @see GitHub#listNotifications() GitHub#listNotifications()
* @see GHRepository#listNotifications() GHRepository#listNotifications()
*/
public class GHNotificationStream extends GitHubInteractiveObject implements Iterable {
private Boolean all, participating;
private String since;
private String apiUrl;
private boolean nonBlocking = false;
/**
* Instantiates a new GH notification stream.
*
* @param root
* the root
* @param apiUrl
* the api url
*/
GHNotificationStream(GitHub root, String apiUrl) {
super(root);
this.apiUrl = apiUrl;
}
/**
* Should the stream include notifications that are already read?.
*
* @param v
* the v
* @return the gh notification stream
*/
public GHNotificationStream read(boolean v) {
all = v;
return this;
}
/**
* Should the stream be restricted to notifications in which the user is directly participating or mentioned?.
*
* @param v
* the v
* @return the gh notification stream
*/
public GHNotificationStream participating(boolean v) {
participating = v;
return this;
}
/**
* Since gh notification stream.
*
* @param timestamp
* the timestamp
* @return the gh notification stream
*/
public GHNotificationStream since(long timestamp) {
return since(new Date(timestamp));
}
/**
* Since gh notification stream.
*
* @param dt
* the dt
* @return the gh notification stream
*/
public GHNotificationStream since(Date dt) {
since = GitHubClient.printDate(dt);
return this;
}
/**
* If set to true, {@link #iterator()} will stop iterating instead of blocking and waiting for the updates to
* arrive.
*
* @param v
* the v
* @return the gh notification stream
*/
public GHNotificationStream nonBlocking(boolean v) {
this.nonBlocking = v;
return this;
}
/**
* Returns an infinite blocking {@link Iterator} that returns {@link GHThread} as notifications arrive.
*
* @return the iterator
*/
public Iterator iterator() {
// capture the configuration setting here
final Requester req = root().createRequest()
.with("all", all)
.with("participating", participating)
.with("since", since);
return new Iterator() {
/**
* Stuff we've fetched but haven't returned to the caller. Newer ones first.
*/
private GHThread[] threads = EMPTY_ARRAY;
/**
* Next element in {@link #threads} to return. This counts down.
*/
private int idx = -1;
/**
* threads whose updated_at is older than this should be ignored.
*/
private long lastUpdated = -1;
/**
* Next request should have "If-Modified-Since" header with this value.
*/
private String lastModified;
/**
* When is the next polling allowed?
*/
private long nextCheckTime = -1;
private GHThread next;
public GHThread next() {
if (next == null) {
next = fetch();
if (next == null)
throw new NoSuchElementException();
}
GHThread r = next;
next = null;
return r;
}
public boolean hasNext() {
if (next == null)
next = fetch();
return next != null;
}
GHThread fetch() {
try {
while (true) {// loop until we get new threads to return
// if we have fetched un-returned threads, use them first
while (idx >= 0) {
GHThread n = threads[idx--];
long nt = n.getUpdatedAt().getTime();
if (nt >= lastUpdated) {
lastUpdated = nt;
return n;
}
}
if (nonBlocking && nextCheckTime >= 0)
return null; // nothing more to report, and we aren't blocking
// observe the polling interval before making the call
while (true) {
long now = System.currentTimeMillis();
if (nextCheckTime < now)
break;
long waitTime = Math.min(Math.max(nextCheckTime - now, 1000), 60 * 1000);
Thread.sleep(waitTime);
}
req.setHeader("If-Modified-Since", lastModified);
Requester requester = req.withUrlPath(apiUrl);
GitHubResponse response = ((GitHubPageContentsIterable) requester
.toIterable(GHThread[].class, null)).toResponse();
threads = response.body();
if (threads == null) {
threads = EMPTY_ARRAY; // if unmodified, we get empty array
} else {
// we get a new batch, but we want to ignore the ones that we've seen
lastUpdated++;
}
idx = threads.length - 1;
nextCheckTime = calcNextCheckTime(response);
lastModified = response.header("Last-Modified");
}
} catch (IOException | InterruptedException e) {
throw new RuntimeException(e);
}
}
private long calcNextCheckTime(GitHubResponse response) {
String v = response.header("X-Poll-Interval");
if (v == null)
v = "60";
long seconds = Integer.parseInt(v);
return System.currentTimeMillis() + seconds * 1000;
}
};
}
/**
* Mark as read.
*
* @throws IOException
* the io exception
*/
public void markAsRead() throws IOException {
markAsRead(-1);
}
/**
* Marks all the notifications as read.
*
* @param timestamp
* the timestamp
* @throws IOException
* the io exception
*/
public void markAsRead(long timestamp) throws IOException {
final Requester req = root().createRequest();
if (timestamp >= 0)
req.with("last_read_at", GitHubClient.printDate(new Date(timestamp)));
req.withUrlPath(apiUrl).fetchHttpStatusCode();
}
private static final GHThread[] EMPTY_ARRAY = new GHThread[0];
}