/*
 * 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.geode.management.internal.web;

import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Map;

import org.apache.geode.internal.lang.StringUtils;
import org.apache.geode.management.internal.web.domain.Link;

/**
 * The AbstractWebDomainTests class is abstract base class containing functionality common to a test
 * suite classes in the org.apache.geode.management.internal.web.domain package.
 * <p/>
 * 
 * @see java.net.URI
 * @see java.net.URLDecoder
 * @see java.net.URLEncoder
 * @see org.apache.geode.management.internal.web.domain.Link
 * @since GemFire 8.0
 */
@SuppressWarnings("unused")
public abstract class AbstractWebTestCase {

  protected <E> E[] createArray(final E... array) {
    return array;
  }

  protected <K, V> Map<K, V> createMap(final K[] keys, final V[] values) {
    assert keys != null : "The Keys for the Map cannot be null!";
    assert values != null : "The Values for the Map cannot be null!";
    assert keys.length == values.length;

    final Map<K, V> map = new HashMap<K, V>(keys.length);
    int index = 0;

    for (final K key : keys) {
      map.put(key, values[index++]);
    }

    return map;
  }

  protected String decode(final String encodedValue) throws UnsupportedEncodingException {
    return URLDecoder.decode(encodedValue, StringUtils.UTF_8);
  }

  protected String encode(final String value) throws UnsupportedEncodingException {
    return URLEncoder.encode(value, StringUtils.UTF_8);
  }

  protected String toString(final Link... links) throws UnsupportedEncodingException {
    final StringBuilder buffer = new StringBuilder("[");
    int count = 0;

    for (final Link link : links) {
      buffer.append(count++ > 0 ? ", " : StringUtils.EMPTY_STRING).append(toString(link));

    }

    buffer.append("]");

    return buffer.toString();
  }

  protected String toString(final Link link) throws UnsupportedEncodingException {
    return link.toHttpRequestLine();
  }

  protected String toString(final URI uri) throws UnsupportedEncodingException {
    return decode(uri.toString());
  }

  protected URI toUri(final String uriString)
      throws UnsupportedEncodingException, URISyntaxException {
    return new URI(encode(uriString));
  }

}