tools.dynamia.zk.spring.PageScope Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tools.dynamia.zk Show documentation
Classes for ZK web application
The newest version!
/*
 * Copyright (C) 2023 Dynamia Soluciones IT S.A.S - NIT 900302344-1
 * Colombia / South America
 *
 * 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 tools.dynamia.zk.spring;

import org.springframework.beans.factory.ObjectFactory;
import org.springframework.beans.factory.config.Scope;
import org.zkoss.zk.ui.Execution;
import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.Page;
import org.zkoss.zk.ui.sys.ExecutionCtrl;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * ZK Page scope; accessible only in ZK event handling request.
 *
 * @author henrichen
 * @since 1.2
 */
public class PageScope implements Scope {

    private static final String PAGE_SCOPE = "ZK_SPRING_PAGE_SCOPE";

    @Override
    public Object get(String name, ObjectFactory objectFactory) {
        final Execution exec = Executions.getCurrent();
        if (exec != null) {
            final Page page = ((ExecutionCtrl) exec).getCurrentPage();
            Map pageScope = (Map) page.getAttribute(PAGE_SCOPE);
            if (pageScope == null) {
                page.setAttribute(PAGE_SCOPE, pageScope = new ConcurrentHashMap());
            }
            Object scopedObject = pageScope.get(name);
            if (scopedObject == null) {
                scopedObject = objectFactory.getObject();
                //noinspection unchecked
                pageScope.put(name, scopedObject);
            }
            return scopedObject;
        }
        throw new IllegalStateException("Unable to get page scope bean: " + name + ". Do you access it in ZK event listener?");
    }

    @Override
    public String getConversationId() {
        final Execution exec = Executions.getCurrent();
        if (exec != null) {
            final Page page = ((ExecutionCtrl) exec).getCurrentPage();
            if (page != null) {
                return page.getId();
            }
        }
        return null;
    }

    @Override
    public void registerDestructionCallback(String name, Runnable callback) {
        // do nothing
    }

    @Override
    public Object remove(String name) {
        final Execution exec = Executions.getCurrent();
        if (exec != null) {
            final Page page = ((ExecutionCtrl) exec).getCurrentPage();
            final Map pageScope = (Map) page.getAttribute(PAGE_SCOPE);
            return pageScope != null ? pageScope.remove(name) : null;
        }
        throw new IllegalStateException("Unable to get page scope bean: " + name + ". Do you access it in ZK event listener?");
    }

    @Override
    public Object resolveContextualObject(String key) {

        return null;
    }

}