begin modularization of data import/export API

Author: jricher

openid-connect-client/src/main/java/org/mitre/openid/connect/client/service/RegisteredClientService.java

@@ -19,6 +19,8 @@
  */
 package org.mitre.openid.connect.client.service;
 
+import java.util.List;
+
 import org.mitre.oauth2.model.RegisteredClient;
 
 /**

openid-connect-common/src/main/java/org/mitre/openid/connect/service/MITREidDataService.java

@@ -60,4 +60,13 @@ public interface MITREidDataService {
  */
 void importData(JsonReader reader) throws IOException;
 
+/**
+ * Return true if the this data service supports the given version. This is called before 
+ * handing the service the reader through its importData function.
+ * 
+ * @param version
+ * @return
+ */
+boolean supportsVersion(String version);
+
 }

openid-connect-common/src/main/java/org/mitre/openid/connect/service/MITREidDataServiceExtension.java

@@ -0,0 +1,68 @@
+/*******************************************************************************
+ * Copyright 2017 The MITRE Corporation
+ * and the MIT Internet Trust Consortium
+ *
+ * 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.mitre.openid.connect.service;
+
+import java.io.IOException;
+
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+
+/**
+ * A modular extension to the data import/export layer. Any instances of this need to be 
+ * declared as beans to be picked up by the data services.
+ * 
+ * @author jricher
+ *
+ */
+public interface MITREidDataServiceExtension {
+
+/**
+ * Export any data for this extension. This is called from the top level object. 
+ * All extensions MUST return the writer to a state such that another member of
+ * the top level object can be written next.
+ * 
+ * @param writer
+ */
+void exportExtensionData(JsonWriter writer) throws IOException;
+
+/**
+ * Import data that's part of this extension. This is called from the context of
+ * reading the top level object. All extensions MUST return the reader to a state
+ * such that another member of the top level object can be read next. The name of
+ * the data element being imported is passed in as name. If the extension does not
+ * support this data element, it must return without advancing the reader.
+ * 
+ * Returns "true" if the item was processed, "false" otherwise.
+ * 
+ * @param reader
+ */
+boolean importExtensionData(String name, JsonReader reader) throws IOException;
+
+/**
+ * Signal the extension to wrap up all object processing and finalize its 
+ */
+void fixExtensionObjectReferences();
+
+/**
+ * Return 
+ * @param mitreidConnect13
+ * @return
+ */
+boolean supportsVersion(String version);
+
+}

openid-connect-common/src/main/java/org/mitre/uma/service/SavedRegisteredClientService.java

@@ -0,0 +1,45 @@
+/*******************************************************************************
+ * Copyright 2017 The MITRE Corporation
+ * and the MIT Internet Trust Consortium
+ *
+ * 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.mitre.uma.service;
+
+import java.util.Collection;
+
+import org.mitre.oauth2.model.RegisteredClient;
+import org.mitre.uma.model.SavedRegisteredClient;
+
+/**
+ * @author jricher
+ *
+ */
+public interface SavedRegisteredClientService {
+
+/**
+ * Get a list of all the registered clients that we know about.
+ * 
+ * @return
+ */
+Collection<SavedRegisteredClient> getAll();
+
+/**
+ * @param issuer
+ * @param client
+ */
+void save(String issuer, RegisteredClient client);
+
+
+}

openid-connect-server/src/main/java/org/mitre/openid/connect/service/impl/MITREidDataService_1_0.java

@@ -19,10 +19,12 @@
 import java.io.IOException;
 import java.text.ParseException;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
@@ -46,6 +48,7 @@
 import org.mitre.openid.connect.repository.BlacklistedSiteRepository;
 import org.mitre.openid.connect.repository.WhitelistedSiteRepository;
 import org.mitre.openid.connect.service.MITREidDataService;
+import org.mitre.openid.connect.service.MITREidDataServiceExtension;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -96,6 +99,15 @@ public class MITREidDataService_1_0 extends MITREidDataServiceSupport implements
 private OAuth2TokenRepository tokenRepository;
 @Autowired
 private SystemScopeRepository sysScopeRepository;
