com.ebay.ejmask.api.MaskingPattern Maven / Gradle / Ivy
package com.ebay.ejmask.api;
/**
* Copyright (c) 2023 eBay Inc.
*
* Licensed 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
*
* https://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.
*/
import java.util.Objects;
import java.util.regex.Pattern;
/**
* Encapsulation for masking pattern
*
* @author prakv
*/
public class MaskingPattern implements Comparable {
private final int order;
private final Pattern pattern;
private final String replacement;
/**
* Create new instance of MaskPattern
*
* @param order as order of this filter in chain
* @param regex as value to be replaced
* @param replacement value replaced with
*/
public MaskingPattern(int order, String regex, String replacement) {
this.order = order;
this.pattern = Pattern.compile(regex);
this.replacement = replacement;
}
/**
* Replace sensitive data with mask
*
* @param data as string with sensitive data
* @return clean data
*/
public String replaceAll(String data) {
return this.pattern.matcher(data).replaceAll(this.replacement);
}
/**
* Compare the given object this for sorting
*
* @param that the other pattern
* @return 1 of this is having higher order and -1 else
*/
@Override
public int compareTo(MaskingPattern that) {
if (that.order == this.order) {
if (that.pattern.pattern().length() == this.pattern.pattern().length()) {
return 0;
}
//one with more filters can go to the top
return (that.pattern.pattern().length() > this.pattern.pattern().length()) ? -1 : 1;
}
return that.order > this.order ? -1 : 1;
}
/**
* Indicates whether some other object is "equal to" this one.
*
* @param obj the reference object with which to compare.
* @return {@code true} if this object is the same as the obj
* argument; {@code false} otherwise.
*/
@Override
public boolean equals(Object obj) {
if (!(obj instanceof MaskingPattern)) {
return false;
}
MaskingPattern that = (MaskingPattern) obj;
return this.order == that.order
&& Objects.equals(this.replacement, that.replacement)
&& Objects.equals(this.pattern, that.pattern);
}
/**
* Returns the hash code of the given instance
*
* @return the hash code of this object.
* @see Object#hashCode
*/
@Override
public int hashCode() {
return Objects.hashCode(this);
}
/**
* Returns the string representation of this pattern.
*
* @return The string representation of this pattern
*/
@Override
public String toString() {
return "order=" + this.order + ";pattern=" + this.pattern.pattern() + ";replacement=" + this.replacement;
}
/**
* Get the value of order
*
* @return the value of order
*/
public int getOrder() { return order; }
/**
* Get the value of pattern
*
* @return the value of pattern
*/
public Pattern getPattern() { return pattern; }
/**
* Get the value of replacement
*
* @return the value of replacement
*/
public String getReplacement() { return replacement; }
}