thredds.catalog2.simpleImpl.GlobalServiceContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdm Show documentation
The NetCDF-Java Library is a Java interface to NetCDF files, as well as to many other types of scientific data formats.
The newest version!
package thredds.catalog2.simpleImpl;

import thredds.catalog2.builder.BuilderIssues;
import thredds.catalog2.builder.BuilderIssue;
import thredds.catalog2.builder.ThreddsBuilder;

import java.util.Map;
import java.util.List;
import java.util.HashMap;
import java.util.ArrayList;

/**
 * Helper class for tracking services by globally unique names. The THREDDS Catalog specification (and XML Schema)
 * does not allow multiple services with the same name. However, in practice, we allow services with duplicate
 * names and we track those here as well.
 *
 * @author edavis
 * @since 4.0
 */
class GlobalServiceContainer
{
  private Map servicesByGloballyUniqueName;

  private List servicesWithDuplicateName;

  GlobalServiceContainer() {
    this.servicesByGloballyUniqueName = new HashMap();
    this.servicesWithDuplicateName = new ArrayList();
  }

  boolean isServiceNameInUseGlobally( String name ) {
    return this.servicesByGloballyUniqueName.containsKey( name );
  }

  ServiceImpl getServiceByGloballyUniqueName( String name )
  {
    if ( name == null )
      return null;

    return this.servicesByGloballyUniqueName.get( name );
  }

  void addService( ServiceImpl service )
  {
    if ( service == null )
      return;

    if ( this.servicesByGloballyUniqueName.containsKey( service.getName() ) )
    {
      // Duplicate name.
      boolean success = this.servicesWithDuplicateName.add( service );
      assert success;
      return;
    }
    else
    {
      ServiceImpl replacedService = this.servicesByGloballyUniqueName.put( service.getName(), service );
      assert null == replacedService;
    }
  }

  boolean removeService( ServiceImpl service )
  {
    if ( service == null )
      return false;

    if ( this.servicesWithDuplicateName.remove( service ))
      return true;

    if ( this.servicesByGloballyUniqueName.containsValue( service ))
    {
      ServiceImpl removedService = this.servicesByGloballyUniqueName.remove( service.getName() );
      assert service == removedService;
      boolean promoted = this.promoteFirstServiceWithDuplicateName( service.getName() );
      //assert promoted;
      return true;
    }

    return false;
  }

  private boolean promoteFirstServiceWithDuplicateName( String name )
  {
    for ( ServiceImpl service : this.servicesWithDuplicateName )
    {
      if ( service.getName().equals( name ) )
      {
        boolean success = this.servicesWithDuplicateName.remove( service );
        assert success;
        ServiceImpl replacedService = this.servicesByGloballyUniqueName.put( service.getName(), service );
        assert null == replacedService;
        return true;
      }
    }
    return false;
  }

  boolean isEmpty() {
    return this.servicesByGloballyUniqueName.isEmpty();
  }

  int numberOfServicesWithGloballyUniqueNames() {
    return this.servicesByGloballyUniqueName.size();
  }

  int numberOfServicesWithDuplicateNames() {
    return this.servicesWithDuplicateName.size();
  }

  /**
   * Helper method that checks for duplicate service names. Used by CatalogBuilder.isBuildable() and
   * ServiceBuilder.isBuildable().
   *
   * @param responsibleBuilder the ThreddsBuilder which called this helper method.
   * @return true if no issues, false otherwise.
   */
  BuilderIssues getIssues( ThreddsBuilder responsibleBuilder )
  {
    BuilderIssues issues = new BuilderIssues();

    // Check subordinates.
    if ( ! this.servicesWithDuplicateName.isEmpty())
      for ( ServiceImpl s : this.servicesWithDuplicateName )
        issues.addIssue( BuilderIssue.Severity.WARNING, "Catalog contains duplicate service name [" + s.getName() + "].", responsibleBuilder, null );

    return issues;
  }
}