io.micronaut.http.bind.binders.PathVariableAnnotationBinder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 original 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
 *
 * 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.
 */
package io.micronaut.http.bind.binders;

import io.micronaut.core.annotation.AnnotationMetadata;
import io.micronaut.core.bind.annotation.AbstractArgumentBinder;
import io.micronaut.core.convert.ArgumentConversionContext;
import io.micronaut.core.convert.ConversionService;
import io.micronaut.core.convert.value.ConvertibleMultiValues;
import io.micronaut.core.convert.value.ConvertibleValues;
import io.micronaut.core.type.Argument;
import io.micronaut.http.HttpAttributes;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.annotation.PathVariable;
import io.micronaut.http.uri.UriMatchInfo;
import io.micronaut.http.uri.UriMatchVariable;

import java.util.Collections;
import java.util.Optional;

/**
 * Used for binding a parameter exclusively from a path variable.
 *
 * @param 
 * @author graemerocher
 * @see PathVariable
 * @since 1.0.3
 */
public class PathVariableAnnotationBinder extends AbstractArgumentBinder implements AnnotatedRequestArgumentBinder {

    /**
     * @param conversionService The conversion service
     */
    public PathVariableAnnotationBinder(ConversionService conversionService) {
        super(conversionService);
    }

    @Override
    public Class getAnnotationType() {
        return PathVariable.class;
    }

    @Override
    public BindingResult bind(ArgumentConversionContext context, HttpRequest source) {
        ConvertibleMultiValues parameters = source.getParameters();
        Argument argument = context.getArgument();

        AnnotationMetadata annotationMetadata = argument.getAnnotationMetadata();
        String parameterName = annotationMetadata.stringValue(PathVariable.class).orElse(argument.getName());
        // If we need to bind all request params to command object
        // checks if the variable is defined with modifier char *
        // e.g. ?pojo*
        final Optional matchInfo = source.getAttribute(HttpAttributes.ROUTE_MATCH, UriMatchInfo.class);
        boolean bindAll = matchInfo
            .flatMap(umi -> umi.getVariables()
                .stream()
                .filter(v -> v.getName().equals(parameterName))
                .findFirst()
                .map(UriMatchVariable::isExploded)).orElse(false);

        final ConvertibleValues