ambari-views/src/main/java/org/apache/ambari/view/Masker.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.ambari.view;

/**
 * Masker for view parameters.
 */
public interface Masker {

  /**
   * Get a masked version of the given string.
   *
   * @param value the value to be masked
   * @return the masked value
   * @throws MaskException error happened during masking process
   */
  public String mask(String value) throws MaskException;

  /**
   * Get the original string from a masked string.
   *
   * @param value the value to be unmasked
   * @return the unmasked value
   * @throws MaskException error happened during unmasking process
   */
  public String unmask(String value) throws MaskException;
}