/*
* 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.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 host name of the current server.
Author: Sergio del Amo Since: 1.2.0
/**
* Resolves the host name of the current server.
*
* @author Sergio del Amo
* @since 1.2.0
*/
@DefaultImplementation(DefaultHttpHostResolver.class)
public interface HttpHostResolver {
Returns the host of the current server with
protocol, host name, and an optional port.
Params: - request – The current request
Returns: The host information
/**
* Returns the host of the current server with
* protocol, host name, and an optional port.
*
* @param request The current request
* @return The host information
*/
@NonNull
String resolve(@Nullable HttpRequest request);
}