Java String Encode encodeJobHistoryFileName(String logFileName)

Description

Helper function to encode the URL of the filename of the job-history log file.

License

Apache License

Parameter

Parameter	Description
logFileName	file name of the job-history file

Exception

Parameter	Description
IOException	an exception

Return

URL encoded filename

Declaration

public static String encodeJobHistoryFileName(String logFileName)
        throws IOException 

Method Source Code

//package com.java2s;
/**/* ww w  .  j  av a  2 s.c o  m*/
 * 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.
 */

import java.io.IOException;
import java.io.UnsupportedEncodingException;

import java.net.URLEncoder;

public class Main {
    static final String DELIMITER_ESCAPE = "%2D";

    /**
     * Helper function to encode the URL of the filename of the job-history 
     * log file.
     * 
     * @param logFileName file name of the job-history file
     * @return URL encoded filename
     * @throws IOException
     */
    public static String encodeJobHistoryFileName(String logFileName)
            throws IOException {
        String replacementDelimiterEscape = null;

        // Temporarily protect the escape delimiters from encoding
        if (logFileName.contains(DELIMITER_ESCAPE)) {
            replacementDelimiterEscape = nonOccursString(logFileName);

            logFileName = logFileName.replaceAll(DELIMITER_ESCAPE,
                    replacementDelimiterEscape);
        }

        String encodedFileName = null;
        try {
            encodedFileName = URLEncoder.encode(logFileName, "UTF-8");
        } catch (UnsupportedEncodingException uee) {
            IOException ioe = new IOException();
            ioe.initCause(uee);
            ioe.setStackTrace(uee.getStackTrace());
            throw ioe;
        }

        // Restore protected escape delimiters after encoding
        if (replacementDelimiterEscape != null) {
            encodedFileName = encodedFileName.replaceAll(
                    replacementDelimiterEscape, DELIMITER_ESCAPE);
        }

        return encodedFileName;
    }

    static String nonOccursString(String logFileName) {
        int adHocIndex = 0;

        String unfoundString = "q" + adHocIndex;

        while (logFileName.contains(unfoundString)) {
            unfoundString = "q" + ++adHocIndex;
        }

        return unfoundString + "q";
    }
}

Related

1. encodeFilename(String filename, String encoding)
2. encodeFilenameOmittingWhiteSpaces(String filename, String encoding)
3. encodeForm(Map form)
4. encodeIncludingSpecialCharacters(String toEncode)
5. encodeInternally(String s)
6. encodeMap(Map map, String enc)
7. encodeName(final String name)
8. encodeName(String createdName)
9. encodeParameter(String key, String value)