org.thymeleaf.spring5.web.webflux.ISpringWebFluxWebExchange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-spring5 Show documentation
Modern server-side Java template engine for both web and standalone environments
The newest version!
/*
 * =============================================================================
 *
 *   Copyright (c) 2011-2021, The THYMELEAF team (http://www.thymeleaf.org)
 *
 *   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 org.thymeleaf.spring5.web.webflux;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

import org.thymeleaf.util.Validate;
import org.thymeleaf.web.IWebExchange;

/**
 * 
 *   Spring WebFlux-based interface for a web exchange.
 * 
 * 
 *   Note {@link #getSession()} and {@link #getPrincipal()} might return null not only if they are
 *   indeed null, but also if they have not yet been resolved. These structures are declared as {@code Mono}
 *   in WebFlux exchange and request structures, and will only be resolved just before the rendering of the view starts.
 * 
 *
 * @author Daniel Fernández
 *
 * @since 3.1.0
 *
 */
public interface ISpringWebFluxWebExchange extends IWebExchange {


    public ISpringWebFluxWebRequest getRequest();
    public ISpringWebFluxWebSession getSession();
    public ISpringWebFluxWebApplication getApplication();


    public Map getAttributes();

    @Override
    default boolean containsAttribute(final String name) {
        Validate.notNull(name, "Name cannot be null");
        final Map attributes = getAttributes();
        // Attribute map in ServerWebExchange, which does not allow null values. So containsKey is enough
        // to be equivalent to the Servlet implementations (in which null = removal)
        return attributes != null && attributes.containsKey(name);
    }

    @Override
    default int getAttributeCount() {
        final Map attributes = getAttributes();
        return (attributes == null)? 0 : attributes.size();
    }

    @Override
    default Set getAllAttributeNames() {
        final Map attributes = getAttributes();
        return (attributes == null)? Collections.emptySet() : attributes.keySet();
    }

    @Override
    default Map getAttributeMap() {
        return getAttributes();
    }

    @Override
    default Object getAttributeValue(final String name) {
        Validate.notNull(name, "Name cannot be null");
        final Map attributes = getAttributes();
        return (attributes == null)? null : attributes.get(name);
    }


    public Object getNativeExchangeObject();


}