com.gemstone.gemfire.management.internal.web.util.ConvertUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
The newest version!
/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.management.internal.web.util;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import com.gemstone.gemfire.internal.lang.StringUtils;
import com.gemstone.gemfire.internal.util.IOUtils;
import com.gemstone.gemfire.management.internal.cli.CliUtil;
import com.gemstone.gemfire.management.internal.web.io.MultipartFileResourceAdapter;

import org.springframework.core.io.ByteArrayResource;
import org.springframework.core.io.Resource;
import org.springframework.web.multipart.MultipartFile;

/**
 * The ConvertUtils class is a support class for performing conversions used by the GemFire web application
 * and REST interface.
 * 
 * @author John Blum
 * @see com.gemstone.gemfire.management.internal.cli.CliUtil
 * @since 7.5
 */
@SuppressWarnings("unused")
public abstract class ConvertUtils {

  /**
   * Converts the 2-dimensional byte array of file data, which includes the name of the file as bytes followed by
   * the byte content of the file, for all files being transmitted by Gfsh to the GemFire Manager.
   * 

   * @param fileData a 2 dimensional byte array of files names and file content.
   * @return an array of Spring Resource objects encapsulating the details (name and content) of each file being
   * transmitted by Gfsh to the GemFire Manager.
   * @see org.springframework.core.io.ByteArrayResource
   * @see org.springframework.core.io.Resource
   * @see com.gemstone.gemfire.management.internal.cli.CliUtil#bytesToData(byte[][])
   * @see com.gemstone.gemfire.management.internal.cli.CliUtil#bytesToNames(byte[][])
   */
  public static Resource[] convert(final byte[][] fileData) {
    if (fileData != null) {
      final String[] fileNames = CliUtil.bytesToNames(fileData);
      final byte[][] fileContent = CliUtil.bytesToData(fileData);

      final List resources = new ArrayList(fileNames.length);

      for (int index = 0; index < fileNames.length; index++) {
        final String filename = fileNames[index];
        resources.add(new ByteArrayResource(fileContent[index], String.format("Contents of JAR file (%1$s).", filename)) {
          @Override
          public String getFilename() {
            return filename;
          }
        });
      }

      return resources.toArray(new Resource[resources.size()]);
    }

    return new Resource[0];
  }

  /**
   * Converts the array of MultipartFiles into a 2-dimensional byte array containing content from each MultipartFile.
   * The 2-dimensional byte array format is used by Gfsh and the GemFire Manager to transmit file data.
   * 

   * @param files an array of Spring MultipartFile objects to convert into the 2-dimensional byte array format.
   * @return a 2-dimensional byte array containing the content of each MultipartFile.
   * @throws IOException if an I/O error occurs reading the contents of a MultipartFile.
   * @see #convert(org.springframework.core.io.Resource...)
   * @see org.springframework.web.multipart.MultipartFile
   */
  public static byte[][] convert(final MultipartFile... files) throws IOException {
    if (files != null) {
      final List resources = new ArrayList(files.length);

      for (final MultipartFile file : files) {
        resources.add(new MultipartFileResourceAdapter(file));
      }

      return convert(resources.toArray(new Resource[resources.size()]));
    }

    return new byte[0][];
  }

  /**
   * Converts the array of Resources into a 2-dimensional byte array containing content from each Resource.
   * The 2-dimensional byte array format is used by Gfsh and the GemFire Manager to transmit file data.
   * 
   * @param resources an array of Spring Resource objects to convert into the 2-dimensional byte array format.
   * @return a 2-dimensional byte array containing the content of each Resource.
   * @throws IllegalArgumentException if the filename of a Resource was not specified.
   * @throws IOException if an I/O error occurs reading the contents of a Resource!
   * @see org.springframework.core.io.Resource
   */
  public static byte[][] convert(final Resource... resources) throws IOException {
    if (resources != null) {
      final List fileData = new ArrayList(resources.length * 2);

      for (final Resource resource : resources) {
        if (StringUtils.isBlank(resource.getFilename())) {
          throw new IllegalArgumentException(String.format("The filename of Resource (%1$s) must be specified!",
            resource.getDescription()));
        }

        fileData.add(resource.getFilename().getBytes());
        fileData.add(IOUtils.toByteArray(resource.getInputStream()));
      }

      return fileData.toArray(new byte[fileData.size()][]);
    }

    return new byte[0][];
  }

}