org.kawanfw.sql.api.server.util.UsernameConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aceql-http Show documentation

AceQL HTTP is a framework of REST like http APIs that allow to access to remote SQL databases over http from any device that supports http. AceQL HTTP is provided with four client SDK: - The AceQL C# Client SDK allows to wrap the HTTP APIs using Microsoft SQL Server like calls in their code, just like they would for a local database. - The AceQL Java Client SDK allows to wrap the HTTP APIs using JDBC calls in their code, just like they would for a local database. - The AceQL Python Client SDK allows SQL calls to be encoded with standard unmodified DB-API 2.0 syntax

There is a newer version: 12.2

Show newest version

/*
 * Copyright (c)2022 KawanSoft S.A.S. All rights reserved.
 * 
 * Use of this software is governed by the Business Source License included
 * in the LICENSE.TXT file in the project's root directory.
 *
 * Change Date: 2026-11-01
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by version 2.0 of the Apache License.
 */
package org.kawanfw.sql.api.server.util;

import java.util.Objects;

import org.kawanfw.sql.api.server.DefaultDatabaseConfigurator;

/**
 * Usernames must be converted by replacing Windows characters, because they are
 * used as directory names when uploading/downloading Blobs. 

 * Thus following characters are replaced for each username when reading/writing
 * on file system:
 *
 *  * 
< : __ac_lt__
> : __ac_gt__
: : __ac_colon__
" : __ac_dbquote__
/ : __ac_fslash__
\ : __ac_bslash__
| : __ac_vbar__
? : __ac_qmark__
∗ : __ac_aster__
 
 * 
 *
 * Spaces are also replaced with {@code __ac_sp__}.
 * @see DefaultDatabaseConfigurator#getBlobsDirectory(String)
 * @author Nicolas de Pomereu
 * @since 5.0.2
 *
 */
public class UsernameConverter {

    private static final String AC_ASTER = "__ac_aster__";
    private static final String AC_QMARK = "__ac_qmark__";
    private static final String AC_VBAR = "__ac_vbar__";
    private static final String AC_BSLASH = "__ac_bslash__";
    private static final String AC_FSLASH = "__ac_fslash__";
    private static final String AC_DBQUOTE = "__ac_dbquote__";
    private static final String AC_COLON = "__ac_colon__";
    private static final String AC_GT = "__ac_gt__";
    private static final String AC_LT = "__ac_lt__";
    private static final String AC_SP = "__ac_sp__";

    /**
     * Protected class
     */
    protected UsernameConverter() {

    }

    /**
     * Replace back space and specials characters forbidden in Windows file name
     * from ASCII string.
     *
     * @param stringParm the string with replaced characters
     * @return the string with original spaces and Windows characters
     */
    public static String toSpecialChars(final String stringParm) {
	String string = stringParm.replace(AC_SP, " ");
	string = string.replace(AC_LT, "<");
	string = string.replace(AC_GT, ">");
	string = string.replace(AC_COLON, ":");
	string = string.replace(AC_DBQUOTE, "\"");
	string = string.replace(AC_FSLASH, "/");
	string = string.replace(AC_BSLASH, "\\");
	string = string.replace(AC_VBAR, "|");
	string = string.replace(AC_QMARK, "?");
	string = string.replace(AC_ASTER, "*");
	return string;
    }

    /**
     * Replace Windows special character and spaces by clear ASCII text
     *
     * @param stringParm the string to replace from the Windows special characters
     * @return the string without special Windows characters
     */
    public static String fromSpecialChars(final String stringParm) {
	if (stringParm == null) {
	    Objects.requireNonNull(stringParm, "stringParm cannot be null!");
	}

	String string = stringParm.replace(" ", AC_SP);
	string = string.replace("<", AC_LT);
	string = string.replace(">", AC_GT);
	string = string.replace(":", AC_COLON);
	string = string.replace("\"", AC_DBQUOTE);
	string = string.replace("/", AC_FSLASH);
	string = string.replace("\\", AC_BSLASH);
	string = string.replace("|", AC_VBAR);
	string = string.replace("?", AC_QMARK);
	string = string.replace("*", AC_ASTER);

	return string;

    }

}