PatchesAndForks/rome
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Initial commit

Browse source
This commit is contained in:
Patrick Gotthard 2013-10-11 23:39:43 +02:00
commit 62c5c1fd43
65 changed files with 4748 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.gitignore vendored Normal file
View file

@ -0,0 +1,4 @@
/.classpath
/.project
/.settings
/target

202
LICENSE Normal file
View file

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

9
README Normal file
View file

@ -0,0 +1,9 @@
ROME Certiorem
Build Instructions
-------------------------------------------------------------------------------
To build with Maven 2+:
> mvn package

157
pom.xml Normal file
View file

@ -0,0 +1,157 @@
<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>rome-push</artifactId>
<groupId>com.rometools</groupId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>rome-certiorem</artifactId>
<name>rome-certiorem</name>
<description>A PubSubHubub implementation for Java based on ROME</description>
<scm>
<connection>scm:svn:https://rometools.jira.com/svn/INCUBATOR/trunk/pubsubhubub/certiorem/</connection>
<developerConnection>scm:svn:https://rometools.jira.com/svn/INCUBATOR/trunk/pubsubhubub/certiorem/</developerConnection>
<url>https://rometools.jira.com/svn/INCUBATOR/trunk/pubsubhubub/certiorem/</url>
</scm>
<licenses>
<license>
<name>Apache 2</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>
<developers>
<developer>
<id>kebernet</id>
<name>Robert Cooper</name>
<email>kebernet@gmail.comM</email>
<url>http://www.kebernet.net</url>
</developer>
<developer>
<id>fnajmi</id>
<name>Farrukh Najmi</name>
<url>http://wellfleetsoftware.com</url>
</developer>
</developers>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>
<distributionManagement>
<repository>
<id>central.staging</id>
<url>http://oss.sonatype.org/service/local/staging/deploy/maven2</url>
</repository>
<snapshotRepository>
<id>sonatype.snapshots</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
<repositories>
<repository>
<id>sonatype.snapshots</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
</repositories>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.1</version>
<configuration>
<source>1.6</source>
<target>1.6</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.4</version>
<configuration>
<failOnMissingWebXml>false</failOnMissingWebXml>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>com.rometools</groupId>
<artifactId>rome-fetcher</artifactId>
<version>2.0.0-SNAPSHOT</version>
<exclusions>
<exclusion>
<groupId>commons-httpclient</groupId>
<artifactId>commons-httpclient</artifactId>
</exclusion>
<exclusion>
<groupId>commons-logging</groupId>
<artifactId>commons-logging-api</artifactId>
</exclusion>
<exclusion>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.persistence</groupId>
<artifactId>persistence-api</artifactId>
<version>1.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>

39
src/main/java/org/rometools/certiorem/HttpStatusCodeException.java Normal file
View file

@ -0,0 +1,39 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem;
/**
*
* @author robert.cooper
*/
public class HttpStatusCodeException extends RuntimeException {
private final int status;
public HttpStatusCodeException(int status, String message, Throwable cause){
super(message, cause);
this.status = status;
}
public int getStatus(){
return this.status;
}
}

51
src/main/java/org/rometools/certiorem/hub/DeltaFeedInfoCache.java Normal file
View file

@ -0,0 +1,51 @@
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package org.rometools.certiorem.hub;
import java.net.URL;
import org.rometools.fetcher.impl.FeedFetcherCache;
import org.rometools.fetcher.impl.SyndFeedInfo;
/**
* Wrapper FeedFetcherCache that wraps a backing FeedFetcherCache and makes sure that
* any SyndFeedInfo used within it are replaced with a DeltaSyndFeedInfo which is capable of
* tracking changes to entries in the underlying feed.
*
* @author najmi
*/
public class DeltaFeedInfoCache implements FeedFetcherCache {
FeedFetcherCache backingCache;
public DeltaFeedInfoCache(FeedFetcherCache backingCache) {
this.backingCache = backingCache;
}
@Override
public SyndFeedInfo getFeedInfo(URL feedUrl) {
return backingCache.getFeedInfo(feedUrl);
}
@Override
public void setFeedInfo(URL feedUrl, SyndFeedInfo syndFeedInfo) {
//Make sure that syndFeedInfo is an instance of DeltaSyndFeedInfo
if (!(syndFeedInfo instanceof DeltaSyndFeedInfo)) {
syndFeedInfo = new DeltaSyndFeedInfo(syndFeedInfo);
}
backingCache.setFeedInfo(feedUrl, syndFeedInfo);
}
@Override
public void clear() {
backingCache.clear();
}
@Override
public SyndFeedInfo remove(URL feedUrl) {
return backingCache.remove(feedUrl);
}
}

122
src/main/java/org/rometools/certiorem/hub/DeltaSyndFeedInfo.java Normal file
View file

@ -0,0 +1,122 @@
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package org.rometools.certiorem.hub;
import com.sun.syndication.feed.synd.SyndEntry;
import com.sun.syndication.feed.synd.SyndFeed;
import java.math.BigInteger;
import java.security.MessageDigest;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.rometools.fetcher.impl.SyndFeedInfo;
/**
* Extends SyndFeedInfo to also track etags for individual entries.
* This may be used with DeltaFeedInfoCache to only return feed with a subset of entries that have changed since last fetch.
*
* @author najmi
*/
public class DeltaSyndFeedInfo extends SyndFeedInfo {
Map<String, String> entryTagsMap = new HashMap<String, String>();
Map<String, Boolean> changedMap = new HashMap<String, Boolean>();
private DeltaSyndFeedInfo() {
}
public DeltaSyndFeedInfo(SyndFeedInfo backingFeedInfo) {
this.setETag(backingFeedInfo.getETag());
this.setId(backingFeedInfo.getId());
this.setLastModified(backingFeedInfo.getLastModified());
this.setSyndFeed(backingFeedInfo.getSyndFeed());
}
/**
* Gets a filtered version of the SyndFeed that only has entries that were changed in the last setSyndFeed() call.
*
* @return
*/
@Override
public synchronized SyndFeed getSyndFeed() {
try {
SyndFeed feed = (SyndFeed) super.getSyndFeed().clone();
List<SyndEntry> changedEntries = new ArrayList<SyndEntry>();
List<SyndEntry> entries = feed.getEntries();
for (SyndEntry entry : entries) {
if (changedMap.containsKey(entry.getUri())) {
changedEntries.add(entry);
}
}
feed.setEntries(changedEntries);
return feed;
} catch (CloneNotSupportedException ex) {
throw new RuntimeException(ex);
}
}
/**
* Overrides super class method to update changedMap and entryTagsMap for tracking changed entries.
*
* @param feed
*/
@Override
public final synchronized void setSyndFeed(SyndFeed feed) {
super.setSyndFeed(feed);
changedMap.clear();
List<SyndEntry> entries = feed.getEntries();
for (SyndEntry entry : entries) {
String currentEntryTag = computeEntryTag(entry);
String previousEntryTag = entryTagsMap.get(entry.getUri());
if ((previousEntryTag == null) || (!(currentEntryTag.equals(previousEntryTag)))) {
//Entry has changed
changedMap.put(entry.getUri(), Boolean.TRUE);
}
entryTagsMap.put(entry.getUri(), currentEntryTag);
}
}
private String computeEntryTag(SyndEntry entry) {
//Following hash algorithm suggested by Robert Cooper needs to be evaluated in future.
// int hash = ( entry.getUri() != null ? entry.getUri().hashCode() : entry.getLink().hashCode() ) ^
// (entry.getUpdatedDate() != null ? entry.getUpdatedDate().hashCode() : entry.getPublishedDate().hashCode()) ^
// entry.getTitle().hashCode() ^
// entry.getDescription().hashCode();
String id = entry.getUri();
Date updateDate = entry.getUpdatedDate();
Date publishedDate = entry.getPublishedDate();
if (updateDate == null) {
if (publishedDate != null) {
updateDate = publishedDate;
} else {
//For misbehaving feeds that do not set updateDate or publishedDate we use current tiem which pretty mucg assures that it will be viewed as changed even when it is not
updateDate = new Date();
}
}
String key = id + ":" + entry.getUpdatedDate();
return computeDigest(key);
}
private String computeDigest(String content) {
try {
MessageDigest md = MessageDigest.getInstance("SHA");
byte[] digest = md.digest(content.getBytes());
BigInteger bi = new BigInteger(digest);
return bi.toString(16);
} catch (Exception e) {
return "";
}
}
}

257
src/main/java/org/rometools/certiorem/hub/Hub.java Normal file
View file