+@Autowired(required = false)
+private List<MITREidDataServiceExtension> extensions = Collections.emptyList();
+
+private static final String THIS_VERSION = MITREID_CONNECT_1_0;
+
+@Override
+public boolean supportsVersion(String version) {
+return THIS_VERSION.equals(version);
+}
 
 /* (non-Javadoc)
  * @see org.mitre.openid.connect.service.MITREidDataService#export(com.google.gson.stream.JsonWriter)
@@ -140,6 +152,14 @@ public void importData(JsonReader reader) throws IOException {
 } else if (name.equals(SYSTEMSCOPES)) {
 readSystemScopes(reader);
 } else {
+for (MITREidDataServiceExtension extension : extensions) {
+if (extension.supportsVersion(THIS_VERSION)) {
+if (extension.canImport(name)) {
+extension.importExtensionData(reader);
+break;
+}
+}
+}
 // unknown token, skip it
 reader.skipValue();
 }
@@ -154,6 +174,12 @@ public void importData(JsonReader reader) throws IOException {
 continue;	}
 }
 fixObjectReferences();
+for (MITREidDataServiceExtension extension : extensions) {
+if (extension.supportsVersion(THIS_VERSION)) {
+extension.fixExtensionObjectReferences();
+break;
+}
+}
 }
 private Map<Long, String> refreshTokenToClientRefs = new HashMap<>();
 private Map<Long, Long> refreshTokenToAuthHolderRefs = new HashMap<>();

openid-connect-server/src/main/java/org/mitre/openid/connect/service/impl/MITREidDataService_1_1.java

@@ -20,10 +20,12 @@
 import java.io.Serializable;
 import java.text.ParseException;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
@@ -48,6 +50,7 @@
 import org.mitre.openid.connect.repository.BlacklistedSiteRepository;
 import org.mitre.openid.connect.repository.WhitelistedSiteRepository;
 import org.mitre.openid.connect.service.MITREidDataService;
+import org.mitre.openid.connect.service.MITREidDataServiceExtension;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -99,6 +102,15 @@ public class MITREidDataService_1_1 extends MITREidDataServiceSupport implements
 private OAuth2TokenRepository tokenRepository;
 @Autowired
 private SystemScopeRepository sysScopeRepository;
+@Autowired(required = false)
+private List<MITREidDataServiceExtension> extensions = Collections.emptyList();
+
+private static final String THIS_VERSION = MITREID_CONNECT_1_1;
+
+@Override
+public boolean supportsVersion(String version) {
+return THIS_VERSION.equals(version);
+}
 
 /* (non-Javadoc)
  * @see org.mitre.openid.connect.service.MITREidDataService#export(com.google.gson.stream.JsonWriter)
@@ -142,6 +154,14 @@ public void importData(JsonReader reader) throws IOException {
 } else if (name.equals(SYSTEMSCOPES)) {
 readSystemScopes(reader);
 } else {
+for (MITREidDataServiceExtension extension : extensions) {
+if (extension.supportsVersion(THIS_VERSION)) {
+if (extension.canImport(name)) {
+extension.importExtensionData(reader);
+break;
+}
+}
+}
 // unknown token, skip it
 reader.skipValue();
 }
@@ -157,6 +177,12 @@ public void importData(JsonReader reader) throws IOException {
 }
 }
 fixObjectReferences();
+for (MITREidDataServiceExtension extension : extensions) {
+if (extension.supportsVersion(THIS_VERSION)) {
+extension.fixExtensionObjectReferences();
+break;
+}
+}
 }
 private Map<Long, String> refreshTokenToClientRefs = new HashMap<>();
 private Map<Long, Long> refreshTokenToAuthHolderRefs = new HashMap<>();

openid-connect-server/src/main/java/org/mitre/openid/connect/service/impl/MITREidDataService_1_2.java

@@ -19,9 +19,11 @@
 import java.io.IOException;
 import java.io.Serializable;
 import java.text.ParseException;
+import java.util.Collections;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
@@ -46,6 +48,7 @@
 import org.mitre.openid.connect.repository.BlacklistedSiteRepository;
 import org.mitre.openid.connect.repository.WhitelistedSiteRepository;
 import org.mitre.openid.connect.service.MITREidDataService;
+import org.mitre.openid.connect.service.MITREidDataServiceExtension;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -162,6 +165,15 @@ public class MITREidDataService_1_2 extends MITREidDataServiceSupport implements
 private OAuth2TokenRepository tokenRepository;
 @Autowired
 private SystemScopeRepository sysScopeRepository;
+@Autowired(required = false)
+private List<MITREidDataServiceExtension> extensions = Collections.emptyList();
+
+private static final String THIS_VERSION = MITREID_CONNECT_1_2;
+
+@Override
+public boolean supportsVersion(String version) {
+return THIS_VERSION.equals(version);
+}
 
 /* (non-Javadoc)
  * @see org.mitre.openid.connect.service.MITREidDataService#export(com.google.gson.stream.JsonWriter)
@@ -206,6 +218,14 @@ public void importData(JsonReader reader) throws IOException {
 } else if (name.equals(SYSTEMSCOPES)) {
 readSystemScopes(reader);
 } else {
+for (MITREidDataServiceExtension extension : extensions) {
+if (extension.supportsVersion(THIS_VERSION)) {
+if (extension.canImport(name)) {
+extension.importExtensionData(reader);
+break;
+}
+}
+}
 // unknown token, skip it
 reader.skipValue();
 }
@@ -221,6 +241,12 @@ public void importData(JsonReader reader) throws IOException {
 }
 }
 fixObjectReferences();
+for (MITREidDataServiceExtension extension : extensions) {
+if (extension.supportsVersion(THIS_VERSION)) {
+extension.fixExtensionObjectReferences();
+break;
+}
+}
 }
 private Map<Long, String> refreshTokenToClientRefs = new HashMap<Long, String>();
 private Map<Long, Long> refreshTokenToAuthHolderRefs = new HashMap<Long, Long>();