View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.crypto.hash.format;
20  
21  import java.util.Locale;
22  
23  /**
24   * An enum representing Shiro's default provided {@link HashFormat} implementations.
25   *
26   * @since 1.2
27   */
28  public enum ProvidedHashFormat {
29  
30      /**
31       * Value representing the {@link HexFormat} implementation.
32       */
33      HEX(HexFormat.class),
34  
35      /**
36       * Value representing the {@link Base64Format} implementation.
37       */
38      BASE64(Base64Format.class),
39  
40      /**
41       * Value representing the {@link Shiro1CryptFormat} implementation.
42       */
43      SHIRO1(Shiro1CryptFormat.class);
44  
45      private final Class<? extends HashFormat> clazz;
46  
47      private ProvidedHashFormat(Class<? extends HashFormat> clazz) {
48          this.clazz = clazz;
49      }
50  
51      Class<? extends HashFormat> getHashFormatClass() {
52          return this.clazz;
53      }
54  
55      public static ProvidedHashFormat byId(String id) {
56          if (id == null) {
57              return null;
58          }
59          try {
60              // Use English Locale, some Locales handle uppercase/lower differently. i.e. Turkish and upper case 'i'
61              // is not 'I'. And 'SHIRO1' would be 'SHÄ°RO1'
62              return valueOf(id.toUpperCase(Locale.ENGLISH));
63          } catch (IllegalArgumentException ignored) {
64              return null;
65          }
66      }
67  
68  }