001/* 002 * (C) Copyright 2017-2018 Nuxeo (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * Florent Guillaume 018 */ 019package org.nuxeo.runtime.kv; 020 021import java.util.HashMap; 022import java.util.Map; 023 024import org.nuxeo.common.xmap.annotation.XNode; 025import org.nuxeo.common.xmap.annotation.XNodeMap; 026import org.nuxeo.common.xmap.annotation.XObject; 027import org.nuxeo.runtime.model.Descriptor; 028 029/** 030 * Descriptor of Key/Value store contribution. 031 * 032 * @since 9.1 033 */ 034@XObject("store") 035public class KeyValueStoreDescriptor implements Descriptor { 036 037 @XNode("@name") 038 public String name; 039 040 @XNode("@remove") 041 public boolean remove; 042 043 @XNode("@class") 044 public Class<? extends KeyValueStoreProvider> klass; 045 046 /** 047 * An optional namespace that may be used to disambiguate otherwise similar descriptors (in particular, copies). 048 * 049 * @since 10.10 050 */ 051 @XNode("namespace") 052 public String namespace; 053 054 @XNodeMap(value = "property", key = "@name", type = HashMap.class, componentType = String.class) 055 public Map<String, String> properties = new HashMap<>(); 056 057 @Override 058 public String getId() { 059 return name; 060 } 061 062 /** 063 * Empty constructor. 064 */ 065 public KeyValueStoreDescriptor() { 066 } 067 068 /** 069 * Copy constructor. 070 * 071 * @since 10.10 072 */ 073 public KeyValueStoreDescriptor(KeyValueStoreDescriptor other) { 074 name = other.name; 075 remove = other.remove; 076 klass = other.klass; 077 namespace = other.namespace; 078 properties.putAll(other.properties); 079 } 080 081}