@ -0,0 +1,257 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub;
import com.sun.syndication.feed.synd.SyndFeed;
import org.rometools.certiorem.HttpStatusCodeException;
import org.rometools.certiorem.hub.Notifier.SubscriptionSummaryCallback;
import org.rometools.certiorem.hub.Verifier.VerificationCallback;
import org.rometools.certiorem.hub.data.HubDAO;
import org.rometools.certiorem.hub.data.Subscriber;
import org.rometools.certiorem.hub.data.SubscriptionSummary;
import org.rometools.fetcher.FeedFetcher;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* The basic business logic controller for the Hub implementation. It is intended
* to be usable under a very thin servlet wrapper, or other, non-HTTP notification
* methods you might want to use.
*
* @author robert.cooper
*/
public class Hub {
private static final HashSet<String> STANDARD_SCHEMES = new HashSet<String>();
static {
STANDARD_SCHEMES.add("http");
STANDARD_SCHEMES.add("https");
}
private final FeedFetcher fetcher;
private final HubDAO dao;
private final Notifier notifier;
private final Set<Integer> validPorts;
private final Set<String> validSchemes;
private final Set<String> validTopics;
private final Verifier verifier;
/**
* Constructs a new Hub instance
* @param dao The persistence HubDAO to use
* @param verifier The verification strategy to use.
*/
public Hub(final HubDAO dao, final Verifier verifier, final Notifier notifier, final FeedFetcher fetcher) {
this.dao = dao;
this.verifier = verifier;
this.notifier = notifier;
this.fetcher = fetcher;
this.validSchemes = STANDARD_SCHEMES;
this.validPorts = Collections.EMPTY_SET;
this.validTopics = Collections.EMPTY_SET;
}
/**
* Constructs a new Hub instance.
* @param dao The persistence HubDAO to use
* @param verifier The verification strategy to use
* @param validSchemes A list of valid URI schemes for callbacks (default: http, https)
* @param validPorts A list of valid port numbers for callbacks (default: any)
* @param validTopics A set of valid topic URIs which can be subscribed to (default: any)
*/
public Hub(final HubDAO dao, final Verifier verifier, final Notifier notifier, final FeedFetcher fetcher,
final Set<String> validSchemes, final Set<Integer> validPorts, final Set<String> validTopics) {
this.dao = dao;
this.verifier = verifier;
this.notifier = notifier;
this.fetcher = fetcher;
Set<String> readOnlySchemes = Collections.unmodifiableSet(validSchemes);
this.validSchemes = (readOnlySchemes == null) ? STANDARD_SCHEMES : readOnlySchemes;
Set<Integer> readOnlyPorts = Collections.unmodifiableSet(validPorts);
this.validPorts = (readOnlyPorts == null) ? Collections.EMPTY_SET : readOnlyPorts;
Set<String> readOnlyTopics = Collections.unmodifiableSet(validTopics);
this.validTopics = (readOnlyTopics == null) ? Collections.EMPTY_SET : readOnlyTopics;
}
/**
* Sends a notification to the subscribers
* @param requestHost the host name the hub is running on. (Used for the user agent)
* @param topic the URL of the topic that was updated.
* @throws HttpStatusCodeException a wrapper exception with a recommended status code for the request.
*/
public void sendNotification(String requestHost, final String topic) {
assert this.validTopics.isEmpty() || this.validTopics.contains(topic) : "That topic is not supported by this hub. " +
topic;
Logger.getLogger(Hub.class.getName()).log(Level.FINE, "Sending notification for {0}", topic);
try {
List<?extends Subscriber> subscribers = dao.subscribersForTopic(topic);
if (subscribers.isEmpty()) {
Logger.getLogger(Hub.class.getName()).log(Level.FINE, "No subscribers to notify for {0}", topic);
return;
}
List<SubscriptionSummary> summaries = (List<SubscriptionSummary>) dao.summariesForTopic(topic);
int total = 0;
StringBuilder hosts = new StringBuilder();
for (SubscriptionSummary s : summaries) {
if (s.getSubscribers() > 0) {
total += s.getSubscribers();
hosts.append(" (")
.append(s.getHost())
.append("; ")
.append(s.getSubscribers())
.append(" subscribers)");
}
}
StringBuilder userAgent = new StringBuilder("ROME-Certiorem (+http://").append(requestHost)
.append("; ")
.append(total)
.append(" subscribers)")
.append(hosts);
SyndFeed feed = fetcher.retrieveFeed(userAgent.toString(), new URL(topic));
Logger.getLogger(Hub.class.getName()).log(Level.FINE, "Got feed for {0} Sending to {1} subscribers.", new Object[]{topic, subscribers.size()});
this.notifier.notifySubscribers((List<Subscriber>) subscribers, feed,
new SubscriptionSummaryCallback() {
@Override
public void onSummaryInfo(SubscriptionSummary summary) {
dao.handleSummary(topic, summary);
}
});
} catch (Exception ex) {
Logger.getLogger(Hub.class.getName())
.log(Level.SEVERE, "Exception getting " + topic, ex);
throw new HttpStatusCodeException(500, ex.getMessage(), ex);
}
}
/**
* Subscribes to a topic.
* @param callback Callback URI
* @param topic Topic URI
* @param verify Verification Type
* @param lease_seconds Duration of the lease
* @param secret Secret value
* @param verify_token verify_token;
* @return Boolean.TRUE if the subscription succeeded synchronously,
* Boolean.FALSE if the subscription failed synchronously, or null if the request is asynchronous.
* @throws HttpStatusCodeException a wrapper exception with a recommended status code for the request.
*/
public Boolean subscribe(String callback, String topic, String verify, long lease_seconds, String secret,
String verify_token) {
Logger.getLogger(Hub.class.getName()).log(Level.FINE, "{0} wants to subscribe to {1}", new Object[]{callback, topic});
try {
try {
assert callback != null : "Callback URL is required.";
assert topic != null : "Topic URL is required.";
URI uri = new URI(callback);
assert this.validSchemes.contains(uri.getScheme()) : "Not a valid protocol " + uri.getScheme();
assert this.validPorts.isEmpty() || this.validPorts.contains(uri.getPort()) : "Not a valid port " +
uri.getPort();
assert this.validTopics.isEmpty() || this.validTopics.contains(topic) : "Not a supported topic " +
topic;
} catch (URISyntaxException ex) {
assert false : "Not a valid URI " + callback;
}
assert (verify != null) &&
(verify.equals(Subscriber.VERIFY_ASYNC) || verify.equals(Subscriber.VERIFY_SYNC)) : "Unexpected verify value " +
verify;
final Subscriber subscriber = new Subscriber();
subscriber.setCallback(callback);
subscriber.setLeaseSeconds(lease_seconds);
subscriber.setSecret(secret);
subscriber.setTopic(topic);
subscriber.setVerify(verify);
subscriber.setVertifyToken(verify_token);
VerificationCallback verified = new VerificationCallback() {
@Override
public void onVerify(boolean verified) {
if (verified) {
Logger.getLogger(Hub.class.getName()).log(Level.FINE, "Verified {0} subscribed to {1}", new Object[]{subscriber.getCallback(), subscriber.getTopic()});
dao.addSubscriber(subscriber);
}
}
};
if (Subscriber.VERIFY_SYNC.equals(subscriber.getVerify())) {
boolean result = verifier.verifySubcribeSyncronously(subscriber);
verified.onVerify(result);
return result;
} else {
verifier.verifySubscribeAsyncronously(subscriber, verified);
return null;
}
} catch (AssertionError ae) {
throw new HttpStatusCodeException(400, ae.getMessage(), ae);
} catch (Exception e) {
throw new HttpStatusCodeException(500, e.getMessage(), e);
}
}
public Boolean unsubscribe(final String callback, final String topic, String verify, String secret, String verifyToken) {
final Subscriber subscriber = dao.findSubscriber(topic, callback);
if(subscriber == null){
throw new HttpStatusCodeException(400, "Not a valid subscription.", null);
}
subscriber.setVertifyToken(verifyToken);
subscriber.setSecret(secret);
if(Subscriber.VERIFY_SYNC.equals(verify)){
boolean ret = verifier.verifyUnsubcribeSyncronously(subscriber);
if(ret){
dao.removeSubscriber(topic, callback);
}
} else {
verifier.verifyUnsubscribeAsyncronously(subscriber, new VerificationCallback(){
@Override
public void onVerify(boolean verified) {
Logger.getLogger(Hub.class.getName()).log(Level.FINE, "Unsubscribe for {0} at {1} verified {2}", new Object[]{subscriber.getTopic(), subscriber.getCallback(), verified});
if(verified){
dao.removeSubscriber(topic, callback);
}
}
});
}
return null;
}
}

53
src/main/java/org/rometools/certiorem/hub/Notifier.java Normal file
View file

@ -0,0 +1,53 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub;
import com.sun.syndication.feed.synd.SyndFeed;
import org.rometools.certiorem.hub.data.Subscriber;
import org.rometools.certiorem.hub.data.SubscriptionSummary;
import java.util.List;
/**
*
* @author robert.cooper
*/
public interface Notifier {
/**
* Instructs the notifier to begin sending notifications to the list of subscribers
*
* @param subscribers Subscribers to notify
* @param value The SyndFeed to send them
* @param callback A callback that is invoked each time a subscriber is notified.
*/
public void notifySubscribers(List<Subscriber> subscribers, SyndFeed value, SubscriptionSummaryCallback callback);
/**
* A callback that is invoked each time a subscriber is notified.
*/
public static interface SubscriptionSummaryCallback {
/**
*
* @param summary A summary of the data received from the subscriber
*/
public void onSummaryInfo(SubscriptionSummary summary);
}
}

78
src/main/java/org/rometools/certiorem/hub/Verifier.java Normal file
View file

@ -0,0 +1,78 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub;
import org.rometools.certiorem.hub.data.Subscriber;
/**
* A strategy interface for verification of subscriptions.
* @author robert.cooper
*/
public interface Verifier {
/**
* Value for hub.mode = subscribe
*/
public static final String MODE_SUBSCRIBE = "subscribe";
/**
* Value for hub.mode = unsubscribe
*/
public static final String MODE_UNSUBSCRIBE = "unsubscribe";
/**
* Verifies a subscriber (possibly) asyncronously
* @param subscriber the Subscriber to verify
* @param callback a callback with the result of the verification.
*/
public void verifySubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback);
/**
* Verifies a subscriber syncronously
* @param subscriber The subscriber data
* @return boolean result;
*/
public boolean verifySubcribeSyncronously(Subscriber subscriber);
/**
* Verifies am unsubscribe (possibly) asyncronously
* @param subscriber The subscriber data
* @param callback result
*/
public void verifyUnsubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback);
/**
* Verifies an unsubscribe syncronously
* @param subscriber The subscriber data
* @return boolean result;
*/
public boolean verifyUnsubcribeSyncronously(Subscriber subscriber);
/**
* An interface for capturing the result of a verification (subscribe or unsubscribe)
*/
public static interface VerificationCallback {
/**
*
* @param verified success state of the verification
*/
public void onVerify(boolean verified);
}
}

42
src/main/java/org/rometools/certiorem/hub/data/HubDAO.java Normal file
View file

@ -0,0 +1,42 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.data;
import java.util.List;
/**
*
* @author robert.cooper
*/
public interface HubDAO {
public List<? extends Subscriber> subscribersForTopic(String topic);
public Subscriber addSubscriber(Subscriber subscriber);
public Subscriber findSubscriber(String topic, String callbackUrl);
public void removeSubscriber(String topic, String callback);
public void handleSummary(String topic, SubscriptionSummary summary);
public List<? extends SubscriptionSummary> summariesForTopic(String topic);
}

221
src/main/java/org/rometools/certiorem/hub/data/Subscriber.java Normal file
View file

@ -0,0 +1,221 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.data;
import java.io.Serializable;
/**
*
* @author robert.cooper
*/
public class Subscriber implements Serializable {
public static final String VERIFY_SYNC = "sync";
public static final String VERIFY_ASYNC = "async";
private String callback;
private String secret;
private String topic;
private String verify;
private String vertifyToken;
private long creationTime = System.currentTimeMillis();
private long leaseSeconds;
/**
* Set the value of callback
*
* @param newcallback new value of callback
*/
public void setCallback(String newcallback) {
this.callback = newcallback;
}
/**
* Get the value of callback
*
* @return the value of callback
*/
public String getCallback() {
return this.callback;
}
/**
* Set the value of creationTime
*
* @param newcreationTime new value of creationTime
*/
public void setCreationTime(long newcreationTime) {
this.creationTime = newcreationTime;
}
/**
* Get the value of creationTime
*
* @return the value of creationTime
*/
public long getCreationTime() {
return this.creationTime;
}
/**
* Set the value of leaseSeconds
*
* @param newleaseSeconds new value of leaseSeconds
*/
public void setLeaseSeconds(long newleaseSeconds) {
this.leaseSeconds = newleaseSeconds;
}
/**
* Get the value of leaseSeconds
*
* @return the value of leaseSeconds
*/
public long getLeaseSeconds() {
return this.leaseSeconds;
}
/**
* Set the value of secret
*
* @param newsecret new value of secret
*/
public void setSecret(String newsecret) {
this.secret = newsecret;
}
/**
* Get the value of secret
*
* @return the value of secret
*/
public String getSecret() {
return this.secret;
}
/**
* Set the value of topic
*
* @param newtopic new value of topic
*/
public void setTopic(String newtopic) {
this.topic = newtopic;
}
/**
* Get the value of topic
*
* @return the value of topic
*/
public String getTopic() {
return this.topic;
}
/**
* Set the value of verify
*
* @param newverify new value of verify
*/
public void setVerify(String newverify) {
this.verify = newverify;
}
/**
* Get the value of verify
*
* @return the value of verify
*/
public String getVerify() {
return this.verify;
}
/**
* Set the value of vertifyToken
*
* @param newvertifyToken new value of vertifyToken
*/
public void setVertifyToken(String newvertifyToken) {
this.vertifyToken = newvertifyToken;
}
/**
* Get the value of vertifyToken
*
* @return the value of vertifyToken
*/
public String getVertifyToken() {
return this.vertifyToken;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (!(obj instanceof Subscriber)) {
return false;
}
final Subscriber other = (Subscriber) obj;
if ((this.callback == null) ? (other.callback != null) : (!this.callback.equals(other.callback))) {
return false;
}
if ((this.secret == null) ? (other.secret != null) : (!this.secret.equals(other.secret))) {
return false;
}
if ((this.topic == null) ? (other.topic != null) : (!this.topic.equals(other.topic))) {
return false;
}
if ((this.verify == null) ? (other.verify != null) : (!this.verify.equals(other.verify))) {
return false;
}
if ((this.vertifyToken == null) ? (other.vertifyToken != null) : (!this.vertifyToken.equals(other.vertifyToken))) {
return false;
}
if (this.creationTime != other.creationTime) {
return false;
}
if (this.leaseSeconds != other.leaseSeconds) {
return false;
}
return true;
}
@Override
public int hashCode() {
int hash = 7;
hash = (67 * hash) + ((this.callback != null) ? this.callback.hashCode() : 0);
hash = (67 * hash) + ((this.secret != null) ? this.secret.hashCode() : 0);
hash = (67 * hash) + ((this.topic != null) ? this.topic.hashCode() : 0);
hash = (67 * hash) + ((this.verify != null) ? this.verify.hashCode() : 0);
hash = (67 * hash) + ((this.vertifyToken != null) ? this.vertifyToken.hashCode() : 0);
hash = (67 * hash) + (int) (this.creationTime ^ (this.creationTime >>> 32));
hash = (67 * hash) + (int) (this.leaseSeconds ^ (this.leaseSeconds >>> 32));
return hash;
}
}

86
src/main/java/org/rometools/certiorem/hub/data/SubscriptionSummary.java Normal file
View file

@ -0,0 +1,86 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.data;
import java.io.Serializable;
/**
*
* @author robert.cooper
*/
public class SubscriptionSummary implements Serializable {
private String host;
private boolean lastPublishSuccessful = true;
private int subscribers = 0;
/**
* Set the value of host
*
* @param newhost new value of host
*/
public void setHost(String newhost) {
this.host = newhost;
}
/**
* Get the value of host
*
* @return the value of host
*/
public String getHost() {
return this.host;
}
/**
* Set the value of lastPublishSuccessful
*
* @param newlastPublishSuccessful new value of lastPublishSuccessful
*/
public void setLastPublishSuccessful(boolean newlastPublishSuccessful) {
this.lastPublishSuccessful = newlastPublishSuccessful;
}
/**
* Get the value of lastPublishSuccessful
*
* @return the value of lastPublishSuccessful
*/
public boolean isLastPublishSuccessful() {
return this.lastPublishSuccessful;
}
/**
* Set the value of subscribers
*
* @param newsubscribers new value of subscribers
*/
public void setSubscribers(int newsubscribers) {
this.subscribers = newsubscribers;
}
/**
* Get the value of subscribers
*
* @return the value of subscribers
*/
public int getSubscribers() {
return this.subscribers;
}
}

