DomainSuffixes.java

/**
 * 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.nutch.util.domain;

import java.io.InputStream;
import java.util.HashMap;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.util.StringUtils;

/**
 * Storage class for <code>DomainSuffix</code> objects 
 * Note: this class is singleton
 * @author Enis Soztutar <enis.soz.nutch@gmail.com>
 */
public class DomainSuffixes {
  private static final Log LOG = LogFactory.getLog(DomainSuffixes.class);
  
  private HashMap<String, DomainSuffix> domains = new HashMap<String, DomainSuffix>(); 
  
  private static DomainSuffixes instance;
  
  /** private ctor */
  private DomainSuffixes() {
    String file = "domain-suffixes.xml";
    InputStream input = this.getClass().getClassLoader().getResourceAsStream(file);
    try {
      new DomainSuffixesReader().read(this, input);
    }
    catch (Exception ex) {
      LOG.warn(StringUtils.stringifyException(ex));
    }
  }
  
  /**
   * Singleton instance, lazy instantination
   * @return
   */
  public static DomainSuffixes getInstance() {
    if(instance == null) {
      instance = new DomainSuffixes();
    }
    return instance;
  }
  
  void addDomainSuffix(DomainSuffix tld) {
    domains.put(tld.getDomain(), tld);
  }

  /** return whether the extension is a registered domain entry */
  public boolean isDomainSuffix(String extension) {
    return domains.containsKey(extension); 
  }
    
  /**
   * Return the {@link DomainSuffix} object for the extension, if 
   * extension is a top level domain returned object will be an 
   * instance of {@link TopLevelDomain}
   * @param extension of the domain
   */
  public DomainSuffix get(String extension) {
    return domains.get(extension);
  }
  
}