CinderConstants.java

/*
 * Copyright (c) 2014 EMC Corporation
 * All Rights Reserved
 */
package com.emc.storageos.cinder;

public interface CinderConstants {

    String HTTPS_URL = "https://";
    String HTTP_URL = "http://";
    String COLON = ":";
    String ATTACH_RESPONSE_FC_TYPE = "fibre_channel";
    String ATTACH_RESPONSE_ISCSI_TYPE = "iscsi";
    String HYPHEN = "-";
    char CHAR_HYPHEN = '-';
    String DEFAULT = "DEFAULT";
    public static final int STATUS_ACCEPT = 202;
    public static final int STATUS_OK = 200;

    public static String CINDER_SSH_PORT = "22";
    public static String CINDER_REST_PORT = "8776";
    public static String OS_ADMIN_PORT = "35357";
    public static String AUTH_TOKEN_HEADER = "X-Auth-Token";
    public static String REST_API_VERSION_2 = "/v2";
    public static String DEFAULT_API_VERSION = REST_API_VERSION_2; // By default using v2

    String COPRHD_URL_V2 = ":8776/v2/%(tenant_id)s";
    String COPRHD_URL_V1 = ":8776/v1/%(tenant_id)s";
    String PROJECT_NAME_SUFFIX = "Project"; // with appended OpenStack tenant name
    String TENANT_NAME_PREFIX = "OpenStack"; // with appended OpenStack tenant name

    String SERVICE_DESCRIPTION = "OpenStack Block Storage";
    String SERVICE_TYPE_VOLUME = "volume";
    String SERVICE_TYPE_VOLUMEV2 = "volumev2";

    String USERNAME = "username";
    String TENANTNAME = "tenantname";

    public final static String KEY_CINDER_HOST_NAME = "CINDER_HOST_NAME";
    public final static String KEY_CINDER_REST_PASSWORD = "REST_PASSWORD";           
    public final static String KEY_CINDER_REST_USER = "REST_USERNAME";
    public final static String KEY_CINDER_REST_URI_BASE = "REST_URI_BASE";
    public final static String KEY_CINDER_TENANT_NAME = "TENANT_NAME";
    public final static String KEY_CINDER_REST_TOKEN = "REST_TOKEN";
    public final static String KEY_CINDER_TENANT_ID = "TENANT_ID";

    public final static String CINDER_PORT_GROUP = "Cinder-PortGroup";

    public final static String PREFIX_ITL = "ITL-";
    
    public final static long BYTES_TO_GB = 1024*1024*1024;
    
    /**
     * URIs for volume types
     */
    public static String URI_LIST_VOLUME_TYPES = DEFAULT_API_VERSION + "/%1$s/types";

    /**
     * URIs for volume operations
     */
    public static String URI_LIST_VOLUMES = DEFAULT_API_VERSION + "/%1$s/volumes";
    public static String URI_CREATE_VOLUME = URI_LIST_VOLUMES;
    public static String URI_DELETE_VOLUME = DEFAULT_API_VERSION + "/%1$s/volumes/%2$s";
    public static String URI_UPDATE_VOLUME = DEFAULT_API_VERSION + "/%1$s/volumes/%2$s?display_description=%3$s&display_name=%4$s}";

    /**
     * URIs for volume export operations
     */
    public static String URI_VOLUME_ACTION = DEFAULT_API_VERSION + "/%1$s/volumes/%2$s/action";
    public static String URI_DETACH_VOLUME = URI_VOLUME_ACTION;

    /**
     * URIs for snapshot operations
     */
    public static String URI_LIST_SNAPSHOTS = DEFAULT_API_VERSION + "/%1$s/snapshots";
    public static String URI_CREATE_SNAPSHOT = URI_LIST_SNAPSHOTS;
    public static String URI_DELETE_SNAPSHOT = DEFAULT_API_VERSION + "/%1$s/snapshots/%2$s";
    public static String URI_UPDATE_SNAPSHOT = DEFAULT_API_VERSION + "/%1$s/snapshots/%2$s​?display_description=%3$s&​display_name=%4$s";

    /**
     * 
     * Quota Service specific constants.
     *
     */
    public static String DEFAULT_QUOTA_CLASS = "default";
    public static String CLASS_NAME_KEY= "class_name";
    public static String TENANT_ID_KEY= "tenant_id";
    public static final long DEFAULT_VOLUME_TYPE_QUOTA = -1;


    /*
     * Enum types for different kinds resources for which quota can be defined
     * with ViPR cinder.  
     */
    public static enum ResourceQuotaDefaults
    {
        VOLUMES("volumes" , 6000),
        SNAPSHOTS("snapshots", 3000),
        GIGABYTES("gigabytes", 1000000);
        
        public String resource = "";
        public long limit = 0;

        ResourceQuotaDefaults(String resource, long limit)
        {
            this.resource = resource;
            this.limit = limit;
        }

        public String getResource()
        {
            return this.resource;
        }
        
        public long getLimit()
        {
            return this.limit;
        }
    }

    
    
    /*
     * Enum types for the status check of the components ( volume/snapshot )
     * under creation/modification.
     */
    public static enum ComponentStatus
    {

        CREATING("Creating"),
        AVAILABLE("Available"),
        ERROR("Error"),
        ATTACHING("Attaching"),
        IN_USE("In-Use"),
        EXTENDING("Extending"),
        DETACHING("Detatching"),
        DELETED("Deleted"),
        DELETING("Deleting"),
        ERROR_DELETING("Error_Deleting"),
        ERROR_EXTENDING("Error_Extending");

        public String status = "";

        ComponentStatus(String status)
        {
            this.status = status;
        }

        public String getStatus()
        {
            return this.status;
        }
    }

    /**
     * Enum types for the types of the components ( volume/snapshot )
     * 
     */

    public static enum ComponentType {
        volume,
        snapshot;
    }
    
    
    /*
     * Enum types for different kinds actions possible during volume attach 
     * with enterprize cinder.  
     */
    public static enum ExportOperations
    {
        OS_RESERVE("os-reserve"),
        OS_UNRESERVE("os-unreserve"),
        OS_TERMINATE_CONNECTION("os-terminate_connection"),
        OS_BEGIN_DETACHING("os-begin_detaching"),
        OS_DETACH("os-detach"),
        OS_INITIALIZE_CONNECTION("os-initialize_connection"),
        OS_ATTACH("os-attach"),
        OS_EXTEND("os-extend"),
        OS_RESET_STATUS("os-reset_status"),        
        OS_SET_BOOTABLE("os-set_bootable"),
        OS_UPDATE_READONLY("os-update_readonly_flag");

        public String operation = "";

        ExportOperations(String operation)
        {
            this.operation = operation;
        }

        public String getOperation()
        {
            return this.operation;
        }
    }

}