com.aspectran.web.activity.request.RequestAttributeMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectran-all Show documentation
Aspectran (All-in-One)
There is a newer version: 8.1.5
/*
 * Copyright (c) 2008-2025 The Aspectran Project
 *
 * 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 com.aspectran.web.activity.request;

import com.aspectran.utils.annotation.jsr305.NonNull;
import com.aspectran.utils.annotation.jsr305.Nullable;
import jakarta.servlet.ServletRequest;

import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

/**
 * Wrapper class for getting attributes from HttpServletRequest().
 *
 * Created: 2018. 9. 15.
 *
 * @since 5.2.0
 */
public final class RequestAttributeMap implements Map {

    private ServletRequest request;

    public ServletRequest getRequest() {
        return request;
    }

    public void setRequest(@NonNull ServletRequest request) {
        this.request = request;
    }

    private void checkState() {
        if (request == null) {
            throw new IllegalStateException("ServletRequest is not specified");
        }
    }

    @Override
    public int size() {
        if (request == null) {
            return 0;
        }
        return Collections.list(request.getAttributeNames()).size();
    }

    @Override
    public boolean isEmpty() {
        if (request == null) {
            return true;
        }
        return !request.getAttributeNames().hasMoreElements();
    }

    @Override
    public boolean containsKey(Object key) {
        if (request == null) {
            return false;
        }
        return (request.getAttribute((String)key) != null);
    }

    @Override
    public boolean containsValue(Object value) {
        if (request == null) {
            return false;
        }
        Enumeration names = request.getAttributeNames();
        while (names.hasMoreElements()) {
            String name = names.nextElement();
            Object object = request.getAttribute(name);
            if (Objects.equals(value, object)) {
                return true;
            }
        }
        return false;
    }

    @Override
    @NonNull
    public Object get(Object key) {
        if (request == null) {
            return null;
        }
        return request.getAttribute((String)key);
    }

    @Override
    public Object put(String name, Object value) {
        checkState();
        Object old = request.getAttribute(name);
        request.setAttribute(name, value);
        return old;
    }

    @Override
    public Object remove(@NonNull Object key) {
        checkState();
        Object old = request.getAttribute((String)key);
        request.removeAttribute((String)key);
        return old;
    }

    @Override
    public void putAll(@Nullable Map map) {
        checkState();
        if (map != null) {
            for (Entry entry : map.entrySet()) {
                request.setAttribute(entry.getKey(), entry.getValue());
            }
        }
    }

    @Override
    public void clear() {
        if (request != null) {
            for (String name : Collections.list(request.getAttributeNames())) {
                request.removeAttribute(name);
            }
        }
    }

    @Override
    @NonNull
    public Set keySet() {
        if (request == null) {
            return Collections.emptySet();
        }
        return Set.copyOf(Collections.list(request.getAttributeNames()));
    }

    @Override
    @NonNull
    public Collection