content: /*
   * Copyright (C) 2012-2023 52°North Spatial Information Research GmbH
   *
   * This program is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License version 2 as published
   * by the Free Software Foundation.
   *
   * If the program is linked with libraries which are licensed under one of
   * the following licenses, the combination of the program with the linked
   * library is not considered a "derivative work" of the program:
   *
   *     - Apache License, version 2.0
   *     - Apache Software License, version 1.0
   *     - GNU Lesser General Public License, version 3
   *     - Mozilla Public License, versions 1.0, 1.1 and 2.0
   *     - Common Development and Distribution License (CDDL), version 1.0
   *
   * Therefore the distribution of the program linked with libraries licensed
   * under the aforementioned licenses, is permitted by the copyright holders
   * if the distribution is compliant with both the GNU General Public
   * License version 2 and the aforementioned licenses.
   *
   * This program 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 General
   * Public License for more details.
   */
  package org.n52.sos.ds.procedure.enrich;
  
  import java.net.MalformedURLException;
  
  import org.n52.janmayen.http.MediaTypes;
  import org.n52.shetland.ogc.gml.ReferenceType;
  import org.n52.shetland.ogc.ows.exception.CodedException;
  import org.n52.shetland.ogc.ows.exception.OwsExceptionReport;
  import org.n52.shetland.ogc.sos.Sos1Constants;
  import org.n52.shetland.ogc.sos.Sos2Constants;
  import org.n52.shetland.ogc.sos.SosConstants;
  import org.n52.shetland.ogc.sos.SosProcedureDescription;
  import org.n52.sos.ds.procedure.AbstractProcedureCreationContext;
  import org.n52.sos.util.SosHelper;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.google.common.base.Strings;
  
  /**
   * Enrich {@link SosProcedureDescription} with typeOf information
   *
   * @author <a href="mailto:c.hollmann@52north.org">Carsten Hollmann</a>
   * @since 4.4.0
   *
   */
  public class TypeOfEnrichment extends ProcedureDescriptionEnrichment {
  
      private static final Logger LOGGER = LoggerFactory.getLogger(TypeOfEnrichment.class);
  
      private static final String ERROR_URL_ENCODING = "Error while encoding DescribeSensor URL!";
  
      private String typeOfIdentifier;
  
      private String typeOfFormat;
  
      public TypeOfEnrichment(AbstractProcedureCreationContext ctx) {
          super(ctx);
      }
  
      @Override
      public void enrich() throws OwsExceptionReport {
          if (isSetTypeOf()) {
              setTypeOfReferenceType(getDescription());
          }
      }
  
      @Override
      public boolean isApplicable() {
          return super.isApplicable() && isSetTypeOf();
      }
  
      private SosProcedureDescription<?> setTypeOfReferenceType(SosProcedureDescription<?> description)
              throws OwsExceptionReport {
          String href = createKvpDescribeSensorOrReturnIdentifier(getTypeOfIdentifier(), getTypeOfFormat());
          description.setTypeOf(new ReferenceType(href, getTypeOfIdentifier()));
          return description;
      }
  
      public TypeOfEnrichment setTypeOfIdentifier(String typeOfIdentifier) {
          this.typeOfIdentifier = typeOfIdentifier;
          return this;
      }
  
      private String getTypeOfIdentifier() {
          return typeOfIdentifier;
      }
  
      public TypeOfEnrichment setTypeOfFormat(String typeOfFormat) {
          this.typeOfFormat = typeOfFormat;
          return this;
      }
  
      private String getTypeOfFormat() {
          return typeOfFormat;
      }
  
      private boolean isSetTypeOf() {
          return isSetTypeOfIdentifier() && isSetTypeOfFormat();
      }
  
      private boolean isSetTypeOfIdentifier() {
          return !Strings.isNullOrEmpty(getTypeOfIdentifier());
      }
  
      private boolean isSetTypeOfFormat() {
          return !Strings.isNullOrEmpty(getTypeOfFormat());
      }
  
      private String createKvpDescribeSensorOrReturnIdentifier(String identifier, String format) throws CodedException {
          if (getProcedureCreationContext().getBindingRepository().isBindingSupported(MediaTypes.APPLICATION_KVP)) {
              final String version = getProcedureCreationContext().getServiceOperatorRepository()
                      .isVersionSupported(SosConstants.SOS, Sos2Constants.SERVICEVERSION) ? Sos2Constants.SERVICEVERSION
                              : Sos1Constants.SERVICEVERSION;
              try {
                  return SosHelper.getDescribeSensorUrl(version, getProcedureCreationContext().getServiceURL(),
                          identifier, format).toString();
              } catch (MalformedURLException murle) {
                  LOGGER.error(ERROR_URL_ENCODING, murle);
              }
          }
          return identifier;
      }
  
  }
  