com.gemstone.gemfire.admin.internal.ManagedEntityConfigXml Maven / Gradle / Ivy

Go to download
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
There is a newer version: 2.0-BETA
/*
 * 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.admin.internal;

import com.gemstone.gemfire.internal.ClassPathLoader;
import com.gemstone.gemfire.internal.i18n.LocalizedStrings;

import org.xml.sax.*;
import java.io.*;

/**
 * The abstract superclass of classes that convert XML into a {@link
 * com.gemstone.gemfire.admin.DistributedSystemConfig} and vice versa.
 * It provides helper methods and constants.
 *
 * @author David Whitlock
 * @since 4.0
 */
abstract class ManagedEntityConfigXml implements EntityResolver, ErrorHandler {

  /** The location of the DTD file */
  protected static final String DTD_LOCATION =
    "/com/gemstone/gemfire/admin/doc-files/ds5_0.dtd";

  /** The URL for the DTD */
  protected static final String SYSTEM_ID =
    "http://www.gemstone.com/dtd/ds5_0.dtd";

  /** The public ID for the DTD */
  protected static final String PUBLIC_ID = 
    "-//GemStone Systems, Inc.//GemFire Distributed System 5.0//EN";

  /** The name of the distributed-system element. */
  public static final String DISTRIBUTED_SYSTEM =
    "distributed-system";

  /** The name of the id attribute. */
  public static final String ID = "id";

  /** The name of the disable-tcp attribute. */
  public static final String DISABLE_TCP = "disable-tcp";

  /** The name of the remote-command element. */
  public static final String REMOTE_COMMAND = "remote-command";

  /** The name of the locators element. */
  public static final String LOCATORS = "locators";

  /** The name of the ssl element. */
  public static final String SSL = "ssl";

  /** The name of the cache-server element */
  public static final String CACHE_SERVER = "cache-server";

  /** The name of the multicast element */
  public static final String MULTICAST = "multicast";

  /** The name of the locator element */
  public static final String LOCATOR = "locator";

  /** The name of the port attribute */
  public static final String PORT = "port";

  /** The name of the address attribute */
  public static final String ADDRESS = "address";

  /** The name of the host element. */
  public static final String HOST = "host";

  /** The name of the working-directory element */
  public static final String WORKING_DIRECTORY = "working-directory";

  /** The name of the product-directory element */
  public static final String PRODUCT_DIRECTORY = "product-directory";

  /** The name of the protocols element */
  public static final String PROTOCOLS = "protocols";

  /** The name of the ciphers element */
  public static final String CIPHERS = "ciphers";

  /** The name of the property element */
  public static final String PROPERTY = "property";

  /** Name of the authentication-required attribute */
  public static final String AUTHENTICATION_REQUIRED =
    "authentication-required";

  /** The name of the key element */
  public static final String KEY = "key";

  /** The name of the value element */
  public static final String VALUE = "value";
  
  /** The name of the classpath element */
  public static final String CLASSPATH = "classpath";

  ///////////////////////  Instance Methods  ///////////////////////

  /**
   * Given a public id, attempt to resolve it to a DTD.  Returns an
   * InputSoure for the DTD.
   */
  public InputSource resolveEntity(String publicId, String systemId) 
    throws SAXException {

    if (publicId == null || systemId == null) {
      throw new SAXException(LocalizedStrings.ManagedEntityConfigXml_PUBLIC_ID_0_SYSTEM_ID_1.toLocalizedString(new Object[] {publicId, systemId}));
    }

    // Figure out the location for the publicId.
    String location = DTD_LOCATION;

    InputSource result;
//    if (location != null) (cannot be null) 
    {
      InputStream stream = ClassPathLoader.getLatest().getResourceAsStream(getClass(), location);
      if (stream != null) {
        result = new InputSource(stream);
      } else {
        throw new SAXNotRecognizedException(LocalizedStrings.ManagedEntityConfigXml_DTD_NOT_FOUND_0.toLocalizedString(location));
      }

//    } else {
//      throw new SAXNotRecognizedException(LocalizedStrings.ManagedEntityConfigXml_COULD_NOT_FIND_DTD_FOR_0_1.toLocalizedString(new Object[] {publicId, systemId}));
    }

    return result;
  }

  /**
   * Warnings are ignored
   */
  public void warning(SAXParseException ex) throws SAXException { 

  }

  /**
   * Throws a {@link com.gemstone.gemfire.cache.CacheXmlException}
   */
  public void error(SAXParseException ex) throws SAXException {
    IllegalArgumentException ex2 = new IllegalArgumentException(LocalizedStrings.ManagedEntityConfigXml_ERROR_WHILE_PARSING_XML.toLocalizedString());
    ex2.initCause(ex);
    throw ex2;
  }
  
  /**
   * Throws a {@link com.gemstone.gemfire.cache.CacheXmlException}
   */
  public void fatalError(SAXParseException ex) throws SAXException {
    IllegalArgumentException ex2 = new IllegalArgumentException(LocalizedStrings.ManagedEntityConfigXml_FATAL_ERROR_WHILE_PARSING_XML.toLocalizedString());
    ex2.initCause(ex);
    throw ex2;
  }

}