stack/corepersistence/common/src/main/java/org/apache/usergrid/persistence/core/migration/data/MigrationInfoSerializationImpl.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.migration.data;


import java.util.Collection;
import java.util.Collections;
import java.util.UUID;

import org.apache.cassandra.db.marshal.BytesType;
import org.apache.cassandra.db.marshal.UTF8Type;

import org.apache.usergrid.persistence.core.astyanax.*;
import org.apache.usergrid.persistence.core.datastax.TableDefinition;
import org.apache.usergrid.persistence.core.migration.util.AstayanxUtils;
import org.apache.usergrid.persistence.model.entity.Id;
import org.apache.usergrid.persistence.model.entity.SimpleId;

import com.google.inject.Inject;
import com.google.inject.Singleton;
import com.netflix.astyanax.Keyspace;
import com.netflix.astyanax.connectionpool.exceptions.ConnectionException;
import com.netflix.astyanax.connectionpool.exceptions.NotFoundException;
import com.netflix.astyanax.serializers.StringSerializer;


@Singleton
public class MigrationInfoSerializationImpl implements MigrationInfoSerialization {

    /**
     * Just a hard coded scope since we need it
     */
    private static final Id STATIC_ID =
            new SimpleId( UUID.fromString( "00000000-0000-1000-8000-000000000000" ), "status" );


    private static final ScopedRowKeySerializer<String> ROW_KEY_SER =
            new ScopedRowKeySerializer<String>( StringRowCompositeSerializer.get() );

    private static final StringSerializer STRING_SERIALIZER = StringSerializer.get();


    public static final MultiTenantColumnFamily<ScopedRowKey<String>, String> CF_MIGRATION_INFO =
            new MultiTenantColumnFamily<>( "Data_Migration_Info", ROW_KEY_SER, STRING_SERIALIZER );


    /**
     * The row key we previously used to store versions.  This is required to migrate versions in each module to the correct version
     */
    private static final ScopedRowKey<String> LEGACY_ROW_KEY = ScopedRowKey.fromKey( STATIC_ID, "" );

    private static final String COL_STATUS_MESSAGE = "statusMessage";

    private static final String COLUMN_VERSION = "version";

    private static final String COLUMN_STATUS_CODE = "statusCode";

    private final Keyspace keyspace;


    @Inject
    public MigrationInfoSerializationImpl( final CassandraCluster cassandraCluster ) {
        this.keyspace = cassandraCluster.getApplicationKeyspace();
    }


    @Override
    public void setStatusMessage(final String pluginName,  final String message ) {

        final ScopedRowKey<String> rowKey = ScopedRowKey.fromKey( STATIC_ID, pluginName);

        try {
            keyspace.prepareColumnMutation( CF_MIGRATION_INFO, rowKey, COL_STATUS_MESSAGE ).putValue( message, null )
                    .execute();
        }
        catch ( ConnectionException e ) {
            throw new DataMigrationException( "Unable to save status", e );
        }
    }


    @Override
    public String getStatusMessage(final String pluginName) {

        final ScopedRowKey<String> rowKey = ScopedRowKey.fromKey( STATIC_ID, pluginName);

        try {
            return keyspace.prepareQuery( CF_MIGRATION_INFO ).getKey( rowKey ).getColumn( COL_STATUS_MESSAGE )
                           .execute().getResult().getStringValue();
        }
        //swallow, it doesn't exist
        catch ( NotFoundException nfe ) {
            return null;
        }
        catch ( ConnectionException e ) {
            throw new DataMigrationException( "Unable to retrieve status", e );
        }
    }


    @Override
    public void setVersion(final String pluginName, final int version ) {

        final ScopedRowKey<String> rowKey = ScopedRowKey.fromKey( STATIC_ID, pluginName);

        try {
            keyspace.prepareColumnMutation( CF_MIGRATION_INFO, rowKey, COLUMN_VERSION ).putValue( version, null )
                    .execute();
        }
        catch ( ConnectionException e ) {
            throw new DataMigrationException( "Unable to save status", e );
        }
    }


    @Override
    public int getVersion(final String pluginName) {

        final ScopedRowKey<String> rowKey = ScopedRowKey.fromKey( STATIC_ID, pluginName);

        try {
            return keyspace.prepareQuery( CF_MIGRATION_INFO ).getKey( rowKey ).getColumn( COLUMN_VERSION ).execute()
                           .getResult().getIntegerValue();
        }
        //swallow, it doesn't exist
        catch ( NotFoundException nfe ) {
            return 0;
        }
        catch ( ConnectionException e ) {
            AstayanxUtils.isKeyspaceMissing("Unable to connect to cassandra to retrieve status", e);
            return 0;
        }
    }


    @Override
    public void setStatusCode(final String pluginName, final int status ) {

        final ScopedRowKey<String> rowKey = ScopedRowKey.fromKey( STATIC_ID, pluginName);

        try {
            keyspace.prepareColumnMutation( CF_MIGRATION_INFO, rowKey, COLUMN_STATUS_CODE ).putValue( status, null )
                    .execute();
        }
        catch ( ConnectionException e ) {
            throw new DataMigrationException( "Unable to save status", e );
        }
    }


    @Override
    public int getStatusCode(final String pluginName) {

        final ScopedRowKey<String> rowKey = ScopedRowKey.fromKey( STATIC_ID, pluginName);

        try {
            return keyspace.prepareQuery( CF_MIGRATION_INFO ).getKey( rowKey ).getColumn( COLUMN_STATUS_CODE )
                           .execute().getResult().getIntegerValue();
        }
        //swallow, it doesn't exist
        catch ( NotFoundException nfe ) {
            return 0;
        }
        catch ( ConnectionException e ) {
            throw new DataMigrationException( "Unable to retrieve status", e );
        }
    }


    @Override
    public int getSystemVersion() {
        try {
            return keyspace.prepareQuery( CF_MIGRATION_INFO ).getKey( LEGACY_ROW_KEY ).getColumn( COLUMN_VERSION )
                           .execute().getResult().getIntegerValue();
        }
        //swallow, it doesn't exist
        catch ( NotFoundException nfe ) {
            return 0;
        }
        catch ( ConnectionException e ) {
            throw new DataMigrationException( "Unable to retrieve status", e );
        }
    }


    @Override
    public Collection<MultiTenantColumnFamilyDefinition> getColumnFamilies() {
        return Collections.singletonList(
                new MultiTenantColumnFamilyDefinition( CF_MIGRATION_INFO, BytesType.class.getSimpleName(),
                        UTF8Type.class.getSimpleName(), BytesType.class.getSimpleName(),
                        MultiTenantColumnFamilyDefinition.CacheOption.KEYS ) );
    }

    @Override
    public Collection<TableDefinition> getTables() {

        return Collections.emptyList();
    }
}