com.exactpro.sf.services.MessageHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sailfish-core Show documentation
'Exactpro Sailfish Core'
There is a newer version: 3.4.260
/******************************************************************************
 * Copyright 2009-2018 Exactpro (Exactpro Systems Limited)
 *
 * 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.exactpro.sf.services;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.exactpro.sf.common.messages.structures.DictionaryConstants;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.NotImplementedException;

import com.exactpro.sf.common.codecs.AbstractCodec;
import com.exactpro.sf.common.messages.AttributeNotFoundException;
import com.exactpro.sf.common.messages.IMessage;
import com.exactpro.sf.common.messages.IMessageFactory;
import com.exactpro.sf.common.messages.MessageNotFoundException;
import com.exactpro.sf.common.messages.structures.IDictionaryStructure;
import com.exactpro.sf.common.messages.structures.IMessageStructure;
import com.exactpro.sf.common.messages.structures.StructureUtils;

public abstract class MessageHelper {

    public static final String FIELD_MESSAGE_TYPE = DictionaryConstants.FIELD_MESSAGE_TYPE;
    public static final String ATTRIBUTE_IS_ADMIN = DictionaryConstants.ATTRIBUTE_IS_ADMIN;
    public static final String ATTRIBUTE_MESSAGE_TYPE = FIELD_MESSAGE_TYPE;
    public static final String ATTRIBUTE_DESCRIPTION_PREFIX = DictionaryConstants.ATTRIBUTE_DESCRIPTION_PREFIX;

    private volatile IMessageFactory messageFactory;
    private volatile IDictionaryStructure dictionaryStructure;
    private volatile String namespace;

    public void init(IMessageFactory messageFactory, IDictionaryStructure dictionaryStructure) {
        this.messageFactory = messageFactory;
        this.dictionaryStructure = dictionaryStructure;
        this.namespace = this.dictionaryStructure.getNamespace();
    }

    public IMessage prepareMessageToEncode(IMessage message, Map params) {
        return message;
    }

    public IMessage prepareMessageToEncode(Map message, Map params) {
        throw new NotImplementedException("");
    }

    public boolean isAdmin(IMessage message) throws MessageNotFoundException, AttributeNotFoundException {
        IMessageStructure messageStructure = dictionaryStructure.getMessages().get(message.getName());
        return messageStructure == null || isAdmin(messageStructure);
    }

    public AbstractCodec getCodec(IServiceContext serviceContext) {
        throw new NotImplementedException("");
    }

    public IMessageFactory getMessageFactory() {
        return messageFactory;
    }

    public IDictionaryStructure getDictionaryStructure() {
        return dictionaryStructure;
    }

    public String getNamespace() {
        return namespace;
    }

    public static boolean isAdmin(IMessageStructure structure) throws AttributeNotFoundException {
        Object isAdminAttribute = StructureUtils.getAttributeValue(structure, ATTRIBUTE_IS_ADMIN);

        if (isAdminAttribute instanceof Boolean || isAdminAttribute == null) {
            return BooleanUtils.toBoolean((Boolean) isAdminAttribute);
        }

        throw new AttributeNotFoundException("Message structure" + structure.getName()
            + " does not contains boolean attribute name " + ATTRIBUTE_IS_ADMIN + " namespace " + structure.getNamespace());
    }

    public static HashMap convert(IMessage message) {
        if (message == null) {
            throw new NullPointerException();
        }

        HashMap result = new HashMap<>();

        for (String fieldName : message.getFieldNames()) {
            Object field = message.getField(fieldName);
            result.put(fieldName, convertValue(field));
        }

        return result;
    }

    private static Object convertValue(Object field) {
        if (field instanceof IMessage) {
            return convert((IMessage)field);
        } else if (field instanceof List) {
            List