/*
    * 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.syncope.common.lib.to;
  
  import java.util.Collection;
  import org.apache.commons.lang3.StringUtils;
  import org.apache.commons.lang3.builder.ToStringBuilder;
  import org.apache.syncope.common.lib.BaseBean;
  import org.apache.syncope.common.lib.types.ResourceOperation;
  import org.apache.syncope.common.lib.types.TraceLevel;
  
  public class ProvisioningReport implements BaseBean {
  
      private static final long serialVersionUID = 9201119472070963385L;
  
      public enum Status {
  
          SUCCESS,
          IGNORE,
          FAILURE
  
      }
  
      private String message;
  
      private Status status;
  
      private String anyType;
  
      private ResourceOperation operation;
  
      private String key;
  
      private String name;
  
      private String uidValue;
  
      public String getMessage() {
          return message;
      }
  
      public void setMessage(final String message) {
          this.message = message;
      }
  
      public String getName() {
          return name;
      }
  
      public void setName(final String name) {
          this.name = name;
      }
  
      public String getKey() {
          return key;
      }
  
      public void setKey(final String key) {
          this.key = key;
      }
  
      public Status getStatus() {
          return status;
      }
  
      public void setStatus(final Status status) {
          this.status = status;
      }
  
      public String getAnyType() {
          return anyType;
      }
  
      public void setAnyType(final String anyType) {
          this.anyType = anyType;
      }
  
      public ResourceOperation getOperation() {
          return operation;
      }
  
      public void setOperation(final ResourceOperation operation) {
          this.operation = operation;
     }
 
     public String getUidValue() {
         return uidValue;
     }
 
     public void setUidValue(final String uidValue) {
         this.uidValue = uidValue;
     }
 
     /**
      * Human readable report string, using the given trace level.
      *
      * @param level trace level
      * @return String for certain levels, null for level NONE
      */
     public String getReportString(final TraceLevel level) {
         if (level == TraceLevel.SUMMARY) {
             // No per entry log in this case.
             return null;
         } else if (level == TraceLevel.FAILURES && status == Status.FAILURE) {
             // only report failures
             return String.format("Failed %s (key/name): %s/%s with message: %s", operation, key, name, message);
         } else {
             // All
             return String.format("%s %s (key/name): %s/%s %s", operation, status, key, name,
                     StringUtils.isBlank(message)
                     ? ""
                     : "with message: " + message);
         }
     }
 
     /**
      * Helper method to invoke logging per provisioning result, for the given trace level.
      *
      * @param results provisioning results
      * @param level trace level
      * @return report as string
      */
     public static String generate(final Collection<ProvisioningReport> results, final TraceLevel level) {
         StringBuilder sb = new StringBuilder();
         results.forEach(result -> sb.append(result.getReportString(level)).append('\n'));
         return sb.toString();
     }
 
     @Override
     public String toString() {
         return new ToStringBuilder(this).
                 append(message).
                 append(status).
                 append(anyType).
                 append(operation).
                 append(key).
                 append(name).
                 append(uidValue).
                 build();
     }
 }