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  /**
22   * An enum representing Shiro's default provided {@link HashFormat} implementations.
23   *
24   * @since 1.2
25   */
26  public enum ProvidedHashFormat {
27  
28      /**
29       * Value representing the {@link HexFormat} implementation.
30       */
31      HEX(HexFormat.class),
32  
33      /**
34       * Value representing the {@link Base64Format} implementation.
35       */
36      BASE64(Base64Format.class),
37  
38      /**
39       * Value representing the {@link Shiro1CryptFormat} implementation.
40       */
41      SHIRO1(Shiro1CryptFormat.class);
42  
43      private final Class<? extends HashFormat> clazz;
44  
45      private ProvidedHashFormat(Class<? extends HashFormat> clazz) {
46          this.clazz = clazz;
47      }
48  
49      Class<? extends HashFormat> getHashFormatClass() {
50          return this.clazz;
51      }
52  
53      public static ProvidedHashFormat byId(String id) {
54          if (id == null) {
55              return null;
56          }
57          try {
58              return valueOf(id.toUpperCase());
59          } catch (IllegalArgumentException ignored) {
60              return null;
61          }
62      }
63  
64  }