131
src/main/java/org/rometools/certiorem/hub/data/jpa/JPADAO.java Normal file
View file

@ -0,0 +1,131 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.data.jpa;
import org.rometools.certiorem.hub.data.HubDAO;
import org.rometools.certiorem.hub.data.Subscriber;
import java.util.LinkedList;
import java.util.List;
import java.util.UUID;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.NoResultException;
import javax.persistence.Query;
import org.rometools.certiorem.hub.data.SubscriptionSummary;
/**
*
* @author robert.cooper
*/
public class JPADAO implements HubDAO {
private final EntityManagerFactory factory;
private final boolean purgeExpired;
public JPADAO(final EntityManagerFactory factory, final boolean purgeExpired) {
this.factory = factory;
this.purgeExpired = purgeExpired;
}
@Override
public List<? extends Subscriber> subscribersForTopic(String topic) {
LinkedList<JPASubscriber> result = new LinkedList<JPASubscriber>();
EntityManager em = factory.createEntityManager();
EntityTransaction tx = em.getTransaction();
tx.begin();
Query query = em.createNamedQuery("Subcriber.forTopic");
query.setParameter("topic", topic);
try {
for (JPASubscriber subscriber : (List<JPASubscriber>) query.getResultList()) {
if (subscriber.getLeaseSeconds() == -1) {
result.add(subscriber);
continue;
}
if (subscriber.getSubscribedAt().getTime() < (System.currentTimeMillis() - (1000 * subscriber.getLeaseSeconds()))) {
subscriber.setExpired(true);
} else {
result.add(subscriber);
}
if (subscriber.isExpired() && this.purgeExpired) {
em.remove(subscriber);
}
}
} catch (NoResultException e) {
tx.rollback();
em.close();
return result;
}
if (!tx.getRollbackOnly()) {
tx.commit();
} else {
tx.rollback();
}
em.close();
return result;
}
@Override
public Subscriber addSubscriber(Subscriber subscriber) {
assert subscriber != null : "Attempt to store a null subscriber";
EntityManager em = factory.createEntityManager();
EntityTransaction tx = em.getTransaction();
tx.begin();
JPASubscriber data = new JPASubscriber();
data.copyFrom(subscriber);
data.setId(UUID.randomUUID().toString());
em.persist(data);
tx.commit();
em.close();
return data;
}
@Override
public Subscriber findSubscriber(String topic, String callbackUrl) {
throw new UnsupportedOperationException("Not supported yet.");
}
@Override
public void handleSummary(String topic, SubscriptionSummary summary) {
throw new UnsupportedOperationException("Not supported yet.");
}
@Override
public List<? extends SubscriptionSummary> summariesForTopic(String topic) {
throw new UnsupportedOperationException("Not supported yet.");
}
@Override
public void removeSubscriber(String topic, String callback) {
throw new UnsupportedOperationException("Not supported yet.");
}
}

111
src/main/java/org/rometools/certiorem/hub/data/jpa/JPASubscriber.java Normal file
View file

@ -0,0 +1,111 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.data.jpa;
import org.rometools.certiorem.hub.data.Subscriber;
import java.io.Serializable;
import java.util.Date;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
/**
*
* @author robert.cooper
*/
@Entity
@NamedQueries({@NamedQuery(name = "Subcriber.forTopic", query = "SELECT o FROM JPASubscriber o WHERE o.topic = :topic AND o.expired = false ORDER BY o.subscribedAt")
})
public class JPASubscriber extends Subscriber implements Serializable {
private Date subscribedAt = new Date();
private String id;
private boolean expired = false;
/**
* Set the value of expired
*
* @param newexpired new value of expired
*/
public void setExpired(boolean newexpired) {
this.expired = newexpired;
}
/**
* Get the value of expired
*
* @return the value of expired
*/
public boolean isExpired() {
return this.expired;
}
/**
* Set the value of id
*
* @param newid new value of id
*/
public void setId(String newid) {
this.id = newid;
}
/**
* Get the value of id
*
* @return the value of id
*/
@Id
public String getId() {
return this.id;
}
/**
* Set the value of subscribedAt
*
* @param newsubscribedAt new value of subscribedAt
*/
public void setSubscribedAt(Date newsubscribedAt) {
this.subscribedAt = newsubscribedAt;
}
/**
* Get the value of subscribedAt
*
* @return the value of subscribedAt
*/
@Temporal(TemporalType.TIMESTAMP)
public Date getSubscribedAt() {
return this.subscribedAt;
}
public void copyFrom(Subscriber source) {
this.setLeaseSeconds(source.getLeaseSeconds());
this.setSecret(source.getSecret());
this.setTopic(source.getTopic());
this.setVerify(source.getVerify());
this.setVertifyToken(source.getVertifyToken());
}
}

28
src/main/java/org/rometools/certiorem/hub/data/jpa/package.html Normal file
View file

@ -0,0 +1,28 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>jpa</title>
</head>
<body>
A stock data implementation based on the Java Persistence API.
</body>
</html>

29
src/main/java/org/rometools/certiorem/hub/data/package.html Normal file
View file

@ -0,0 +1,29 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>data</title>
</head>
<body>
This package defines the basic data types and persistence mechanisms
that are required for a hub implementation.
</body>
</html>

138
src/main/java/org/rometools/certiorem/hub/data/ram/InMemoryHubDAO.java Normal file
View file

@ -0,0 +1,138 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.data.ram;
import org.rometools.certiorem.hub.data.HubDAO;
import org.rometools.certiorem.hub.data.Subscriber;
import org.rometools.certiorem.hub.data.SubscriptionSummary;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
/**
* A Simple In-Memory HubDAO for subscribers.
*
* @author robert.cooper
*/
public class InMemoryHubDAO implements HubDAO {
private ConcurrentHashMap<String, List<Subscriber>> subscribers = new ConcurrentHashMap<String, List<Subscriber>>();
private ConcurrentHashMap<String, ConcurrentHashMap<String, SubscriptionSummary>> summaries = new ConcurrentHashMap<String, ConcurrentHashMap<String, SubscriptionSummary>>();
@Override
public Subscriber addSubscriber(Subscriber subscriber) {
assert subscriber != null : "Attempt to store a null subscriber";
List<Subscriber> subList = this.subscribers.get(subscriber.getTopic());
if (subList == null) {
synchronized (this) {
subList = new CopyOnWriteArrayList<Subscriber>();
this.subscribers.put(subscriber.getTopic(), subList);
}
}
subList.add(subscriber);
return subscriber;
}
@Override
public void handleSummary(String topic, SubscriptionSummary summary) {
ConcurrentHashMap<String, SubscriptionSummary> hostsToSummaries = this.summaries.get(topic);
if (hostsToSummaries == null) {
synchronized (this) {
hostsToSummaries = new ConcurrentHashMap<String, SubscriptionSummary>();
this.summaries.put(topic, hostsToSummaries);
}
}
hostsToSummaries.put(summary.getHost(), summary);
}
@Override
public List<?extends Subscriber> subscribersForTopic(String topic) {
if (subscribers.containsKey(topic)) {
List<Subscriber> result = new LinkedList<Subscriber>();
LinkedList<Subscriber> expired = new LinkedList<Subscriber>();
for (Subscriber s : subscribers.get(topic)) {
if ((s.getLeaseSeconds() > 0) &&
(System.currentTimeMillis() >= (s.getCreationTime() + (s.getLeaseSeconds() * 1000L)))) {
expired.add(s);
} else {
result.add(s);
}
}
if (!expired.isEmpty()) {
subscribers.get(topic)
.removeAll(expired);
}
return result;
} else {
return Collections.EMPTY_LIST;
}
}
@Override
public List<?extends SubscriptionSummary> summariesForTopic(String topic) {
LinkedList<SubscriptionSummary> result = new LinkedList<SubscriptionSummary>();
if (this.summaries.containsKey(topic)) {
result.addAll(this.summaries.get(topic).values());
}
return result;
}
@Override
public Subscriber findSubscriber(String topic, String callbackUrl) {
for (Subscriber s : this.subscribersForTopic(topic)) {
if (callbackUrl.equals(s.getCallback())) {
return s;
}
}
return null;
}
@Override
public void removeSubscriber(String topic, String callback) {
List<Subscriber> subs = this.subscribers.get(topic);
if(subs == null){
return;
}
Subscriber match = null;
for(Subscriber s: subs){
if(s.getCallback().equals(callback)){
match = s;
break;
}
}
if(match != null){
subs.remove(match);
}
}
}

25
src/main/java/org/rometools/certiorem/hub/data/ram/package.html Normal file
View file

@ -0,0 +1,25 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<body>
Contains a Memory-Resident implemtnation of the Hub DAO.
</body>
</html>

170
src/main/java/org/rometools/certiorem/hub/notify/standard/AbstractNotifier.java Normal file
View file

@ -0,0 +1,170 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.notify.standard;
import com.sun.syndication.feed.synd.SyndFeed;
import com.sun.syndication.io.FeedException;
import com.sun.syndication.io.SyndFeedOutput;
import org.rometools.certiorem.hub.Notifier;
import org.rometools.certiorem.hub.data.Subscriber;
import org.rometools.certiorem.hub.data.SubscriptionSummary;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.rometools.certiorem.sub.data.ram.InMemorySubDAO;
/**
*
* @author robert.cooper
*/
public abstract class AbstractNotifier implements Notifier {
/**
* This method will serialize the synd feed and build Notifications for the
* implementation class to handle.
* @see enqueueNotification
*
* @param subscribers List of subscribers to notify
* @param value The SyndFeed object to send
* @param callback A callback that will be invoked each time a subscriber is notified.
*
*/
@Override
public void notifySubscribers(List<Subscriber> subscribers, SyndFeed value, SubscriptionSummaryCallback callback) {
String mimeType = null;
if (value.getFeedType()
.startsWith("rss")) {
mimeType = "application/rss+xml";
} else {
mimeType = "application/atom+xml";
}
SyndFeedOutput output = new SyndFeedOutput();
ByteArrayOutputStream baos = new ByteArrayOutputStream();
try {
output.output(value, new OutputStreamWriter(baos));
baos.close();
} catch (IOException ex) {
Logger.getLogger(AbstractNotifier.class.getName())
.log(Level.SEVERE, null, ex);
throw new RuntimeException("Unable to output the feed.", ex);
} catch (FeedException ex) {
Logger.getLogger(AbstractNotifier.class.getName())
.log(Level.SEVERE, null, ex);
throw new RuntimeException("Unable to output the feed.", ex);
}
byte[] payload = baos.toByteArray();
for (Subscriber s : subscribers) {
Notification not = new Notification();
not.callback = callback;
not.lastRun = 0;
not.mimeType = mimeType;
not.payload = payload;
not.retryCount = 0;
not.subscriber = s;
this.enqueueNotification(not);
}
}
/** Implementation method that queues/sends a notification
*
* @param not notification to send.
*/
protected abstract void enqueueNotification(Notification not);
/**
* POSTs the payload to the subscriber's callback and returns a
* SubscriptionSummary with subscriber counts (where possible) and the
* success state of the notification.
* @param subscriber subscriber data.
* @param mimeType MIME type for the request
* @param payload payload of the feed to send
* @return SubscriptionSummary with the returned data.
*/
protected SubscriptionSummary postNotification(Subscriber subscriber, String mimeType, byte[] payload) {
SubscriptionSummary result = new SubscriptionSummary();
try {
URL target = new URL(subscriber.getCallback());
Logger.getLogger(AbstractNotifier.class.getName()).log(Level.INFO, "Posting notification to subscriber {0}", subscriber.getCallback());
result.setHost(target.getHost());
HttpURLConnection connection = (HttpURLConnection) target.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", mimeType);
connection.setDoOutput(true);
connection.connect();
OutputStream os = connection.getOutputStream();
os.write(payload);
os.close();
int responseCode = connection.getResponseCode();
String subscribers = connection.getHeaderField("X-Hub-On-Behalf-Of");
connection.disconnect();
if (responseCode != 200) {
Logger.getLogger(AbstractNotifier.class.getName())
.log(Level.WARNING, "Got code " + responseCode + " from " + target);
result.setLastPublishSuccessful(false);
return result;
}
if (subscribers != null) {
try {
result.setSubscribers(Integer.parseInt(subscribers));
} catch (NumberFormatException nfe) {
Logger.getLogger(AbstractNotifier.class.getName())
.log(Level.WARNING, "Invalid subscriber value " + subscribers + " " + target, nfe);
result.setSubscribers(-1);
}
} else {
result.setSubscribers(-1);
}
} catch (MalformedURLException ex) {
Logger.getLogger(AbstractNotifier.class.getName())
.log(Level.WARNING, null, ex);
result.setLastPublishSuccessful(false);
} catch (IOException ex) {
Logger.getLogger(AbstractNotifier.class.getName())
.log(Level.SEVERE, null, ex);
result.setLastPublishSuccessful(false);
}
return result;
}
}

38
src/main/java/org/rometools/certiorem/hub/notify/standard/Notification.java Normal file
View file

@ -0,0 +1,38 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.notify.standard;
import org.rometools.certiorem.hub.Notifier.SubscriptionSummaryCallback;
import org.rometools.certiorem.hub.data.Subscriber;
/**
*
* @author robert.cooper
*/
public class Notification {
int retryCount = 0;
long lastRun = 0;
Subscriber subscriber;
String mimeType;
byte[] payload;
SubscriptionSummaryCallback callback;
}

114
src/main/java/org/rometools/certiorem/hub/notify/standard/ThreadPoolNotifier.java Normal file
View file

@ -0,0 +1,114 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.notify.standard;
import org.rometools.certiorem.hub.data.SubscriptionSummary;
import java.util.Timer;
import java.util.TimerTask;
import java.util.concurrent.ConcurrentSkipListSet;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
/**
* A notifier implementation that uses a thread pool to deliver notifications to
* subscribers
*
* @author robert.cooper
*/
public class ThreadPoolNotifier extends AbstractNotifier {
private static final long TWO_MINUTES = 2 * 60 * 1000;
protected final ThreadPoolExecutor exeuctor;
private final Timer timer = new Timer();
private final ConcurrentSkipListSet<String> pendings = new ConcurrentSkipListSet<String>();
public ThreadPoolNotifier() {
this(2, 5, 5);
}
public ThreadPoolNotifier(int startPoolSize, int maxPoolSize, int queueSize) {
this.exeuctor = new ThreadPoolExecutor(startPoolSize, maxPoolSize, 300, TimeUnit.SECONDS,
new LinkedBlockingQueue<Runnable>(queueSize));
}
protected ThreadPoolNotifier(final ThreadPoolExecutor executor) {
this.exeuctor = executor;
}
/**
* Enqueues a notification to run. If the notification fails, it will be
* retried every two minutes until 5 attempts are completed. Notifications
* to the same callback should be delivered successfully in order.
* @param not
*/
@Override
protected void enqueueNotification(final Notification not) {
Runnable r = new Runnable() {
@Override
public void run() {
not.lastRun = System.currentTimeMillis();
SubscriptionSummary summary = postNotification(not.subscriber, not.mimeType, not.payload);
if (!summary.isLastPublishSuccessful()) {
not.retryCount++;
if (not.retryCount <= 5) {
retry(not);
}
}
not.callback.onSummaryInfo(summary);
}
};
this.exeuctor.execute(r);
}
/**
* Schedules a notification to retry in two minutes.
* @param not Notification to retry
*/
protected void retry(final Notification not) {
if (!pendings.contains(not.subscriber.getCallback())) {
// We don't have a current retry for this callback pending, so we
// will schedule the retry
pendings.add(not.subscriber.getCallback());
timer.schedule(new TimerTask() {
@Override
public void run() {
pendings.remove(not.subscriber.getCallback());
enqueueNotification(not);
}
}, TWO_MINUTES);
} else {
// There is a retry in front of this one, so we will just schedule
// it to retry again in a bit
timer.schedule(new TimerTask() {
@Override
public void run() {
retry(not);
}
}, TWO_MINUTES);
}
}
}

49
src/main/java/org/rometools/certiorem/hub/notify/standard/UnthreadedNotifier.java Normal file
View file

@ -0,0 +1,49 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.notify.standard;
import org.rometools.certiorem.hub.data.SubscriptionSummary;
import java.util.concurrent.ConcurrentSkipListSet;
/**
* A notifier that does not use threads. All calls are blocking and synchronous.
*
* @author robert.cooper
*/
public class UnthreadedNotifier extends AbstractNotifier {
private final ConcurrentSkipListSet<Notification> retries = new ConcurrentSkipListSet<Notification>();
/**
* A blocking call that performs a notification.
* If there are pending retries that are older than two minutes old, they will
* be retried before the method returns.
*
* @param not
*/
@Override
protected void enqueueNotification(Notification not) {
not.lastRun = System.currentTimeMillis();
SubscriptionSummary summary = postNotification(not.subscriber, not.mimeType, not.payload);
not.callback.onSummaryInfo(summary);
}
}

32
src/main/java/org/rometools/certiorem/hub/notify/standard/package.html Normal file
View file

@ -0,0 +1,32 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>verify</title>
</head>
<body>
This package contains a set of standard Verifier implementations.
<p>
These implementations all use the standard java.net.* classes for
making requests to URLs.
</p>
</body>
</html>

30
src/main/java/org/rometools/certiorem/hub/package.html Normal file
View file

@ -0,0 +1,30 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>hub</title>
</head>
<body>
This package contains the core of the Hub implementation.
<h1>Getting Started</h1>
<p>The Hub implementation </p>
</body>
</html>

108
src/main/java/org/rometools/certiorem/hub/verify/standard/AbstractVerifier.java Normal file
View file

@ -0,0 +1,108 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.verify.standard;
import org.rometools.certiorem.hub.Verifier;
import org.rometools.certiorem.hub.data.Subscriber;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.util.UUID;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* An abstract verifier based on the java.net HTTP classes. This implements only
* synchronous operations, and expects a child class to do Async ops.
*
* @author robert.cooper
*/
public abstract class AbstractVerifier implements Verifier {
@Override
public boolean verifySubcribeSyncronously(Subscriber subscriber) {
return doOp(Verifier.MODE_SUBSCRIBE, subscriber);
}
@Override
public boolean verifyUnsubcribeSyncronously(Subscriber subscriber) {
return doOp(Verifier.MODE_UNSUBSCRIBE, subscriber);
}
private boolean doOp(String mode, Subscriber subscriber){
try {
String challenge = UUID.randomUUID()
.toString();
StringBuilder queryString = new StringBuilder();
queryString.append("hub.mode=")
.append(mode)
.append("&hub.topic=")
.append(URLEncoder.encode(subscriber.getTopic(), "UTF-8"))
.append("&hub.challenge=")
.append(challenge);
if (subscriber.getLeaseSeconds() != -1) {
queryString.append("&hub.lease_seconds=")
.append(subscriber.getLeaseSeconds());
}
if (subscriber.getVertifyToken() != null) {
queryString.append("&hub.verify_token=")
.append(URLEncoder.encode(subscriber.getVertifyToken(), "UTF-8"));
}
URL url = new URL(subscriber.getCallback() + "?" + queryString.toString());
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setDoInput(true);
// connection.setRequestProperty("Host", url.getHost());
// connection.setRequestProperty("Port", Integer.toString(url.getPort()));
connection.setRequestProperty("User-Agent", "ROME-Certiorem");
connection.connect();
int rc = connection.getResponseCode();
InputStream is = connection.getInputStream();
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
String result = reader.readLine();
reader.close();
connection.disconnect();
if ((rc != 200) || !challenge.equals(result.trim())) {
return false;
} else {
return true;
}
} catch (UnsupportedEncodingException ex) {
Logger.getLogger(AbstractVerifier.class.getName())
.log(Level.SEVERE, null, ex);
throw new RuntimeException("Should not happen. UTF-8 threw unsupported encoding", ex);
} catch (IOException ex) {
Logger.getLogger(AbstractVerifier.class.getName())
.log(Level.SEVERE, null, ex);
return false;
}
}
}

68
src/main/java/org/rometools/certiorem/hub/verify/standard/ThreadPoolVerifier.java Normal file
View file

@ -0,0 +1,68 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.verify.standard;
import org.rometools.certiorem.hub.data.Subscriber;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
/**
* Uses a ThreadPoolExecutor to do async verifications.
* @author robert.cooper
*/
public class ThreadPoolVerifier extends AbstractVerifier {
protected final ThreadPoolExecutor exeuctor;
protected ThreadPoolVerifier(final ThreadPoolExecutor executor){
this.exeuctor = executor;
}
public ThreadPoolVerifier() {
this(2, 5, 5);
}
public ThreadPoolVerifier(int startPoolSize, int maxPoolSize, int queueSize) {
this.exeuctor = new ThreadPoolExecutor(startPoolSize, maxPoolSize, 300, TimeUnit.SECONDS,
new LinkedBlockingQueue<Runnable>(queueSize));
}
@Override
public void verifySubscribeAsyncronously(final Subscriber subscriber, final VerificationCallback callback) {
this.exeuctor.execute(new Runnable() {
@Override
public void run() {
callback.onVerify(verifySubcribeSyncronously(subscriber));
}
});
}
@Override
public void verifyUnsubscribeAsyncronously(final Subscriber subscriber, final VerificationCallback callback) {
this.exeuctor.execute(new Runnable() {
@Override
public void run() {
callback.onVerify(verifyUnsubcribeSyncronously(subscriber));
}
});
}
}

33
src/main/java/org/rometools/certiorem/hub/verify/standard/ThreadpoolVerifierAdvanced.java Normal file
View file

@ -0,0 +1,33 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.verify.standard;
import java.util.concurrent.ThreadPoolExecutor;
/**
*
* @author robert.cooper
*/
public class ThreadpoolVerifierAdvanced extends ThreadPoolVerifier{
public ThreadpoolVerifierAdvanced(ThreadPoolExecutor executor){
super(executor);
}
}

41
src/main/java/org/rometools/certiorem/hub/verify/standard/UnthreadedVerifier.java Normal file
View file

@ -0,0 +1,41 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.verify.standard;
import org.rometools.certiorem.hub.data.Subscriber;
/**
* A verifier that does not use threads. Suitable for Google App Engine.
* @author robert.cooper
*/
public class UnthreadedVerifier extends AbstractVerifier{
@Override
public void verifySubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback) {
callback.onVerify(verifySubcribeSyncronously(subscriber));
}
@Override
public void verifyUnsubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback) {
callback.onVerify(verifyUnsubcribeSyncronously(subscriber));
}
}

32
src/main/java/org/rometools/certiorem/hub/verify/standard/package.html Normal file
View file

@ -0,0 +1,32 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>verify</title>
</head>
<body>
This package contains a set of standard Verifier implementations.
<p>
These implementations all use the standard java.net.* classes for
making requests to URLs.
</p>
</body>
</html>

30
src/main/java/org/rometools/certiorem/package.html Normal file
View file

@ -0,0 +1,30 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<body>
A pub sub hubub implementation for Java.
</body>
</html>

36
src/main/java/org/rometools/certiorem/pub/NotificationException.java Normal file
View file

@ -0,0 +1,36 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.pub;
/**
*
* @author robert.cooper
*/
public class NotificationException extends Exception {
public NotificationException(String message){
super(message);
}
public NotificationException(String message, Throwable cause){
super(message, cause);
}
}

248
src/main/java/org/rometools/certiorem/pub/Publisher.java Normal file
View file

@ -0,0 +1,248 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.pub;
import com.sun.syndication.feed.synd.SyndFeed;
import com.sun.syndication.feed.synd.SyndLink;
import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.util.List;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* A class for sending update notifications to a hub.
* @author robert.cooper
*/
public class Publisher {
private ThreadPoolExecutor executor;
/**
* Constructs a new publisher. This publisher will spawn a new thread for each async send.
*/
public Publisher() {
}
/**
* Constructs a new publisher with an optional ThreadPoolExector for sending updates.
*/
public Publisher(ThreadPoolExecutor executor) {
this.executor = executor;
}
/**
* Sends the HUB url a notification of a change in topic
* @param hub URL of the hub to notify.
* @param topic The Topic that has changed
* @throws NotificationException Any failure
*/
public void sendUpdateNotification(String hub, String topic)
throws NotificationException {
try {
StringBuilder sb = new StringBuilder("hub.mode=publish&hub.url=").append(URLEncoder.encode(topic, "UTF-8"));
URL hubUrl = new URL(hub);
HttpURLConnection connection = (HttpURLConnection) hubUrl.openConnection();
// connection.setRequestProperty("Host", hubUrl.getHost());
connection.setRequestProperty("User-Agent", "ROME-Certiorem");
connection.setRequestProperty("ContentType", "application/x-www-form-urlencoded");
connection.setDoOutput(true);
connection.connect();
OutputStream os = connection.getOutputStream();
os.write(sb.toString().getBytes("UTF-8"));
os.close();
int rc = connection.getResponseCode();
connection.disconnect();
if (rc != 204) {
throw new NotificationException("Server returned an unexcepted response code: " + rc + " " +
connection.getResponseMessage());
}
} catch (UnsupportedEncodingException ex) {
Logger.getLogger(Publisher.class.getName())
.log(Level.SEVERE, null, ex);
throw new NotificationException("Could not encode URL", ex);
} catch (IOException ex) {
Logger.getLogger(Publisher.class.getName())
.log(Level.SEVERE, null, ex);
throw new NotificationException("Unable to communicate with " + hub, ex);
}
}
/**
* Sends a notification for a feed located at "topic". The feed MUST contain rel="hub".
* @param topic URL for the feed
* @param feed The feed itself
* @throws NotificationException Any failure
*/
public void sendUpdateNotification(String topic, SyndFeed feed)
throws NotificationException {
for (SyndLink link : (List<SyndLink>) feed.getLinks()) {
if ("hub".equals(link.getRel())) {
sendUpdateNotification(link.getRel(), topic);
return;
}
}
throw new NotificationException("Hub link not found.");
}
/**
* Sends a notification for a feed. The feed MUST contain rel="hub" and rel="self" links.
* @param feed The feed to notify
* @throws NotificationException Any failure
*/
public void sendUpdateNotification(SyndFeed feed) throws NotificationException {
SyndLink hub = null;
SyndLink self = null;
for (SyndLink link : (List<SyndLink>) feed.getLinks()) {
if ("hub".equals(link.getRel())) {
hub = link;
}
if ("self".equals(link.getRel())) {
self = link;
}
if ((hub != null) && (self != null)) {
break;
}
}
if (hub == null) {
throw new NotificationException("A link rel='hub' was not found in the feed.");
}
if (self == null) {
throw new NotificationException("A link rel='self' was not found in the feed.");
}
sendUpdateNotification(hub.getRel(), self.getHref());
}
/**
* Sends the HUB url a notification of a change in topic asynchronously
* @param hub URL of the hub to notify.
* @param topic The Topic that has changed
* @param callback A callback invoked when the notification completes.
* @throws NotificationException Any failure
*/
public void sendUpdateNotificationAsyncronously(final String hub, final String topic,
final AsyncNotificationCallback callback) {
Runnable r = new Runnable() {
@Override
public void run() {
try {
sendUpdateNotification(hub, topic);
callback.onSuccess();
} catch (Throwable t) {
callback.onFailure(t);
}
}
};
if (this.executor != null) {
this.executor.execute(r);
} else {
new Thread(r).start();
}
}
/**
* Asynchronously sends a notification for a feed located at "topic". The feed MUST contain rel="hub".
* @param topic URL for the feed
* @param feed The feed itself
* @param callback A callback invoked when the notification completes.
* @throws NotificationException Any failure
*/
public void sendUpdateNotificationAsyncronously(final String topic, final SyndFeed feed,
final AsyncNotificationCallback callback) {
Runnable r = new Runnable() {
@Override
public void run() {
try {
sendUpdateNotification(topic, feed);
callback.onSuccess();
} catch (Throwable t) {
callback.onFailure(t);
}
}
};
if (this.executor != null) {
this.executor.execute(r);
} else {
new Thread(r).start();
}
}
/**
* Asyncronously sends a notification for a feed. The feed MUST contain rel="hub" and rel="self" links.
* @param feed The feed to notify
* @param callback A callback invoked when the notification completes.
* @throws NotificationException Any failure
*/
public void sendUpdateNotificationAsyncronously(final SyndFeed feed, final AsyncNotificationCallback callback) {
Runnable r = new Runnable() {
@Override
public void run() {
try {
sendUpdateNotification(feed);
callback.onSuccess();
} catch (Throwable t) {
callback.onFailure(t);
}
}
};
if (this.executor != null) {
this.executor.execute(r);
} else {
new Thread(r).start();
}
}
/**
* A callback interface for asynchronous notifications.
*/
public static interface AsyncNotificationCallback {
/**
* Called when a notification fails
* @param thrown Whatever was thrown during the failure
*/
public void onFailure(Throwable thrown);
/**
* Invoked with the asyncronous notification completes successfully.
*/
public void onSuccess();
}
}

29
src/main/java/org/rometools/certiorem/pub/package.html Normal file
View file

@ -0,0 +1,29 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>pub</title>
</head>
<body>
This package contains a utility class to send update notifications.
</body>
</html>

40
src/main/java/org/rometools/certiorem/sub/Requester.java Normal file
View file

@ -0,0 +1,40 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.sub;
import org.rometools.certiorem.sub.data.Subscription;
/**
*
* @author robert.cooper
*/
public interface Requester {
public void sendSubscribeRequest(String hubUrl, Subscription subscription, String verifySync, long leaseSeconds,
String secret, String callbackUrl, RequestCallback callback);
public void sendUnsubscribeRequest(String hubUrl, Subscription subscription, String verifySync, String secret,
String callbackUrl, RequestCallback callback);
public static interface RequestCallback {
public void onFailure(Exception e);
public void onSuccess();
}
}

298
src/main/java/org/rometools/certiorem/sub/Subscriptions.java Normal file
View file

@ -0,0 +1,298 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.sub;
import com.sun.syndication.feed.synd.SyndFeed;
import com.sun.syndication.feed.synd.SyndLink;
import com.sun.syndication.io.FeedException;
import com.sun.syndication.io.SyndFeedInput;
import org.rometools.certiorem.HttpStatusCodeException;
import org.rometools.certiorem.sub.Requester.RequestCallback;
import org.rometools.certiorem.sub.data.SubDAO;
import org.rometools.certiorem.sub.data.Subscription;
import org.rometools.fetcher.impl.FeedFetcherCache;
import org.rometools.fetcher.impl.SyndFeedInfo;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.List;
import java.util.UUID;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.rometools.certiorem.sub.data.SubscriptionCallback;
/**
*
* @author robert.cooper
*/
public class Subscriptions {
//TODO unsubscribe.
private FeedFetcherCache cache;
private Requester requester;
private String callbackPrefix;
private SubDAO dao;
public Subscriptions() {
}
public Subscriptions(final FeedFetcherCache cache, final Requester requester, final String callbackPrefix,
final SubDAO dao) {
this.cache = cache;
this.requester = requester;
this.callbackPrefix = callbackPrefix;
this.dao = dao;
}
public void callback(String callbackPath, String feed) {
try {
this.callback(callbackPath, feed.getBytes("UTF-8"));
} catch (UnsupportedEncodingException ex) {
Logger.getLogger(Subscriptions.class.getName())
.log(Level.SEVERE, null, ex);
throw new HttpStatusCodeException(400, "Unable to parse feed.", ex);
}
}
public void callback(String callbackPath, InputStream feed) {
SyndFeedInput input = new SyndFeedInput();
try {
this.callback(callbackPath, input.build(new InputStreamReader(feed)));
} catch (IllegalArgumentException ex) {
Logger.getLogger(Subscriptions.class.getName())
.log(Level.SEVERE, null, ex);
throw new HttpStatusCodeException(500, "Unable to parse feed.", ex);
} catch (FeedException ex) {
Logger.getLogger(Subscriptions.class.getName())
.log(Level.SEVERE, null, ex);
throw new HttpStatusCodeException(400, "Unable to parse feed.", ex);
}
}
public void callback(String callbackPath, byte[] feed) {
this.callback(callbackPath, new ByteArrayInputStream(feed));
}
public void callback(String callbackPath, SyndFeed feed) {
if (!callbackPath.startsWith(callbackPrefix)) {
throw new HttpStatusCodeException(404, "Not a valid callback prefix.", new Exception(callbackPath+" doesnt start with "+callbackPrefix));
}
String id = callbackPath.substring(callbackPrefix.length());
Logger.getLogger(Subscriptions.class.getName()).log(Level.FINE, "Got callback for {0}", id);
Subscription s = dao.findById(id);
if (s == null) {
throw new HttpStatusCodeException(404, "Not a valid callback.", null);
}
this.validateLink(feed, s.getSourceUrl());
SyndFeedInfo info = null;
URL url = null;
try {
url = new URL(s.getSourceUrl());
info = cache.getFeedInfo(url);
} catch (MalformedURLException ex) {
Logger.getLogger(Subscriptions.class.getName())
.log(Level.SEVERE, null, ex);
}
if (info == null) {
info = new SyndFeedInfo();
info.setId(s.getId());
info.setUrl(url);
}
info.setLastModified(System.currentTimeMillis());
info.setSyndFeed(feed);
cache.setFeedInfo(url, info);
s.getCallback().onNotify(s, info);
}
public void unsubscribe(final Subscription subscription, String hubUrl, boolean sync, String secret,
final SubscriptionCallback callback) {
subscription.setUnsubscribed(true);
this.requester.sendUnsubscribeRequest(hubUrl, subscription, (sync ? "sync" : "async"), secret,
this.callbackPrefix + subscription.getId(),
new RequestCallback() {
@Override
public void onSuccess() {
callback.onUnsubscribe(subscription);
}
@Override
public void onFailure(Exception e) {
callback.onFailure(e);
}
});
}
public void subscribe(String hubUrl, String topic, boolean sync, long leaseSeconds, String secret,
final SubscriptionCallback callback) {
Subscription s = new Subscription();
s.setId(UUID.randomUUID().toString());
s.setVerifyToken(UUID.randomUUID().toString());
s.setSourceUrl(topic);
s.setCallback(callback);
if (leaseSeconds > 0) {
s.setExpirationTime(System.currentTimeMillis() + (leaseSeconds * 1000));
}
final Subscription stored = this.dao.addSubscription(s);
this.requester.sendSubscribeRequest(hubUrl, stored, (sync ? "sync" : "async"), leaseSeconds, secret,
this.callbackPrefix + stored.getId(),
new RequestCallback() {
@Override
public void onSuccess() {
callback.onSubscribe(stored);
}
@Override
public void onFailure(Exception e) {
callback.onFailure(e);
}
});
}
public void subscribe(String topic, boolean sync, long leaseSeconds, String secret,
final SubscriptionCallback callback) throws IllegalArgumentException, IOException, FeedException {
SyndFeedInput input = new SyndFeedInput();
SyndFeed feed = input.build(new InputStreamReader(new URL(topic).openStream()));
String hubUrl = this.findHubUrl(feed);
if (hubUrl == null) {
throw new FeedException("No hub link");
}
this.subscribe(hubUrl, topic, sync, leaseSeconds, secret, callback);
}
public String validate(String callbackPath, String topic, String mode, String challenge, String leaseSeconds,
String verifyToken) {
if (!callbackPath.startsWith(callbackPrefix)) {
throw new HttpStatusCodeException(404, "Not a valid callback prefix.", new Exception(callbackPath+" doesnt start with "+callbackPrefix));
}
String id = callbackPath.substring(callbackPrefix.length());
Logger.getLogger(Subscriptions.class.getName()).log(Level.FINE, "Handling validation request for id {0}", id);
Subscription s = dao.findById(id);
if(s == null){
throw new HttpStatusCodeException(404, "Not a valid subscription id", null);
}
if (!s.getVerifyToken()
.equals(verifyToken)) {
throw new HttpStatusCodeException(403, "Verification Token Mismatch.", null);
}
if ("unsubscribe".equals(mode)) {
if (!s.isUnsubscribed()) {
throw new HttpStatusCodeException(400, "Unsubscribe not requested.", null);
}
dao.removeSubscription(s);
} else if ("subscribe".equals(mode)) {
if (s.isValidated()) {
throw new HttpStatusCodeException(400, "Duplicate validation.", null);
}
s.setValidated(true);
dao.updateSubscription(s);
} else {
throw new HttpStatusCodeException(400, "Unsupported mode " + mode, null);
}
Logger.getLogger(Subscriptions.class.getName()).log(Level.FINE, "Validated. Returning {0}", challenge);
return challenge;
}
private String findHubUrl(SyndFeed feed) {
for (SyndLink l : (List<SyndLink>) feed.getLinks()) {
if ("hub".equals(l.getRel())) {
return l.getHref();
}
}
return null;
}
private void validateLink(SyndFeed feed, String source) {
for (SyndLink l : (List<SyndLink>) feed.getLinks()) {
if ("self".equalsIgnoreCase(l.getRel())) {
try {
URI u = new URI(l.getHref());
URI t = new URI(source);
if (!u.equals(t)) {
throw new HttpStatusCodeException(400, "Feed self link does not match the subscribed URI.", null);
}
break;
} catch (URISyntaxException ex) {
Logger.getLogger(Subscriptions.class.getName())
.log(Level.SEVERE, null, ex);
}
}
}
}
/**
* @param cache the cache to set
*/
public void setCache(FeedFetcherCache cache) {
this.cache = cache;
}
/**
* @param requester the requester to set
*/
public void setRequester(Requester requester) {
this.requester = requester;
}
/**
* @param callbackPrefix the callbackPrefix to set
*/
public void setCallbackPrefix(String callbackPrefix) {
this.callbackPrefix = callbackPrefix;
}
/**
* @param dao the dao to set
*/
public void setDao(SubDAO dao) {
this.dao = dao;
}
}

