io.micronaut.http.cookie.ServerCookieEncoder Maven / Gradle / Ivy

Go to download

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

Natively Cloud Native

The newest version!

/*
 * Copyright 2017-2024 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.cookie;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.io.service.ServiceDefinition;
import io.micronaut.core.io.service.SoftServiceLoader;

import java.util.List;

/**
 * API to encode a {@link Cookie} in an HTTP Server.
 * The encoded string is typically used to set the value of the Set-Cookie header.
 * @author Sergio del Amo
 * @since 4.3.0
 */
@FunctionalInterface
public interface ServerCookieEncoder {

    /**
     * The default {@link ServerCookieEncoder} instance.
     */
    ServerCookieEncoder INSTANCE = SoftServiceLoader
            .load(ServerCookieEncoder.class)
            .firstOr("io.micronaut.http.cookie.DefaultServerCookieEncoder", ServerCookieEncoder.class.getClassLoader())
            .map(ServiceDefinition::load)
            .orElse(null);

    /**
     *
     * @param cookies Cookies to encode
     * @return Returns a string representation for each supplied cookie. The string representation is typically used as the value of the {@link io.micronaut.http.HttpHeaders#SET_COOKIE} header.
     */
    @NonNull
    List encode(@NonNull Cookie... cookies);
}