5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * The contents of this file are subject to the terms
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * of the Common Development and Distribution License
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * (the License). You may not use this file except in
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * compliance with the License.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * You can obtain a copy of the License at
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * opensso/legal/CDDLv1.0.txt
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * See the License for the specific language governing
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * permission and limitations under the License.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * When distributing Covered Code, include this CDDL
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Header Notice in each file and include the License file
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * at opensso/legal/CDDLv1.0.txt.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * If applicable, add the following below the CDDL Header,
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * with the fields enclosed by brackets [] replaced by
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * your own identifying information:
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * $Id: StringUtils.java,v 1.3 2009/11/20 00:30:40 exu Exp $
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
8808515820f87041605d89a6c044a259567569f4Peter Major * Portions Copyrighted 2014 ForgeRock AS.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterpackage com.sun.identity.shared;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
8808515820f87041605d89a6c044a259567569f4Peter Majorimport java.util.regex.Matcher;
8808515820f87041605d89a6c044a259567569f4Peter Major
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * This class provides string related helper methods.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterpublic class StringUtils {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster // ampersand character '&'
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster public static final String AMPERSAND = "&";
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster // HTML escape code for character '&'
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster public static final String ESCAPE_AMPERSAND = "&";
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster // character '|' used as property value delimiter
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster public static final String PROPERTY_VALUE_DELIMITER = "|";
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster // HTML escape code for character '|'
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster public static final String ESCAPE_DELIMITER = "|";
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster private StringUtils() {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster /**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Returns substituted string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * @param orig Original string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * @param pattern String substitution matching pattern.
8808515820f87041605d89a6c044a259567569f4Peter Major * @param str The literal string to replace the pattern with.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * @return substituted string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
8808515820f87041605d89a6c044a259567569f4Peter Major public static String strReplaceAll(String orig, String pattern, String str) {
8808515820f87041605d89a6c044a259567569f4Peter Major return orig.replaceAll(pattern, Matcher.quoteReplacement(str));
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster /**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Returns special character escaped string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * @param value original string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * @return special character escaped string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster public static String getEscapedValue(String value) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster if (value != null) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster return value.replaceAll(AMPERSAND, ESCAPE_AMPERSAND).replaceAll(
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster "\\" + PROPERTY_VALUE_DELIMITER, ESCAPE_DELIMITER);
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster return null;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster /**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Returns special character un-escaped string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * @param value special character escaped string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * @return un-escaped string.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster public static String getUnescapedValue(String value) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster if (value != null) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster return value.replaceAll(ESCAPE_DELIMITER, PROPERTY_VALUE_DELIMITER). replaceAll(ESCAPE_AMPERSAND, AMPERSAND);
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster return null;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster}