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 org.apache.shiro.crypto.hash.Hash;
22  
23  /**
24   * A {@code ParsableHashFormat} is able to parse a formatted string and convert it into a {@link Hash} instance.
25   * <p/>
26   * This interface exists to represent {@code HashFormat}s that can offer two-way conversion
27   * (Hash -&gt; String, String -&gt; Hash) capabilities.  Some HashFormats, such as many {@link ModularCryptFormat}s
28   * (like Unix Crypt(3)) only support one way conversion and therefore wouldn't implement this interface.
29   *
30   * @see Shiro1CryptFormat
31   *
32   * @since 1.2
33   */
34  public interface ParsableHashFormat extends HashFormat {
35  
36      /**
37       * Parses the specified formatted string and returns the corresponding Hash instance.
38       *
39       * @param formatted the formatted string representing a Hash.
40       * @return the corresponding Hash instance.
41       */
42      Hash parse(String formatted);
43  }