All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aspectran.core.activity.ActivityData Maven / Gradle / Ivy

Go to download

Aspectran (All-in-One)

There is a newer version: 8.1.5
Show newest version
/*
 * Copyright (c) 2008-2024 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.core.activity;

import com.aspectran.core.activity.process.result.ActionResult;
import com.aspectran.core.activity.process.result.ContentResult;
import com.aspectran.core.adapter.RequestAdapter;
import com.aspectran.core.adapter.SessionAdapter;
import com.aspectran.utils.annotation.jsr305.NonNull;

import java.io.Serial;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * A map of data for saving activity results.
 * It is often used as a model for providing data used in views.
 *
 * 
This class is generally not thread-safe.
 * It is primarily designed for use in a single thread only.

 */
public class ActivityData extends HashMap {

    @Serial
    private static final long serialVersionUID = -4557424414862800204L;

    private static final Object PREEMPTED = new Object();

    private final Activity activity;

    /**
     * Instantiates a new ActivityData.
     * @param activity the activity
     */
    public ActivityData(Activity activity) {
        super();
        this.activity = activity;
        refresh();
    }

    @Override
    public Object get(Object key) {
        Object value = super.get(key);
        if (value != null && !value.equals(PREEMPTED)) {
            return value;
        }
        if (key == null) {
            return null;
        }

        String name = key.toString();
        Object data = getActionResultWithoutCache(name);
        if (data != null) {
            preempt(name, value);
            return data;
        }

        data = getAttributeWithoutCache(name);
        if (data != null) {
            preempt(name, value);
            return data;
        }

        data = getParameterWithoutCache(name);
        if (data != null) {
            preempt(name, value);
            return data;
        }

        data = getSessionAttributeWithoutCache(name);
        if (data != null) {
            preempt(name, value);
            return data;
        }

        return null;
    }

    @Override
    public Object put(String key, Object value) {
        if (this == value) {
            throw new IllegalArgumentException("Same instance as this map can not be stored");
        }
        return super.put(key, value);
    }

    @Override
    @NonNull
    public Collection values() {
        List list = new ArrayList<>(size());
        for (String name : keySet()) {
            list.add(get(name));
        }
        return list;
    }

    @Override
    @NonNull
    public Set> entrySet() {
        Set> set = new HashSet<>();
        for (Map.Entry entry : super.entrySet()) {
            if (entry.getValue() == PREEMPTED) {
                String key = entry.getKey();
                Object value = get(key);
                set.add(new AbstractMap.SimpleEntry<>(key, value));
            } else {
                set.add(entry);
            }
        }
        return set;
    }

    /**
     * Returns the value of the request parameter from the request adapter
     * without storing it in the cache.
     * If the parameter does not exist, returns null.
     * @param name a {@code String} specifying the name of the parameter
     * @return an {@code Object} containing the value of the parameter,
     *         or {@code null} if the parameter does not exist
     * @see RequestAdapter#setParameter
     */
    public Object getParameterWithoutCache(String name) {
        if (activity.getRequestAdapter() != null) {
            String[] values = activity.getRequestAdapter().getParameterValues(name);
            if (values != null) {
                if (values.length == 1) {
                    return values[0];
                } else {
                    return values;
                }
            }
        }
        return null;
    }

    /**
     * Returns the value of the named attribute from the request adapter
     * without storing it in the cache.
     * If no attribute of the given name exists, returns null.
     * @param name a {@code String} specifying the name of the attribute
     * @return an {@code Object} containing the value of the attribute,
     *         or {@code null} if the attribute does not exist
     * @see RequestAdapter#getAttribute
     */
    public Object getAttributeWithoutCache(String name) {
        if (activity.getRequestAdapter() != null) {
            return activity.getRequestAdapter().getAttribute(name);
        } else {
            return null;
        }
    }

    /**
     * Returns the value of the named action's process result
     * without storing it in the cache.
     * If no process result of the given name exists, returns null.
     * @param name a {@code String} specifying the name of the action
     * @return an {@code Object} containing the value of the action result,
     *         or {@code null} if the action result does not exist
     */
    public Object getActionResultWithoutCache(String name) {
        if (activity.getProcessResult() != null) {
            return activity.getProcessResult().getResultValue(name);
        } else {
            return null;
        }
    }

    /**
     * Returns the value of the named attribute from the session adapter
     * without storing it in the cache.
     * If no attribute of the given name exists, returns null.
     * @param name a {@code String} specifying the name of the attribute
     * @return an {@code Object} containing the value of the attribute,
     *         or {@code null} if the attribute does not exist
     * @see SessionAdapter#getAttribute
     */
    public Object getSessionAttributeWithoutCache(String name) {
        if (activity.getSessionAdapter() != null) {
            return activity.getSessionAdapter().getAttribute(name);
        } else {
            return null;
        }
    }

    public void refresh() {
        if (activity.getRequestAdapter() != null) {
            for (String name : activity.getRequestAdapter().getParameterNames()) {
                preempt(name);
            }
            for (String name : activity.getRequestAdapter().getAttributeNames()) {
                Object value = activity.getRequestAdapter().getAttribute(name);
                if (this != value) {
                    preempt(name);
                }
            }
        }
        if (activity.getSessionAdapter() != null) {
            Enumeration enumer = activity.getSessionAdapter().getAttributeNames();
            if (enumer != null) {
                while (enumer.hasMoreElements()) {
                    String name = enumer.nextElement();
                    Object value = activity.getSessionAdapter().getAttribute(name);
                    if (this != value) {
                        preempt(name);
                    }
                }
            }
        }
        if (activity.getProcessResult() != null) {
            for (ContentResult cr : activity.getProcessResult()) {
                for (ActionResult ar : cr) {
                    if (ar.getActionId() != null && this != ar.getResultValue()) {
                        preempt(ar.getActionId());
                    }
                }
            }
        }
    }

    private void preempt(String name) {
        preempt(name, super.get(name));
    }

    private void preempt(String name, Object value) {
        if (value == null) {
            put(name, PREEMPTED);
        }
    }

    protected Activity getActivity() {
        return activity;
    }

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy