VPlexStorageVolumeInfo.java

/*
 * Copyright (c) 2013 EMC Corporation
 * All Rights Reserved
 */
package com.emc.storageos.vplex.api;

import java.util.ArrayList;
import java.util.List;

/**
 * Info for a VPlex storage volume
 */
public class VPlexStorageVolumeInfo extends VPlexResourceInfo {

    // The id of the VPlex cluster to which the storage volume belongs.
    private String clusterId;

    // The system-id of the storage volume
    // which contains the backend volume WWN
    private String systemId;

    // the component-type value
    private String componentType;

    // List of initiator+target+lun items for this volume
    private List<String> itls = new ArrayList<>();
    private boolean isItlsFormatted = false;

    /**
     * Getter for the storage system cluster id.
     * 
     * @return The storage system cluster id.
     */
    public String getClusterId() {
        return clusterId;
    }

    /**
     * Setter for the storage system cluster id.
     * 
     * @param id The storage system cluster id.
     */
    public void setClusterId(String id) {
        clusterId = id;
    }

    /**
     * Gets the formatted ITLs
     * 
     * @return
     */
    public List<String> getItls() {

        if (!isItlsFormatted) {
            if (null != itls && !itls.isEmpty()) {
                /*
                 * Converting from "0x5000144260037d13\/0x5006016036601854\/2"
                 * to "5000144260037d13-5006016036601854-2" (<initiator-wwn>-<targte-wwn>-<lun-id>)
                 */
                List<String> formatttedItls = new ArrayList<String>(itls.size());
                for (String itl : itls) {
                    String[] itlParts = itl.split("/");

                    String part1 = itlParts[0];
                    String part2 = itlParts[1];
                    String part3 = itlParts[2];

                    String formattedItl = part1.substring(2) + "-"
                            + part2.substring(2) + "-"
                            + part3;
                    formatttedItls.add(formattedItl);
                }
                isItlsFormatted = true;

                // replace the original list with formatted itls
                itls.clear();
                itls.addAll(formatttedItls);
            }
        }

        return itls;
    }

    /**
     * Set the list of ITLs fetched from the response
     * 
     * @param initiatorTargetLunList
     */
    public void setItls(List<String> initiatorTargetLunList) {
        itls.clear();
        for (String itl : initiatorTargetLunList) {
            itls.add(itl);
        }
    }

    /**
     * Getter for the storage volume system id
     * containing the backend volume wwn.
     * 
     * @return the storage volume system id.
     */
    public String getSystemId() {
        return systemId;
    }

    /**
     * Setter for the storage volume system id.
     * 
     * @param systemId the storage volume system id.
     */
    public void setSystemId(String systemId) {
        this.systemId = systemId;
    }

    /**
     * Returns the WWN of this storage volume as
     * extracted from the storage volume system id.
     * The expected format is the WWN prefixed by
     * "VPD83T3", for example:
     * VPD83T3:600601608d203700db57d68b5d2ae511
     * 
     * For XIV we noticed WWN prefixed by VPD83T2(not
     * sure what triggered this prefix change)
     * 
     * @return the WWN of this storage volume or null.
     */
    public String getWwn() {
        if (systemId != null) {
            if (systemId.startsWith(VPlexApiConstants.VOLUME_WWN_PREFIX)) {
                return systemId.substring(VPlexApiConstants.VOLUME_WWN_PREFIX.length());
            } else if (systemId.startsWith(VPlexApiConstants.VOLUME_WWN_PREFIX_T2)) {
                return systemId.substring(VPlexApiConstants.VOLUME_WWN_PREFIX_T2.length());
            }
        }

        return null;
    }

    /**
     * Getter for the storage volume component type.
     * 
     * @return The storage volume component type.
     */
    public String getComponentType() {
        return componentType;
    }

    /**
     * Setter for the storage volume component type.
     * 
     * @param componentType the component type.
     */
    public void setComponentType(String componentType) {
        this.componentType = componentType;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        StringBuilder str = new StringBuilder();
        str.append("StorageVolumeInfo ( ");
        str.append(super.toString());
        str.append(", clusterId: ").append(clusterId);
        str.append(", systemId: ").append(systemId);
        str.append(", componentType: ").append(componentType);
        str.append(", itls: ");
        List<String> itls = getItls();
        if (null != itls) {
            for (String itl : getItls()) {
                str.append(itl);
                str.append(", ");
            }
        }
        str.append(" )");
        return str.toString();
    }

}