MultiTenantColumnFamilyDefinition.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.usergrid.persistence.core.astyanax;


import java.util.HashMap;
import java.util.Map;

import com.google.common.base.Preconditions;
import com.netflix.astyanax.model.ColumnFamily;


/**
 * Bean wrapper for column family information
 *
 * @author tnine
 */
public class MultiTenantColumnFamilyDefinition {


    /**
     * Options for caching on the CF
     */
    public enum CacheOption {
        /**
         * Use both row key shard and key shard
         */
        ALL( "ALL" ),

        /**
         * Cache keys only (the default)
         */
        KEYS( "KEYS_ONLY" ),

        /**
         * Cache rows only, no keys
         */
        ROWS( "ROWS_ONLY" ),

        /**
         * Cache neither
         */
        NONE( "NONE" );

        private String value;


        private CacheOption( String value ) {
            this.value = value;
        }


        public String getValue() {
            return value;
        }
    }


    public static final String COMPARATOR_TYPE = "comparator_type";
    public static final String READ_REPAIR_CHANCE = "read_repair_chance";
    public static final String KEY_VALIDATION = "key_validation_class";
    public static final String VALUE_VALIDATION = "default_validation_class";
    public static final String CACHE_OPTION = "caching";
    public static final String COMPACTION_STRATEGY = "compaction_strategy";
    public static final String COMPACTION_STRATEGY_OPTIONS = "compaction_strategy_options";
    public static final String COMPACTION_SSTABLE_SIZE = "sstable_size_in_mb";
    public static final String BLOOM_FILTER_FP = "sstable_size_in_mb";



    private final ColumnFamily columnFamily;
    private final String columnComparatorType;
    private final String keyValidationType;
    private final String columnValidationType;
    private final CacheOption cacheOption;


    public MultiTenantColumnFamilyDefinition(final ColumnFamily columnFamily, final String keyValidationType,
                                             final String columnComparatorType, final String columnValidationType, final CacheOption cacheOption ) {

        Preconditions.checkNotNull( columnFamily, "columnFamily is required" );
        Preconditions.checkNotNull( columnComparatorType, "columnComparatorType is required" );
        Preconditions.checkNotNull( keyValidationType, "keyValidationType is required" );
        Preconditions.checkNotNull( columnValidationType, "columnValueValidationType is required" );
        Preconditions.checkNotNull( cacheOption, "cacheOption is required" );

        this.columnFamily = columnFamily;
        this.columnComparatorType = columnComparatorType;
        this.keyValidationType = keyValidationType;
        this.columnValidationType = columnValidationType;
        this.cacheOption = cacheOption;
    }



    public Map<String, Object> getOptions() {

        Map<String, Object> options = new HashMap<String, Object>();
        options.put( COMPARATOR_TYPE, columnComparatorType );
        options.put( KEY_VALIDATION, keyValidationType );
        options.put( VALUE_VALIDATION, columnValidationType );
        options.put( CACHE_OPTION, cacheOption.getValue() );


        //always use 10% read repair chance!
        options.put( READ_REPAIR_CHANCE, 0.1d );
        options.put( BLOOM_FILTER_FP, 0.1d );
        options.put( COMPACTION_STRATEGY, "LeveledCompactionStrategy");

        Map<String, Object> compactionOptions = new HashMap<>();
        compactionOptions.put( COMPACTION_SSTABLE_SIZE, "512" );

        options.put( COMPACTION_STRATEGY_OPTIONS, compactionOptions  );

        return options;
    }


    public ColumnFamily getColumnFamily() {
        return columnFamily;
    }
}