com.exactpro.sf.common.messages.IMessageFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sailfish-common 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.common.messages;

import java.util.Collections;
import java.util.Set;

import com.exactpro.sf.common.messages.structures.DictionaryConstants;
import com.exactpro.sf.common.messages.structures.IDictionaryStructure;
import com.exactpro.sf.configuration.suri.SailfishURI;

public interface IMessageFactory
{

    /**
     * Inits internal state. This method should be called before interaction with instance.
     * {@link #createMessage}
     * @param dictionaryURI 
     * @param dictionary
     */
    void init(SailfishURI dictionaryURI, IDictionaryStructure dictionary);

    /**
     * @deprecated because without IDictionaryStructure we can not to create default sub messages
     * for inner complex fields
     * Please use {@link #init(SailfishURI, IDictionaryStructure)} instead
     * @param namespace
     * @param dictionaryURI
     */
    @Deprecated
    void init(String namespace, SailfishURI dictionaryURI);

    /**
     * Creates a new message with the provided metadata.
     * If factory instance has dictionary URI specified and created message has submessage
     * fields with {@link DictionaryConstants#ATTRIBUTE_CREATE_DEFAULT_STRUCTURE} attribute set
     * to {@code true} in the dictionary - such fields will be created automatically
     * @param metadata message metadata
     * @return message with provided metadata
     */
    IMessage createMessage(MsgMetaData metadata);

    /**
     * Creates new message with the id parameter passed to its metadata
     * If dictionary is not null and field has
     * {@value DictionaryConstants#ATTRIBUTE_CREATE_DEFAULT_STRUCTURE}
     * attribute = 'true' then complex non-collection fields will be created
     * @return a message with specified metadata id
     */
    IMessage createMessage(long id, String name, String namespace);

	IMessage createMessage(String name, String namespace);

    IMessage createMessage(String name);
    
    IHumanMessage createHumanMessage(String name);

	void fillMessageType(IMessage message);

    /***
     * Set of fields will be ignored when fail unxpected used
     * @return set as described
     */
	Set getUncheckedFields();

    /***
     * Set of fields which will be excluded from comparison
     * @return set of ignored fields
     */
	default Set getIgnoredFields() {
	    return Collections.emptySet();
    }

    String getNamespace();

    SailfishURI getDictionaryURI();

    String getProtocol();
}