io.micronaut.http.cookie.CookieFactory 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-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.cookie;

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

/**
 * A CookieFactory creates {@link Cookie} instances and should be implemented by a concrete server.
 *
 * @author Graeme Rocher
 * @since 1.0
 */
public interface CookieFactory {

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

    /**
     * Create a new cookie.
     *
     * @param name  The name
     * @param value The value
     * @return A Cookie instance
     */
    Cookie create(String name, String value);
}