001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.logger;
018
019import static org.apache.juneau.commons.utils.Utils.*;
020
021/**
022 * Represents the amount of detail to include in a log entry for HTTP requests and responses.
023 *
024 * <h5 class='section'>See Also:</h5><ul>
025 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerLoggingAndDebugging">Logging / Debugging</a>
026 * </ul>
027 */
028public enum CallLoggingDetail {
029
030   /**
031    * Lowest detail - Log only the request and response status lines.
032    */
033   STATUS_LINE,
034
035   /**
036    * Medium detail - Log status lines and also headers.
037    */
038   HEADER,
039
040   /**
041    * Highest detail - Log status lines, headers, and bodies if available.
042    */
043   ENTITY;
044
045   /**
046    * Retrieves this enum using case-insensitive matching.
047    *
048    * @param s The enum name to resolve.
049    * @return The resolved value.
050    */
051   public static CallLoggingDetail fromString(String s) {
052      if (ne(s)) {
053         try {
054            return valueOf(s.toUpperCase());
055         } catch (@SuppressWarnings("unused") IllegalArgumentException e) {}
056      }
057      return null;
058   }
059
060   boolean isOneOf(CallLoggingDetail...values) {
061      for (var v : values)
062         if (v == this)
063            return true;
064      return false;
065   }
066}