Utils.java

/*
 * Copyright (C) 2003-2017 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.exoplatform.management.mop.binding.xml;

import org.exoplatform.portal.config.model.LocalizedString;
import org.gatein.common.xml.stax.navigator.StaxNavUtils;
import org.gatein.common.xml.stax.writer.StaxWriter;
import org.staxnav.StaxNavException;
import org.staxnav.StaxNavigator;

import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.xml.XMLConstants;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;

/**
 * The Class Utils.
 *
 * @author <a href="mailto:nscavell@redhat.com">Nick Scavelli</a>
 * @version $Revision$
 */
class Utils {
  
  /** The Constant XMLLANG_PATTERN. */
  private static final Pattern XMLLANG_PATTERN = Pattern.compile("^([a-zA-Z]{2})(?:-([a-zA-Z]{2}))?$");

  /**
   * Write gatein objects namespace.
   *
   * @param <N> the number type
   * @param writer the writer
   * @throws XMLStreamException the XML stream exception
   */
  public static <N> void writeGateinObjectsNamespace(StaxWriter<N> writer) throws XMLStreamException {
    String gatein_object_ns = Namespace.CURRENT.getUri();
    String location = new StringBuilder().append(gatein_object_ns).append(" ").append(gatein_object_ns).toString();

    writer.writeDefaultNamespace(gatein_object_ns);
    writer.writeNamespace("xsi", XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI);
    writer.writeAttribute(new QName(XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI, "schemaLocation"), location);
  }

  /**
   * Parses the localized string.
   *
   * @param <N> the number type
   * @param navigator the navigator
   * @return the localized string
   * @throws StaxNavException the stax nav exception
   */
  public static <N> LocalizedString parseLocalizedString(StaxNavigator<N> navigator) throws StaxNavException {
    String attribute = navigator.getAttribute(new QName(XMLConstants.XML_NS_URI, "lang", XMLConstants.XML_NS_PREFIX));
    if (attribute == null) {
      attribute = navigator.getAttribute("lang");
    }

    Locale lang = null;
    if (attribute != null) {
      Matcher matcher = XMLLANG_PATTERN.matcher(attribute);
      if (matcher.matches()) {
        String langISO = matcher.group(1);
        String countryISO = matcher.group(2);
        if (countryISO == null) {
          lang = new Locale(langISO.toLowerCase());
        } else {
          lang = new Locale(langISO.toLowerCase(), countryISO.toLowerCase());
        }
      } else {
        throw new StaxNavException(navigator.getLocation(), "The attribute xml:lang='" + attribute + "' does not represent a valid language pattern (ie: en, en-us).");
      }
    }

    String value = StaxNavUtils.getRequiredContent(navigator, false);

    return new LocalizedString(value, lang);
  }
}