first draft for news providers, news service and new items API in a separate bundle project

2026-09-20 12:45:35 +00:00 · 2015-06-10 17:13:43 +02:00
parent a1c23ce4de
commit 87a56ea669
18 changed files with 363 additions and 0 deletions
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
+	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>
@@ -0,0 +1 @@
+bin/
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>com.sap.sailing.news</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.pde.ManifestBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.pde.SchemaBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.pde.PluginNature</nature>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+</projectDescription>
@@ -0,0 +1,7 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
+org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.source=1.8
@@ -0,0 +1,3 @@
+eclipse.preferences.version=1
+pluginProject.extensions=false
+resolve.requirebundle=false
@@ -0,0 +1,19 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: Shared sailing news APIs
+Bundle-SymbolicName: com.sap.sailing.news
+Bundle-Version: 1.0.0.qualifier
+Bundle-Activator: com.sap.sailing.news.Activator
+Bundle-Vendor: SAP
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
+Bundle-ActivationPolicy: lazy
+Export-Package: com.sap.sailing.news,
+ com.sap.sailing.news.impl
+Import-Package: com.sap.sailing.domain.base.impl,
+ com.sap.sailing.domain.common,
+ com.sap.sailing.domain.common.impl,
+ com.sap.sailing.domain.persistence,
+ com.sap.sailing.server,
+ org.osgi.framework;version="1.5.0",
+ org.osgi.util.tracker;version="1.5.1"
+Require-Bundle: com.sap.sse.common
@@ -0,0 +1,4 @@
+source.. = src/
+output.. = bin/
+bin.includes = META-INF/,\
+               .
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <artifactId>root</artifactId>
+    <groupId>com.sap.sailing</groupId>
+    <version>1.0.0-SNAPSHOT</version>
+  </parent>
+  <artifactId>com.sap.sailing.news</artifactId>
+  <packaging>eclipse-plugin</packaging>
+</project>
@@ -0,0 +1,24 @@
+package com.sap.sailing.news;
+
+import java.util.logging.Logger;
+
+import org.osgi.framework.BundleActivator;
+import org.osgi.framework.BundleContext;
+
+import com.sap.sailing.news.impl.NewsProviderRegistryImpl;
+import com.sap.sailing.news.impl.NewsServiceImpl;
+
+public class Activator implements BundleActivator {
+    private static final Logger logger = Logger.getLogger(Activator.class.getName());
+
+    public void start(BundleContext context) throws Exception {
+        NewsProviderRegistry providerRegistry = new NewsProviderRegistryImpl(); 
+        NewsService newsService = new NewsServiceImpl(providerRegistry);
+        context.registerService(NewsService.class, newsService, null);
+        context.registerService(NewsProviderRegistry.class, providerRegistry, null);
+        logger.info("News Service registered.");
+    }
+
+    public void stop(BundleContext bundleContext) throws Exception {
+    }
+}
@@ -0,0 +1,21 @@
+package com.sap.sailing.news;
+
+import java.util.LinkedList;
+
+public class LimitedQueue<E> extends LinkedList<E> {
+    private static final long serialVersionUID = 9026209104040359183L;
+    private int limit;
+
+    public LimitedQueue(int limit) {
+        this.limit = limit;
+    }
+
+    @Override
+    public boolean add(E o) {
+        boolean added = super.add(o);
+        while (added && size() > limit) {
+           super.remove();
+        }
+        return added;
+    }
+}
@@ -0,0 +1,24 @@
+package com.sap.sailing.news;
+
+import java.net.URL;
+import java.util.Date;
+import java.util.UUID;
+
+/**
+ * An interface for a generic news item
+ * @author Frank
+ *
+ */
+public interface NewsItem {
+    UUID getId();
+    
+    String getCategory();
+
+    String getTitle();
+    
+    String getMessage();
+    
+    URL getRelatedItemLink();
+    
+    Date getCreatedAtDate();
+}
@@ -0,0 +1,14 @@
+package com.sap.sailing.news;
+
+import java.util.Date;
+import java.util.Iterator;
+
+public interface NewsProvider {
+    Iterator<NewsItem> getNews();
+    
+    Iterator<NewsItem> getNews(Date startingFrom);
+
+    boolean hasNews(Date startingFrom);
+
+    boolean hasNews();
+}
@@ -0,0 +1,10 @@
+package com.sap.sailing.news;
+
+public interface NewsProviderRegistry {
+    boolean registerNewsProvider(NewsProvider provider);
+
+    boolean deregisterNewsProvider(NewsProvider provider);
+    
+    Iterable<NewsProvider> getNewsProvider();
+}
+ 
@@ -0,0 +1,13 @@
+package com.sap.sailing.news;
+
+import java.util.Date;
+
+public interface NewsService {
+    Iterable<NewsItem> getAllNews();
+
+    Iterable<NewsItem> getNews(Date startingFrom);
+
+    Iterable<NewsItem> getNewsByCategory(String category);
+
+    Iterable<NewsItem> getNewsByCategory(Date startingFrom, String category);
+}
@@ -0,0 +1,58 @@
+package com.sap.sailing.news.impl;
+
+import java.net.URL;
+import java.util.Date;
+import java.util.UUID;
+
+import com.sap.sailing.news.NewsItem;
+
+public class AbstractNewsItem implements NewsItem {
+    private final UUID id;
+    
+    private String category;
+
+    private String title;
+    
+    private String message;
+    
+    private URL relatedItemLink;
+    
+    private Date createdAtDate;
+
+    public AbstractNewsItem(String title, String message, Date createdAtDate,  String category) {
+        this(title, message, createdAtDate, category, null);
+    }
+
+    public AbstractNewsItem(String title, String message, Date createdAtDate, String category, URL relatedItemLink) {
+        this.title = title;
+        this.message = message;
+        this.category = category;
+        this.createdAtDate = createdAtDate;
+        this.relatedItemLink = relatedItemLink;
+        this.id = UUID.randomUUID();
+    }
+
+    public String getCategory() {
+        return category;
+    }
+
+    public String getTitle() {
+        return title;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public URL getRelatedItemLink() {
+        return relatedItemLink;
+    }
+
+    public Date getCreatedAtDate() {
+        return createdAtDate;
+    }
+
+    public UUID getId() {
+        return id;
+    }
+}
@@ -0,0 +1,31 @@
+package com.sap.sailing.news.impl;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import com.sap.sailing.news.NewsProvider;
+import com.sap.sailing.news.NewsProviderRegistry;
+
+public class NewsProviderRegistryImpl implements NewsProviderRegistry {
+    private Set<NewsProvider> newsProvider; 
+    
+    public NewsProviderRegistryImpl() {
+        newsProvider = new HashSet<NewsProvider>();
+    }
+    
+    @Override
+    public boolean registerNewsProvider(NewsProvider provider) {
+        return newsProvider.add(provider);
+    }
+
+    @Override
+    public boolean deregisterNewsProvider(NewsProvider provider) {
+        return newsProvider.remove(provider);
+    }
+
+    @Override
+    public Iterable<NewsProvider> getNewsProvider() {
+        return newsProvider;
+    }
+
+}
@@ -0,0 +1,49 @@
+package com.sap.sailing.news.impl;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.Iterator;
+import java.util.List;
+
+import com.sap.sailing.news.NewsItem;
+import com.sap.sailing.news.NewsProvider;
+import com.sap.sailing.news.NewsProviderRegistry;
+import com.sap.sailing.news.NewsService;
+import com.sap.sse.common.Util;
+
+public class NewsServiceImpl implements NewsService {
+    private final NewsProviderRegistry providerRegistry;
+    
+    public NewsServiceImpl(NewsProviderRegistry providerRegistry) {
+        this.providerRegistry = providerRegistry;
+    }
+
+    @Override
+    public Iterable<NewsItem> getAllNews() {
+        List<NewsItem> result = new ArrayList<>();
+        for(NewsProvider provider: providerRegistry.getNewsProvider()) {
+            Iterator<NewsItem> news = provider.getNews();
+        }
+        return result;
+    }
+
+    @Override
+    public Iterable<NewsItem> getNews(Date startingFrom) {
+        List<NewsItem> result = new ArrayList<>();
+        for(NewsProvider provider: providerRegistry.getNewsProvider()) {
+            Iterator<NewsItem> news = provider.getNews(startingFrom);
+        }
+        return result;
+    }
+
+    @Override
+    public Iterable<NewsItem> getNewsByCategory(String category) {
+        return getAllNews();
+    }
+
+    @Override
+    public Iterable<NewsItem> getNewsByCategory(Date startingFrom, String category) {
+        return getNews(startingFrom);
+    }
+
+}
@@ -0,0 +1,38 @@
+package com.sap.sailing.news.impl;
+
+import java.util.Date;
+import java.util.Iterator;
+import java.util.LinkedList;
+
+import com.sap.sailing.news.LimitedQueue;
+import com.sap.sailing.news.NewsItem;
+import com.sap.sailing.news.NewsProvider;
+
+public class SimpleDemoNewsProvider implements NewsProvider {
+    private final LinkedList<NewsItem> newsQueue;
+
+    public SimpleDemoNewsProvider() {
+        newsQueue = new LimitedQueue<NewsItem>(10);
+    }
+    
+    @Override
+    public Iterator<NewsItem> getNews() {
+        return newsQueue.iterator();
+    }
+
+    @Override
+    public Iterator<NewsItem> getNews(Date startingFrom) {
+        return newsQueue.iterator();
+    }
+
+    @Override
+    public boolean hasNews(Date startingFrom) {
+        return newsQueue.size() > 0;
+    }
+
+    @Override
+    public boolean hasNews() {
+        return newsQueue.size() > 0;
+    }
+
+}