All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.helger.phoss.smp.backend.mongodb.mgr.SMPTransportProfileManagerMongoDB Maven / Gradle / Ivy

There is a newer version: 7.1.6
Show newest version
/*
 * Copyright (C) 2019-2024 Philip Helger and contributors
 * philip[at]helger[dot]com
 *
 * 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.
 */
package com.helger.phoss.smp.backend.mongodb.mgr;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.bson.Document;

import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.CommonsArrayList;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.state.EChange;
import com.helger.commons.string.StringHelper;
import com.helger.peppol.smp.ESMPTransportProfileState;
import com.helger.peppol.smp.ISMPTransportProfile;
import com.helger.peppol.smp.SMPTransportProfile;
import com.helger.phoss.smp.domain.redirect.SMPRedirect;
import com.helger.phoss.smp.domain.transportprofile.ISMPTransportProfileManager;
import com.helger.photon.audit.AuditHelper;
import com.mongodb.client.model.Indexes;
import com.mongodb.client.model.Updates;
import com.mongodb.client.result.DeleteResult;

/**
 * Implementation of {@link ISMPTransportProfileManager} for MongoDB
 *
 * @author Philip Helger
 */
public final class SMPTransportProfileManagerMongoDB extends AbstractManagerMongoDB implements
                                                     ISMPTransportProfileManager
{
  private static final String BSON_ID = "id";
  private static final String BSON_NAME = "name";
  @Deprecated
  private static final String BSON_DEPRECATED = "deprecated";
  private static final String BSON_STATE = "state";

  public SMPTransportProfileManagerMongoDB ()
  {
    super ("smp-transportprofile");
    getCollection ().createIndex (Indexes.ascending (BSON_ID));
  }

  @Nonnull
  @ReturnsMutableCopy
  public static Document toBson (@Nonnull final ISMPTransportProfile aValue)
  {
    return new Document ().append (BSON_ID, aValue.getID ())
                          .append (BSON_NAME, aValue.getName ())
                          .append (BSON_STATE, aValue.getState ().getID ());
  }

  @Nonnull
  @ReturnsMutableCopy
  public static SMPTransportProfile toDomain (@Nonnull final Document aDoc)
  {
    ESMPTransportProfileState eState = null;
    final String sStateID = aDoc.getString (BSON_STATE);
    if (sStateID != null)
      eState = ESMPTransportProfileState.getFromIDOrNull (sStateID);
    if (eState == null)
    {
      final boolean bDeprecated = aDoc.getBoolean (BSON_DEPRECATED, false);
      eState = bDeprecated ? ESMPTransportProfileState.DEPRECATED : ESMPTransportProfileState.ACTIVE;
    }

    return new SMPTransportProfile (aDoc.getString (BSON_ID), aDoc.getString (BSON_NAME), eState);
  }

  @Nullable
  public ISMPTransportProfile createSMPTransportProfile (@Nonnull @Nonempty final String sID,
                                                         @Nonnull @Nonempty final String sName,
                                                         final boolean bIsDeprecated)
  {
    // Double ID needs to be taken care of
    if (containsSMPTransportProfileWithID (sID))
      return null;

    final SMPTransportProfile aSMPTransportProfile = new SMPTransportProfile (sID,
                                                                              sName,
                                                                              bIsDeprecated ? ESMPTransportProfileState.DEPRECATED
                                                                                            : ESMPTransportProfileState.ACTIVE);

    if (!getCollection ().insertOne (toBson (aSMPTransportProfile)).wasAcknowledged ())
      throw new IllegalStateException ("Failed to insert into MongoDB Collection");

    AuditHelper.onAuditCreateSuccess (SMPTransportProfile.OT, sID, sName, Boolean.valueOf (bIsDeprecated));
    return aSMPTransportProfile;
  }

  @Nonnull
  public EChange updateSMPTransportProfile (@Nullable final String sSMPTransportProfileID,
                                            @Nonnull @Nonempty final String sName,
                                            final boolean bIsDeprecated)
  {
    final Document aOldDoc = getCollection ().findOneAndUpdate (new Document (BSON_ID, sSMPTransportProfileID),
                                                                Updates.combine (Updates.set (BSON_NAME, sName),
                                                                                 Updates.set (BSON_DEPRECATED,
                                                                                              Boolean.valueOf (bIsDeprecated))));
    if (aOldDoc == null)
      return EChange.UNCHANGED;

    AuditHelper.onAuditModifySuccess (SMPTransportProfile.OT,
                                      "set-all",
                                      sSMPTransportProfileID,
                                      sName,
                                      Boolean.valueOf (bIsDeprecated));
    return EChange.CHANGED;
  }

  @Nonnull
  public EChange deleteSMPTransportProfile (@Nullable final String sSMPTransportProfileID)
  {
    if (StringHelper.hasNoText (sSMPTransportProfileID))
      return EChange.UNCHANGED;

    final DeleteResult aDR = getCollection ().deleteOne (new Document (BSON_ID, sSMPTransportProfileID));
    if (!aDR.wasAcknowledged () || aDR.getDeletedCount () == 0)
    {
      AuditHelper.onAuditDeleteFailure (SMPRedirect.OT, sSMPTransportProfileID, "no-such-id");
      return EChange.UNCHANGED;
    }
    AuditHelper.onAuditDeleteSuccess (SMPRedirect.OT, sSMPTransportProfileID);
    return EChange.CHANGED;
  }

  @Nonnull
  @ReturnsMutableCopy
  public ICommonsList  getAllSMPTransportProfiles ()
  {
    final ICommonsList  ret = new CommonsArrayList <> ();
    getCollection ().find ().forEach (x -> ret.add (toDomain (x)));
    return ret;
  }

  @Nullable
  public ISMPTransportProfile getSMPTransportProfileOfID (@Nullable final String sID)
  {
    return getCollection ().find (new Document (BSON_ID, sID))
                           .map (SMPTransportProfileManagerMongoDB::toDomain)
                           .first ();
  }

  public boolean containsSMPTransportProfileWithID (@Nullable final String sID)
  {
    return getCollection ().find (new Document (BSON_ID, sID)).first () != null;
  }

  @Nonnegative
  public long getSMPTransportProfileCount ()
  {
    return getCollection ().countDocuments ();
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy