io.micronaut.http.server.util.HttpClientAddressResolver Maven / Gradle / Ivy

Go to download

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

Core components supporting the Micronaut Framework

There is a newer version: 4.6.5

Show newest version

/*
 * 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
 *
 * 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 io.micronaut.http.server.util;

import io.micronaut.context.annotation.DefaultImplementation;
import io.micronaut.http.HttpRequest;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * Resolves the client IP address from the request.
 *
 * @author James Kleeh
 * @since 1.2.0
 */
@DefaultImplementation(DefaultHttpClientAddressResolver.class)
public interface HttpClientAddressResolver {

    /**
     * @param request The current request
     * @return The client address
     */
    @Nullable
    String resolve(@NonNull HttpRequest request);

}