content: /*
   *  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.causeway.core.metamodel.facets.properties.property.entitychangepublishing;
  
  import org.apache.causeway.applib.annotation.Publishing;
  import org.apache.causeway.applib.value.Blob;
  import org.apache.causeway.applib.value.Clob;
  import org.apache.causeway.core.metamodel.facetapi.Facet;
  import org.apache.causeway.core.metamodel.spec.feature.OneToOneAssociation;
  
  import org.jspecify.annotations.NonNull;
  
  /**
   * Indicates whether a property should be excluded from entity change publishing (auditing).
   * @since 2.0
   */
  public interface EntityPropertyChangePublishingPolicyFacet extends Facet {
  
      /**
       * Must be one of Publishing.ENABLED or Publishing.DISABLED.
       */
      @NonNull Publishing getEntityChangePublishing();
  
      default boolean isPublishingVetoed() {
          return getEntityChangePublishing() == Publishing.DISABLED;
      }
  
      default boolean isPublishingAllowed() {
          return getEntityChangePublishing() == Publishing.ENABLED;
      }
  
      static boolean isExcludedFromPublishing(final @NonNull OneToOneAssociation property) {
  
          var policyFacetIfAny = property
                  .lookupFacet(EntityPropertyChangePublishingPolicyFacet.class);
  
          var typeOf = property.getElementType().getCorrespondingClass();
          if(Blob.class.equals(typeOf)
                  || Clob.class.equals(typeOf)) {
  
              var isExplictlyAllowed = policyFacetIfAny
                      .map(EntityPropertyChangePublishingPolicyFacet::isPublishingAllowed)
                      .orElse(false);
  
              //XXX CAUSEWAY-1488, exclude Bob/Clob from property change publishing unless explicitly allowed
              return !isExplictlyAllowed;
          }
  
          return policyFacetIfAny
                  .map(EntityPropertyChangePublishingPolicyFacet::isPublishingVetoed)
                  .orElse(false);
      }
  
  }
  