36
src/main/java/org/rometools/certiorem/sub/data/SubDAO.java Normal file
View file

@ -0,0 +1,36 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.sub.data;
/**
*
* @author robert.cooper
*/
public interface SubDAO {
public Subscription findById(String id);
public Subscription addSubscription(Subscription s);
public Subscription updateSubscription(Subscription s);
public void removeSubscription(Subscription s);
}

158
src/main/java/org/rometools/certiorem/sub/data/Subscription.java Normal file
View file

@ -0,0 +1,158 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.sub.data;
import java.io.Serializable;
/**
*
* @author robert.cooper
*/
public class Subscription implements Serializable {
private String id;
private String sourceUrl;
private String verifyToken;
private boolean unsubscribed;
private boolean validated;
private long expirationTime;
private SubscriptionCallback callback;
/**
* Set the value of expirationTime
*
* @param newexpirationTime new value of expirationTime
*/
public void setExpirationTime(long newexpirationTime) {
this.expirationTime = newexpirationTime;
}
/**
* Get the value of expirationTime
*
* @return the value of expirationTime
*/
public long getExpirationTime() {
return this.expirationTime;
}
/**
* Set the value of id
*
* @param newid new value of id
*/
public void setId(String newid) {
this.id = newid;
}
/**
* Get the value of id
*
* @return the value of id
*/
public String getId() {
return this.id;
}
/**
* Set the value of sourceUrl
*
* @param newsourceUrl new value of sourceUrl
*/
public void setSourceUrl(String newsourceUrl) {
this.sourceUrl = newsourceUrl;
}
/**
* Get the value of sourceUrl
*
* @return the value of sourceUrl
*/
public String getSourceUrl() {
return this.sourceUrl;
}
/**
* Set the value of unsubscribed
*
* @param newunsubscribed new value of unsubscribed
*/
public void setUnsubscribed(boolean newunsubscribed) {
this.unsubscribed = newunsubscribed;
}
/**
* Get the value of unsubscribed
*
* @return the value of unsubscribed
*/
public boolean isUnsubscribed() {
return this.unsubscribed;
}
/**
* Set the value of validated
*
* @param newvalidated new value of validated
*/
public void setValidated(boolean newvalidated) {
this.validated = newvalidated;
}
/**
* Get the value of validated
*
* @return the value of validated
*/
public boolean isValidated() {
return this.validated;
}
/**
* Set the value of verifyToken
*
* @param newverifyToken new value of verifyToken
*/
public void setVerifyToken(String newverifyToken) {
this.verifyToken = newverifyToken;
}
/**
* Get the value of verifyToken
*
* @return the value of verifyToken
*/
public String getVerifyToken() {
return this.verifyToken;
}
/**
* @return the callback
*/
public SubscriptionCallback getCallback() {
return callback;
}
/**
* @param callback the callback to set
*/
public void setCallback(SubscriptionCallback callback) {
this.callback = callback;
}
}

23
src/main/java/org/rometools/certiorem/sub/data/SubscriptionCallback.java Normal file
View file

@ -0,0 +1,23 @@
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package org.rometools.certiorem.sub.data;
import org.rometools.fetcher.impl.SyndFeedInfo;
/**
*
* @author najmi
*/
public interface SubscriptionCallback {
void onNotify(Subscription subscribed, SyndFeedInfo feedInfo);
void onFailure(Exception e);
void onSubscribe(Subscription subscribed);
void onUnsubscribe(Subscription subscribed);
}

28
src/main/java/org/rometools/certiorem/sub/data/package.html Normal file
View file

@ -0,0 +1,28 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>data</title>
</head>
<body>
Data classes for the Subscription management.
</body>
</html>

74
src/main/java/org/rometools/certiorem/sub/data/ram/InMemorySubDAO.java Normal file
View file

@ -0,0 +1,74 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package org.rometools.certiorem.sub.data.ram;
import java.util.Date;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.rometools.certiorem.sub.data.SubDAO;
import org.rometools.certiorem.sub.data.Subscription;
/**
*
* @author robert.cooper
*/
public class InMemorySubDAO implements SubDAO {
private ConcurrentHashMap<String, Subscription> subscriptions = new ConcurrentHashMap<String, Subscription>();
@Override
public Subscription findById(String id) {
Subscription s = subscriptions.get(id);
if(s == null){
return null;
}
if(s.getExpirationTime() > 0 && s.getExpirationTime() <= System.currentTimeMillis()){
Logger.getLogger(InMemorySubDAO.class.getName()).log(Level.FINE, "Subscription {0} expired at {1}", new Object[]{s.getSourceUrl(), new Date(s.getExpirationTime())});
subscriptions.remove(id);
return null;
}
return s;
}
@Override
public Subscription addSubscription(Subscription s) {
subscriptions.put(s.getId(), s);
Logger.getLogger(InMemorySubDAO.class.getName()).log(Level.FINE, "Stored subscription {0} {1}", new Object[]{s.getSourceUrl(), s.getId()});
return s;
}
@Override
public Subscription updateSubscription(Subscription s) {
subscriptions.put(s.getId(), s);
return s;
}
@Override
public void removeSubscription(Subscription s) {
subscriptions.remove(s.getId());
}
}

28
src/main/java/org/rometools/certiorem/sub/data/ram/package.html Normal file
View file

@ -0,0 +1,28 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>ram</title>
</head>
<body>
An In-Memory DAO for subscriptions.
</body>
</html>

30
src/main/java/org/rometools/certiorem/sub/package.html Normal file
View file

@ -0,0 +1,30 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>sub</title>
</head>
<body>
This package contains the business class Subscriptions that manages subscriptions and updates a
FeedInfoCache.
</body>
</html>

85
src/main/java/org/rometools/certiorem/sub/request/AbstractRequester.java Normal file
View file

@ -0,0 +1,85 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.sub.request;
import org.rometools.certiorem.sub.Requester;
import org.rometools.certiorem.sub.data.Subscription;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
/**
*
* @author robert.cooper
*/
public abstract class AbstractRequester implements Requester {
protected boolean sendRequest(String hubUrl, String mode, Subscription subscription, String verifySync,
long leaseSeconds, String secret, String callbackUrl, RequestCallback callback)
throws IOException {
StringBuilder sb = new StringBuilder("hub.callback=").append(URLEncoder.encode(callbackUrl, "UTF-8"))
.append("&hub.topic=")
.append(URLEncoder.encode(subscription.getSourceUrl(),
"UTF-8"))
.append("&hub.verify=")
.append(URLEncoder.encode(verifySync, "UTF-8"))
.append("&hub.mode=")
.append(URLEncoder.encode(mode, "UTF-8"));
if (leaseSeconds > 0) {
sb.append("&hub.lease_seconds=")
.append(Long.toString(leaseSeconds));
}
if (secret != null) {
sb.append("&hub.secret=")
.append(URLEncoder.encode(secret, "UTF-8"));
}
if (subscription.getVerifyToken() != null) {
sb.append("&hub.verify_token=")
.append(URLEncoder.encode(subscription.getVerifyToken(), "UTF-8"));
}
URL url = new URL(hubUrl);
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
connection.setDoOutput(true);
// connection.setRequestProperty("Host", url.getHost());
connection.setRequestProperty("User-Agent", "ROME-Certiorem");
connection.connect();
connection.getOutputStream()
.write(sb.toString().getBytes("UTF-8"));
int rc = connection.getResponseCode();
connection.disconnect();
if (rc != 204) {
throw new RuntimeException("Unexpected repsonse code. " + rc);
}
return true;
}
}

74
src/main/java/org/rometools/certiorem/sub/request/AsyncRequester.java Normal file
View file

@ -0,0 +1,74 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.sub.request;
import org.rometools.certiorem.sub.data.Subscription;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* A simple requester implementation that always makes requests as Async.
* @author robert.cooper
*/
public class AsyncRequester extends AbstractRequester {
@Override
public void sendSubscribeRequest(final String hubUrl, final Subscription subscription, final String verifySync,
final long leaseSeconds, final String secret, final String callbackUrl, final RequestCallback callback) {
Logger.getLogger(AsyncRequester.class.getName()).log(Level.FINE, "Sending subscribe request to {0} for {1} to {2}", new Object[]{hubUrl, subscription.getSourceUrl(), callbackUrl});
Runnable r = new Runnable() {
@Override
public void run() {
try {
sendRequest(hubUrl, "subscribe", subscription, verifySync, leaseSeconds, secret, callbackUrl,
callback);
} catch (Exception ex) {
Logger.getLogger(AsyncRequester.class.getName())
.log(Level.SEVERE, null, ex);
callback.onFailure(ex);
}
}
};
new Thread(r).start();
}
@Override
public void sendUnsubscribeRequest(final String hubUrl, final Subscription subscription, final String verifySync,
final String secret,
final String callbackUrl, final RequestCallback callback) {
Logger.getLogger(AsyncRequester.class.getName()).log(Level.FINE, "Sending unsubscribe request to {0} for {1} to {2}", new Object[]{hubUrl, subscription.getSourceUrl(), callbackUrl});
Runnable r = new Runnable() {
@Override
public void run() {
try {
sendRequest(hubUrl, "unsubscribe", subscription, verifySync, -1, secret, callbackUrl,
callback);
} catch (IOException ex) {
Logger.getLogger(AsyncRequester.class.getName())
.log(Level.SEVERE, null, ex);
callback.onFailure(ex);
}
}
};
new Thread(r).start();
}
}

68
src/main/java/org/rometools/certiorem/sub/request/SyncRequester.java Normal file
View file

@ -0,0 +1,68 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package org.rometools.certiorem.sub.request;
import org.rometools.certiorem.sub.data.Subscription;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* A simple requester implementation that always makes requests as Async.
* @author Farrukh Najmi
*/
public class SyncRequester extends AbstractRequester {
@Override
public void sendSubscribeRequest(final String hubUrl, final Subscription subscription, final String verifySync,
final long leaseSeconds, final String secret, final String callbackUrl, final RequestCallback callback) {
Logger.getLogger(SyncRequester.class.getName()).log(Level.INFO, "Sending subscribe request to {0} for {1} to {2}", new Object[]{hubUrl, subscription.getSourceUrl(), callbackUrl});
try {
sendRequest(hubUrl, "subscribe", subscription, verifySync, leaseSeconds, secret, callbackUrl,
callback);
callback.onSuccess();
} catch (Exception ex) {
Logger.getLogger(SyncRequester.class.getName())
.log(Level.SEVERE, null, ex);
callback.onFailure(ex);
}
}
@Override
public void sendUnsubscribeRequest(final String hubUrl, final Subscription subscription, final String verifySync,
final String secret,
final String callbackUrl, final RequestCallback callback) {
Logger.getLogger(SyncRequester.class.getName()).log(Level.INFO, "Sending unsubscribe request to {0} for {1} to {2}", new Object[]{hubUrl, subscription.getSourceUrl(), callbackUrl});
try {
sendRequest(hubUrl, "unsubscribe", subscription, verifySync, -1, secret, callbackUrl,
callback);
callback.onSuccess();
} catch (IOException ex) {
Logger.getLogger(SyncRequester.class.getName())
.log(Level.SEVERE, null, ex);
callback.onFailure(ex);
}
}
}

28
src/main/java/org/rometools/certiorem/sub/request/package.html Normal file
View file

@ -0,0 +1,28 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>request</title>
</head>
<body>
Standard requester implementations.
</body>
</html>

86
src/main/java/org/rometools/certiorem/web/AbstractHubServlet.java Normal file
View file

@ -0,0 +1,86 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.web;
import org.rometools.certiorem.HttpStatusCodeException;
import org.rometools.certiorem.hub.Hub;
import java.io.IOException;
import java.util.Arrays;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
*
* @author robert.cooper
*/
public abstract class AbstractHubServlet extends HttpServlet {
public static final String HUBMODE = "hub.mode";
private final Hub hub;
protected AbstractHubServlet(final Hub hub) {
super();
this.hub = hub;
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
try {
if ("publish".equals(req.getParameter(HUBMODE))) {
hub.sendNotification(req.getServerName(), req.getParameter("hub.url"));
} else {
String callback = req.getParameter("hub.callback");
String topic = req.getParameter("hub.topic");
String[] verifies = req.getParameterValues("hub.verify");
String leaseString = req.getParameter("hub.lease_seconds");
String secret = req.getParameter("hub.secret");
String verifyToken = req.getParameter("hub.verify_token");
String verifyMode = Arrays.asList(verifies)
.contains("async") ? "async" : "sync";
Boolean result = null;
if ("subscribe".equals(req.getParameter(HUBMODE))) {
long leaseSeconds = (leaseString != null) ? Long.parseLong(leaseString) : (-1);
result = hub.subscribe(callback, topic, verifyMode, leaseSeconds, secret, verifyToken);
} else if ("unsubscribe".equals(req.getParameter(HUBMODE))) {
result = hub.unsubscribe(callback, topic, verifyMode, secret, verifyToken);
}
if ((result != null) && !result) {
throw new HttpStatusCodeException(500, "Operation failed.", null);
}
}
} catch (HttpStatusCodeException sc) {
resp.setStatus(sc.getStatus());
resp.getWriter()
.println(sc.getMessage());
return;
}
resp.setStatus(204);
}
}

79
src/main/java/org/rometools/certiorem/web/AbstractSubServlet.java Normal file
View file

@ -0,0 +1,79 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.web;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpUtils;
import org.rometools.certiorem.HttpStatusCodeException;
import org.rometools.certiorem.sub.Subscriptions;
/**
*
* @author robert.cooper
*/
public class AbstractSubServlet extends HttpServlet {
private final Subscriptions subscriptions;
protected AbstractSubServlet(final Subscriptions subscriptions){
super();
this.subscriptions = subscriptions;
}
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
String mode = req.getParameter("hub.mode");
String topic = req.getParameter("hub.topic");
String challenge = req.getParameter("hub.challenge");
String leaseString = req.getParameter("hub.lease_seconds");
String verifyToken = req.getParameter("hub.verify_token");
try{
String result = subscriptions.validate(HttpUtils.getRequestURL(req).toString(), topic, mode, challenge, leaseString, verifyToken);
resp.setStatus(200);
resp.getWriter().print(result);
return;
} catch(HttpStatusCodeException e){
e.printStackTrace();
resp.setStatus(e.getStatus());
resp.getWriter().print(e.getMessage());
}
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
try{
this.subscriptions.callback(HttpUtils.getRequestURL(req).toString(), req.getInputStream());
return;
} catch(HttpStatusCodeException e){
e.printStackTrace();
resp.setStatus(e.getStatus());
resp.getWriter().println(e.getMessage());
}
}
}

31
src/main/java/org/rometools/certiorem/web/package.html Normal file
View file

@ -0,0 +1,31 @@
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>web</title>
</head>
<body>
Contains base servlet implementations for doing hub and sub services.
<p>
Extends these as needed in your web application.
</p>
</body>
</html>

30
src/main/resources/META-INF/persistence.xml Normal file
View file

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (C) The ROME Team 2011
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<persistence version="1.0" xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">
<persistence-unit name="certiorem" transaction-type="RESOURCE_LOCAL">
<jta-data-source>jdbc/certiorem-datasource</jta-data-source>
<properties>
<property name="eclipselink.ddl-generation" value="create-tables" />
</properties>
</persistence-unit>
</persistence>

47
src/site/apt/Certiorem.apt Normal file
View file

@ -0,0 +1,47 @@
-----
certiorem
-----
kebernet
-----
2011-03-19 10:30:35.292
-----
Certiorem
Certiorem is an implementation of the {{{http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub\-core\-0.3.html}PubSubHubub }}protocol for ROME.
It is dependent on ROME and ROME\-Fetcher for the base implementations, and will provide standard plugins for Propono to allow for publish eventing, where applicable.
*Primary Components
*Hub Implementation and Scaffolding (Done)
The first part of Certiorem is a basic set of scaffolding classes that can be used to create a PSH notification hub. Initially, this will include a non\-guaranteed delivery hub, with standard implementations suitable for deployment on most JavaEE application servers or Google App Engine. It is intended that there should be at least one simple, drop in WAR file, utilizing JavaEE classes that can work in a default configuration for various standard web containers. Subsequently,  each of the classes in the PSH implementation up through the primary Controller class use constructor\-time composition/configuration so that the user/developer can easily construct a custom configuration of the Hub.
**Client Implementation Integrated with ROME\-Fetcher (Done)
For web\-based applications that use ROME\-Fetcher, an extended push\-notified store wrapper that will update based on callbacks from a Hub of change notifications. This will include a highly configurable callback servlet to write into the Fetcher cache as changes are made. Additionally, the system should support (semi\-)real time notifications of changes in the form of a listener that exectutes in a TBD thread state relative to the callback servlet. This should be packaged as a simple JAR with no more deps than fetcher that defines the callback servlet, and automagically does subscribes where link\=rel appropriate.
**Notification Implementation for Propono based and JAX\-RS based Servers (In Progress)
This should be a simple API call to notify a Hub of changes to topics. Again, this should provide real\-time notifications either synchronously or asynchronously. Importantly for Asynchronous notifications, they should block subsequent change notifications pending a notification to the Hub.
References: 
{{{https://github.com/nlothian/RTUpdates/blob/master/src/com/nicklothian/pubsubhub/PubSubHubSubscriptionServlet.java}https://github.com/nlothian/RTUpdates/blob/master/src/com/nicklothian/pubsubhub/PubSubHubSubscriptionServlet.java}}
{{{http://grack.com/blog/2009/09/09/parsing\-the\-pubsubhubbub\-notifications/}http://grack.com/blog/2009/09/09/parsing\-the\-pubsubhubbub\-notifications/}}
Notes on the Code
It is still mostly a rough sketch, but the big outlines are there:
There are three main packages: pub, sub and hub.
The pub package is basically just a single utility class for pushing notifications to a hub.
The hub package contains the Hub class. This is a general business controller that is intended to allow you to build a servlet around it with a very, very thin veneer, but you could also use it to drive an XMPP or JMS version too. It is basically built by composition of a number of classes, for which there are some default implementations: A Verifier, which makes the callback to verify new subscriptions, the HubDAO which stores the current subscriptions and subscriber statistics, and a Notifier which actually sends notifications to the subscribers. There are a couple of implementations of each of these (though the JPA HubDAO is still in process). Mostly the implementations for the Verifier and Notifier support threadpooling or no\-threads (for App Engine use).
I have just started sketching out the sub package, but it basically has a "Subscriptions" class that will take in notifications (using the same "thin veneer" pattern that the Hub class uses). It is also constructed with some impls: A SubscriptionDAO that stores you current subscription information, a FeedFetcherCache that holds the received data, and a Requester that makes the subscription requests to hubs.
I am hoping to have a basic end to end example working sometime in the next week or so, but if anyone wants to look over what is there, feel free.

124
src/site/apt/CertioremTutorial.apt Normal file
View file

@ -0,0 +1,124 @@
-----
Certiorem Tutorial
-----
kebernet
-----
2011-12-06 19:23:15.220
-----
Certiorem Tutorial
Certiorem is a PubSubHubub (PSH) implementation for ROME. It isn't an application, but an API for building each of the three components (Publisher, Subscriber and Hub) into your web apps.
You can see an {{{https://github.com/rometools/rome-incubator/tree/master/pubsubhubub/webapp}example webapp here}}.
Creating a Hub
Hubs take notifications, or "Pings" that tell it the content of a feed has been updated, fetch the feed, then notify each of the subscribers of the change. As you will begin to see, Certiorem is very much about "Composition" of classes. The Hub class is a prime example of this.
Looking at the example webapp we see:
+------+
@Provides
@Singleton
public Hub buildHub() {
FeedFetcher fetcher = new HttpURLFeedFetcher(new DeltaFeedInfoCache());
    Hub hub = new Hub(new InMemoryHubDAO(), new UnthreadedVerifier(), new UnthreadedNotifier(), fetcher);
    return hub;
}
+------+
First we construct an instance of FeedFetcher, from the Fetcher subproject. This will be used to fetch feeds from remote hosts. There are a number of implementations for FeedFetcher and FeedInfoCache in the Fetcher project. Please look there for info on what is what.
Next we need a HubDAO implementation. This is a DAO for managing Subscriber and SubscriptionSummary classes. Here we are using an in\-memory DAO, which like the HashMapFeedInfoCache will evaporate if we restart our web application. A JPA implementation for persistence is also available, but incomplete at time of writing.
Next we need two implementations of network client interfaces: a Verifier, and a Notifier. The Verifier calls back to the Subscribers and verifies their subscribe/unsubscribe operations. A Notifier is used to send updates to to the clients. There are two basic implementations of these provided: A ThreadPool\* and Unthreaded\* version of each. The thread pool version uses a ThreadPoolExecutor to run queues of outbound calls. The Unthreaded version of each, makes the network calls in\-line with the request to the hub. These are suitable for environments like Google App Engine where spawning threads from servlets is absolutely verboten.
There are other constructors that contain lists of restrictions for what the hub will support: acceptable topic feeds, ports, protocols, etc.
The hub here is just a business logic class. In order to have a functioning hub, we need a servlet exposing the Hub. In the "web" package, there is an abstract servlet you can use to do just this. In the Guice wired example, we simply create a servlet with an injected Hub implementation.
+------+
@Singleton
public class HubServlet extends AbstractHubServlet {
@Inject
public HubServlet(final Hub hub){
super(hub);
}
}
//... in the ServerModule...
serve("/hub*").with(HubServlet.class);
+------+
We can now include a \<link rel\="hub"\> value in our feeds and publish notifications of changes. 
Publishing Ping Notifications
This is perhaps the easiest thing to do. The Publisher class will take various combinations of URLs and SyndFeeds and send the appropriate notification. If your SyndFeed contains a \<link rel\='sel' /\> and \<link rel\='hub' /\> you can just pass the SyndFeed object. Otherwise, you can use the URL strings where appropriate.
The example couldn't be simpler:
+------+
Publisher pub = new Publisher();
try {
pub.sendUpdateNotification("http://localhost/webapp/hub", "http://localhost/webapp/research-atom.xml");
} catch (NotificationException ex) {
Logger.getLogger(NotifyTest.class.getName()).log(Level.SEVERE, null, ex);
throw new ServletException(ex);
}
+------+
Once this notification is sent, the hub will make a request to the feed and notify the clients of new entries.
Subscribing to Feeds
To set up a feed subscriber, you need to go through a process very much like setting up a Hub. First, create the Subscriptions class by composition:
+------+
@Provides
@Singleton
public Subscriptions buildSubs(){
    Subscriptions subs = new Subscriptions(new HashMapFeedInfoCache(), new AsyncRequester(),
            "http://localhost/webapp/subscriptions/", new InMemorySubDAO());
    return subs;
}
+------+
First we need a FeedInfoCache implementation. This will be updated as notifications come in, so in your web app, you want to make sure this is shared with the FeedFetcher implementation you are using to read feeds. Next you need a Requester, this is a network class that makes subscription requests to remote hubs. Next, a URL prefix for where the callbacks will live. This really means the URL to the SubServlet that is resolvable externally. Finally, a DAO for storing and retrieving Subscription objects.
As in the Hub, we need a wrapper servlet to call into the Subscriptions class
+------+
@Singleton
public class SubServlet extends AbstractSubServlet {
@Inject
public SubServlet(final Subscriptions subscriptions){
super(subscriptions);
}
}
// In the ServerModule...
serve("/subscriptions/*").with(SubServlet.class)
+------+
Now if we want to subscribe to a feed, we get a reference to the Subscriptions object, and pass in either the SyndFeed (with appropriate rel\="hub" and rel\="self" links) or simply a couple of URLs:
+------+
 subs.subscribe("http://localhost/webapp/hub", "http://localhost/webapp/research-atom.xml", true, -1, null, new SubscriptionCallback(){
public void onFailure(Exception e) {
e.printStackTrace();
}
public void onSubscribe(Subscription subscribed) {
System.out.println("Subscribed "+subscribed.getId() +" "+subscribed.getSourceUrl());
}
});
+------+
Here we pass in the URL of the Hub, the URL of the feed, a boolean indicating we want to make the subscription request synchronously, the lease seconds we want to keep the subscription for, a null cryptographic secret, and a Callback invoked when the subscribe request completes.

15
src/site/apt/index.apt Normal file
View file

@ -0,0 +1,15 @@
-----
Home
-----
kebernet
-----
2011-02-28 21:38:15.537
-----
ROME Incubator
This is the home of the Incubator space.
To help you on your way, we've inserted some of our favourite macros on this home page. As you start creating pages, blogging and commenting you'll see the macros below fill up with all the activity in your space.
{{{./Certiorem.html}certiorem (incubator)}} The Certiorem project – A PubSubHubub implementation for ROME

0
src/site/resources/.nojekyll Normal file
View file

8
src/site/resources/css/site.css Normal file
View file

@ -0,0 +1,8 @@
h1 {
padding: 4px 4px 4px 6px;
border: 1px solid #999;
color: #900;
background-color: #ddd;
font-weight:900;
font-size: x-large;
}

BIN
src/site/resources/images/romelogo.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 11 KiB

33
src/site/site.xml Normal file
View file

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/DECORATION/1.3.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd"
name="ROME Incubator">
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>1.3.0</version>
</skin>
<bannerLeft>
<name>ROME</name>
<src>images/romelogo.png</src>
<href>http://github.com/rometools/</href>
</bannerLeft>
<publishDate position="right" />
<version position="right" />
<body>
<menu name="ROME Incubator">
<item name="Overview" href="index.html" />
<item name="Certiorem" href="Certiorem.html">
<item name="Tutorial" href="CertioremTutorial.html" />
</item>
</menu>
<menu ref="reports" />
</body>
</project>

50
src/test/java/org/rometools/certiorem/hub/AlwaysVerifier.java Normal file
View file

@ -0,0 +1,50 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub;
import org.rometools.certiorem.hub.data.Subscriber;
/**
*
* @author robert.cooper
*/
public class AlwaysVerifier implements Verifier {
@Override
public void verifySubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback) {
callback.onVerify(true);
}
@Override
public boolean verifySubcribeSyncronously(Subscriber subscriber) {
return true;
}
@Override
public void verifyUnsubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback) {
callback.onVerify(true);
}
@Override
public boolean verifyUnsubcribeSyncronously(Subscriber subscriber) {
return true;
}
}

124
src/test/java/org/rometools/certiorem/hub/ControllerTest.java Normal file
View file

@ -0,0 +1,124 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub;
import java.util.logging.Logger;
import org.rometools.certiorem.HttpStatusCodeException;
import org.rometools.fetcher.FeedFetcher;
import org.rometools.fetcher.impl.HashMapFeedInfoCache;
import org.rometools.fetcher.impl.HttpURLFeedFetcher;
import org.junit.After;
import org.junit.AfterClass;
import static org.junit.Assert.*;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.rometools.certiorem.hub.data.HubDAO;
import org.rometools.certiorem.hub.data.ram.InMemoryHubDAO;
/**
*
* @author robert.cooper
*/
public class ControllerTest {
public ControllerTest() {
}
@BeforeClass
public static void setUpClass() throws Exception {
}
@AfterClass
public static void tearDownClass() throws Exception {
}
@Before
public void setUp() {
}
@After
public void tearDown() {
}
/**
* Test of subscribe method, of class Hub.
*/
@Test
public void testSubscribe() {
Logger.getLogger(ControllerTest.class.getName()).info("subscribe");
String callback = "http://localhost/doNothing";
String topic = "http://feeds.feedburner.com/screaming-penguin";
long lease_seconds = -1;
String secret = null;
String verify_token = "MyVoiceIsMyPassport";
HubDAO dao = new InMemoryHubDAO();
Notifier notifier = null;
FeedFetcher fetcher = new HttpURLFeedFetcher(HashMapFeedInfoCache.getInstance());
Hub instance = new Hub(dao, new AlwaysVerifier(), notifier, fetcher);
Boolean result = instance.subscribe(callback, topic, "sync", lease_seconds, secret, verify_token);
assertEquals(true, result);
instance = new Hub(dao, new NeverVerifier(), notifier, fetcher);
result = instance.subscribe(callback, topic, "sync", lease_seconds, secret, verify_token);
assertEquals(false, result);
result = instance.subscribe(callback, topic, "async", lease_seconds, secret, verify_token);
assertEquals(null, result);
// Test internal assertions
try {
instance.subscribe(null, topic, "async", lease_seconds, secret, verify_token);
fail();
} catch (HttpStatusCodeException e) {
assertEquals(400, e.getStatus());
Logger.getLogger(ControllerTest.class.getName()).info(e.getMessage());
}
try {
instance.subscribe(callback, null, "async", lease_seconds, secret, verify_token);
fail();
} catch (HttpStatusCodeException e) {
assertEquals(400, e.getStatus());
Logger.getLogger(ControllerTest.class.getName()).info(e.getMessage());
}
try {
instance.subscribe(callback, topic, "foo", lease_seconds, secret, verify_token);
fail();
} catch (HttpStatusCodeException e) {
assertEquals(400, e.getStatus());
Logger.getLogger(ControllerTest.class.getName()).info(e.getMessage());
}
// test general exception
instance = new Hub(dao, new ExceptionVerifier(), notifier, fetcher);
try {
result = instance.subscribe(callback, topic, "sync", lease_seconds, secret, verify_token);
fail();
} catch (HttpStatusCodeException e) {
assertEquals(500, e.getStatus());
}
}
}

77
src/test/java/org/rometools/certiorem/hub/DeltaSyndFeedInfoTest.java Normal file
View file

@ -0,0 +1,77 @@
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package org.rometools.certiorem.hub;
import java.io.IOException;
import com.sun.syndication.feed.synd.SyndEntry;
import java.util.List;
import junit.framework.Assert;
import org.rometools.fetcher.impl.HashMapFeedInfoCache;
import org.rometools.fetcher.impl.HttpURLFeedFetcher;
import java.net.URL;
import com.sun.syndication.feed.synd.SyndFeed;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
/**
*
* @author najmi
*/
public class DeltaSyndFeedInfoTest {
DeltaFeedInfoCache feedInfoCache;
HttpURLFeedFetcher feedFetcher;
SyndFeed feed;
public DeltaSyndFeedInfoTest() {
}
@BeforeClass
public static void setUpClass() throws Exception {
}
@AfterClass
public static void tearDownClass() throws Exception {
}
@Before
public void setUp() {
feedInfoCache = new DeltaFeedInfoCache(new HashMapFeedInfoCache());
feedFetcher = new HttpURLFeedFetcher(feedInfoCache);
}
@After
public void tearDown() {
}
/**
* Test of getSyndFeed method, of class DeltaSyndFeedInfo.
*/
@Test
public void testGetSyndFeed() throws Exception {
System.out.println("getSyndFeed");
feed = feedFetcher.retrieveFeed(getFeedUrl());
List<SyndEntry> entries = feed.getEntries();
Assert.assertTrue(!entries.isEmpty());
//Fetch again and this time the entries should be empty as none have changed.
feed = feedFetcher.retrieveFeed(getFeedUrl());
entries = feed.getEntries();
Assert.assertTrue(entries.isEmpty());
}
private URL getFeedUrl() throws IOException {
URL feedUrl = new URL("http://news.google.com/news?pz=1&cf=all&ned=us&hl=en&output=rss");
// URL feedUrl = new URL("http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml");
return feedUrl;
}
}

50
src/test/java/org/rometools/certiorem/hub/ExceptionVerifier.java Normal file
View file

@ -0,0 +1,50 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub;
import org.rometools.certiorem.hub.data.Subscriber;
/**
*
* @author robert.cooper
*/
public class ExceptionVerifier implements Verifier{
@Override
public void verifySubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback) {
throw new UnsupportedOperationException("Not supported yet.");
}
@Override
public boolean verifySubcribeSyncronously(Subscriber subscriber) {
throw new UnsupportedOperationException("Not supported yet.");
}
@Override
public void verifyUnsubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback) {
throw new UnsupportedOperationException("Not supported yet.");
}
@Override
public boolean verifyUnsubcribeSyncronously(Subscriber subscriber) {
throw new UnsupportedOperationException("Not supported yet.");
}
}

50
src/test/java/org/rometools/certiorem/hub/NeverVerifier.java Normal file
View file

@ -0,0 +1,50 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub;
import org.rometools.certiorem.hub.data.Subscriber;
/**
*
* @author robert.cooper
*/
public class NeverVerifier implements Verifier{
@Override
public void verifySubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback) {
callback.onVerify(false);
}
@Override
public boolean verifySubcribeSyncronously(Subscriber subscriber) {
return false;
}
@Override
public void verifyUnsubscribeAsyncronously(Subscriber subscriber, VerificationCallback callback) {
callback.onVerify(false);
}
@Override
public boolean verifyUnsubcribeSyncronously(Subscriber subscriber) {
return false;
}
}

89
src/test/java/org/rometools/certiorem/hub/data/AbstractDAOTest.java Normal file
View file

@ -0,0 +1,89 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.data;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.junit.Test;
/**
*
* @author robert.cooper
*/
public abstract class AbstractDAOTest {
protected abstract HubDAO get();
@Test
public void testSubscribe() {
HubDAO instance = get();
Logger.getLogger(AbstractDAOTest.class.getName()).log(Level.INFO, "{0} testSubscribe", instance.getClass().getName());
Subscriber subscriber = new Subscriber();
subscriber.setCallback("http://localhost:9797/noop");
subscriber.setTopic("http://feeds.feedburner.com/screaming-penguin");
subscriber.setLeaseSeconds(-1);
subscriber.setVerify("VerifyMe");
Subscriber result = instance.addSubscriber(subscriber);
assert result.equals(subscriber) : "Subscriber not equal.";
List<Subscriber> subscribers = (List<Subscriber>) instance.subscribersForTopic(subscriber.getTopic());
assert subscribers.contains(result) : "Subscriber not in result.";
}
@Test
public void testLeaseExpire() throws InterruptedException {
HubDAO instance = get();
Logger.getLogger(AbstractDAOTest.class.getName()).log(Level.INFO, "{0} testLeaseExpire", instance.getClass().getName());
Subscriber subscriber = new Subscriber();
subscriber.setCallback("http://localhost:9797/noop");
subscriber.setTopic("http://feeds.feedburner.com/screaming-penguin");
subscriber.setLeaseSeconds(1);
subscriber.setVerify("VerifyMe");
Subscriber result = instance.addSubscriber(subscriber);
assert subscriber.equals(result) : "Subscriber not equal.";
//quick test for store.
List<Subscriber> subscribers = (List<Subscriber>) instance.subscribersForTopic(subscriber.getTopic());
assert subscribers.contains(result) : "Subscriber not in result.";
//sleep past expiration
Thread.sleep(1100);
subscribers = (List<Subscriber>) instance.subscribersForTopic(subscriber.getTopic());
assert !subscribers.contains(result) : "Subscriber should have expired";
}
@Test
public void testUnsubscribe() throws InterruptedException {
HubDAO instance = get();
Logger.getLogger(AbstractDAOTest.class.getName()).log(Level.INFO, "{0} testUnsubscribe", instance.getClass().getName());
Subscriber subscriber = new Subscriber();
subscriber.setCallback("http://localhost:9797/noop");
subscriber.setTopic("http://feeds.feedburner.com/screaming-penguin");
subscriber.setLeaseSeconds(1);
subscriber.setVerify("VerifyMe");
Subscriber result = instance.addSubscriber(subscriber);
// TODO
}
}

44
src/test/java/org/rometools/certiorem/hub/data/ram/InMemoryDAOTest.java Normal file
View file

@ -0,0 +1,44 @@
/**
*
* Copyright (C) The ROME Team 2011
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rometools.certiorem.hub.data.ram;
import org.rometools.certiorem.hub.data.AbstractDAOTest;
import org.rometools.certiorem.hub.data.HubDAO;
/**
*
* @author robert.cooper
*/
public class InMemoryDAOTest extends AbstractDAOTest{
private InMemoryHubDAO dao = new InMemoryHubDAO();
public InMemoryDAOTest() {
}
@Override
protected HubDAO get() {
return dao;
}
}