com.haulmont.cuba.gui.exception.DeletePolicyHandler.java Source code

Introduction

Here is the source code for com.haulmont.cuba.gui.exception.DeletePolicyHandler.java

Source

/*
 * Copyright (c) 2008-2016 Haulmont.
 *
 * 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.haulmont.cuba.gui.exception;

import com.haulmont.chile.core.model.MetaClass;
import com.haulmont.cuba.core.global.DeletePolicyException;
import com.haulmont.cuba.core.global.Messages;
import com.haulmont.cuba.core.global.Metadata;
import com.haulmont.cuba.gui.WindowManager;
import com.haulmont.cuba.gui.components.Frame;
import org.apache.commons.lang.StringUtils;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;

import javax.annotation.Nullable;
import javax.inject.Inject;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Handles {@link DeletePolicyException}. Determines the exception type by searching a special marker string in the
 * messages of all exceptions in the chain.
 *
 */
@Component("cuba_DeletePolicyHandler")
public class DeletePolicyHandler implements GenericExceptionHandler, Ordered {

    @Inject
    protected Messages messages;

    @Inject
    protected Metadata metadata;

    @Override
    public boolean handle(Throwable exception, WindowManager windowManager) {
        Throwable t = exception;
        try {
            while (t != null) {
                if (t.toString().contains(getMarker())) {
                    doHandle(t.toString(), windowManager);
                    return true;
                }
                t = t.getCause();
            }
            return false;
        } catch (Exception e) {
            return false;
        }
    }

    protected String getMarker() {
        return DeletePolicyException.class.getName();
    }

    protected Pattern getPattern() {
        return Pattern.compile(DeletePolicyException.class.getName() + ": "
                + DeletePolicyException.ERR_MESSAGE.replace("%s", "(\\w+\\$\\w+)"));
    }

    protected void doHandle(String message, WindowManager windowManager) {
        String caption = null;
        String notificationMessage = null;

        MetaClass deletedEntityMetaClass = recognizeDeletedEntityMetaClass(message);
        if (deletedEntityMetaClass != null) {
            String customCaptionKey = String.format("deletePolicy.caption.%s", deletedEntityMetaClass.getName());
            String customCaption = messages.getMainMessage(customCaptionKey);
            if (!customCaptionKey.equals(customCaption)) {
                caption = customCaption;
            }

            String customMessageKey = String.format("deletePolicy.references.message.%s",
                    deletedEntityMetaClass.getName());
            String customMessage = messages.getMainMessage(customMessageKey);
            if (!customMessageKey.equals(customMessage)) {
                notificationMessage = customMessage;
            }
        }

        if (StringUtils.isEmpty(caption)) {
            caption = messages.getMainMessage("deletePolicy.caption");
        }

        if (StringUtils.isEmpty(notificationMessage)) {
            MetaClass metaClass = recognizeRelatedEntityMetaClass(message);
            if (metaClass != null) {
                String localizedEntityName = messages.getTools().getEntityCaption(metaClass);
                String referencesMessage = messages.getMainMessage("deletePolicy.references.message");
                notificationMessage = String.format(referencesMessage, localizedEntityName);
            }
        }

        windowManager.showNotification(caption, notificationMessage, Frame.NotificationType.ERROR);
    }

    @Nullable
    protected MetaClass recognizeDeletedEntityMetaClass(String message) {
        Matcher matcher = getPattern().matcher(message);
        if (matcher.find()) {
            String entityName = matcher.group(1);
            if (!StringUtils.isEmpty(entityName)) {
                MetaClass metaClass = metadata.getClass(entityName);
                if (metaClass != null) {
                    MetaClass originalMetaClass = metadata.getExtendedEntities().getOriginalMetaClass(metaClass);
                    metaClass = originalMetaClass != null ? originalMetaClass : metaClass;
                }
                return metaClass;
            }
        }
        return null;
    }

    @Nullable
    protected MetaClass recognizeRelatedEntityMetaClass(String message) {
        Matcher matcher = getPattern().matcher(message);
        if (matcher.find()) {
            String entityName = matcher.group(2);
            if (!StringUtils.isEmpty(entityName)) {
                MetaClass metaClass = metadata.getClass(entityName);
                if (metaClass != null) {
                    MetaClass originalMetaClass = metadata.getExtendedEntities().getOriginalMetaClass(metaClass);
                    metaClass = originalMetaClass != null ? originalMetaClass : metaClass;
                }
                return metaClass;
            }
        }
        return null;
    }

    @Override
    public int getOrder() {
        return HIGHEST_PLATFORM_PRECEDENCE + 30;
    }
}