/* * Copyright 2016 Red Hat, Inc. and/or its affiliates * and other contributors as indicated by the @author tags. * * 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.keycloak.connections.mongo.updater.impl.updates; import com.mongodb.BasicDBObject; import com.mongodb.DB; import com.mongodb.DBCollection; import org.jboss.logging.Logger; import org.keycloak.models.KeycloakSession; import java.util.Arrays; /** * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a> */ public abstract class Update { protected DB db; protected Logger log; public abstract String getId(); public abstract void update(KeycloakSession session) throws ClassNotFoundException; protected DBCollection createCollection(String name) { if (db.collectionExists(name)) { throw new RuntimeException("Failed to create collection {0}: collection already exists"); } DBCollection col = db.getCollection(name); log.debugv("Created collection {0}", name); return col; } protected void ensureIndex(String name, String field, boolean unique, boolean sparse) { ensureIndex(name, new String[]{field}, unique, sparse); } protected void ensureIndex(String name, String[] fields, boolean unique, boolean sparse) { DBCollection col = db.getCollection(name); BasicDBObject o = new BasicDBObject(); for (String f : fields) { o.append(f, 1); } col.createIndex(o, new BasicDBObject("unique", unique).append("sparse", sparse)); log.debugv("Created index {0}, fields={1}, unique={2}, sparse={3}", name, Arrays.toString(fields), unique, sparse); } protected void deleteEntries(String collection) { db.getCollection(collection).remove(new BasicDBObject()); log.debugv("Deleted entries from {0}", collection); } protected void removeField(String collection, String field) { db.getCollection(collection).update(new BasicDBObject(), new BasicDBObject("$unset" , new BasicDBObject(field, 1)), false, true); } protected void renameCollection(String collection, String newName) { db.getCollection(collection).rename(newName); } public void setLog(Logger log) { this.log = log; } public void setDb(DB db) { this.db = db; } }