View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.pattern;
18  
19  import java.util.UUID;
20  
21  import org.apache.logging.log4j.core.LogEvent;
22  import org.apache.logging.log4j.core.config.plugins.Plugin;
23  import org.apache.logging.log4j.core.helpers.UUIDUtil;
24  
25  /**
26   * Formats the event sequence number.
27   */
28  @Plugin(name = "UUIDPatternConverter", category = "Converter")
29  @ConverterKeys({"u", "uuid" })
30  public final class UUIDPatternConverter extends LogEventPatternConverter {
31  
32      private final boolean isRandom;
33  
34      /**
35       * Private constructor.
36       */
37      private UUIDPatternConverter(final boolean isRandom) {
38          super("u", "uuid");
39          this.isRandom = isRandom;
40      }
41  
42      /**
43       * Obtains an instance of SequencePatternConverter.
44       *
45       * @param options options, currently ignored, may be null.
46       * @return instance of SequencePatternConverter.
47       */
48      public static UUIDPatternConverter newInstance(final String[] options) {
49          if (options.length == 0) {
50              return new UUIDPatternConverter(false);
51          }
52  
53          if (options.length > 1 || (!options[0].equalsIgnoreCase("RANDOM") && !options[0].equalsIgnoreCase("Time"))) {
54              LOGGER.error("UUID Pattern Converter only accepts a single option with the value \"RANDOM\" or \"TIME\"");
55          }
56          return new UUIDPatternConverter(options[0].equalsIgnoreCase("RANDOM"));
57      }
58  
59      /**
60       * {@inheritDoc}
61       */
62      @Override
63      public void format(final LogEvent event, final StringBuilder toAppendTo) {
64          final UUID uuid = isRandom ? UUID.randomUUID() : UUIDUtil.getTimeBasedUUID();
65          toAppendTo.append(uuid.toString());
66      }
67  }