springfox.documentation.spring.web.ControllerNamingUtils.java Source code

Introduction

Here is the source code for springfox.documentation.spring.web.ControllerNamingUtils.java

Source

/*
 *
 *  Copyright 2015 the original author or authors.
 *
 *  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
 *
 *         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 springfox.documentation.spring.web;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.Assert;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.util.UriUtils;

import java.io.UnsupportedEncodingException;

import static springfox.documentation.spring.web.paths.Paths.splitCamelCase;

public class ControllerNamingUtils {
    private static Logger log = LoggerFactory.getLogger(ControllerNamingUtils.class);
    private static final String ISO_8859_1 = "ISO-8859-1";

    public static String pathRoot(String requestPattern) {
        Assert.notNull(requestPattern);
        Assert.hasText(requestPattern);
        log.info("Resolving path root for {}", requestPattern);
        requestPattern = requestPattern.startsWith("/") ? requestPattern : "/" + requestPattern;
        int idx = requestPattern.indexOf("/", 1);
        if (idx > -1) {
            return requestPattern.substring(0, idx);
        }
        return requestPattern;
    }

    public static String pathRootEncoded(String requestPattern) {
        return encode(pathRoot(requestPattern));
    }

    public static String encode(String path) {
        try {
            path = UriUtils.encodePath(path, ISO_8859_1);
        } catch (UnsupportedEncodingException e) {
            log.error("Could not encode:" + path, e);
        }
        return path;
    }

    public static String decode(String path) {
        try {
            path = UriUtils.decode(path, ISO_8859_1);
        } catch (Exception e) {
            log.error("Could not decode:" + path, e);
        }
        return path;
    }

    public static String controllerNameAsGroup(HandlerMethod handlerMethod) {
        Class<?> controllerClass = handlerMethod.getBeanType();
        return splitCamelCase(controllerClass.getSimpleName(), "-").replace("/", "").toLowerCase();
    }
}