io.openmessaging.api.MessageAccessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmessaging-api Show documentation

There is a newer version: 2.2.1-pubsub

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 io.openmessaging.api;

import java.util.Properties;

/**
 * Used for set or get the relevant properties of a message.
 *
 * @version OMS 1.2.0
 * @since OMS 1.2.0
 */
public class MessageAccessor {
    /**
     * Used for get all system properties.
     *
     * @param msg
     * @return system properties
     */
    public static Properties getSystemProperties(final Message msg) {
        return msg.systemProperties;
    }

    /**
     * Used for set system properties, will used new systemProperties to override current systemProperties.
     *
     * @param msg
     * @return system properties
     */
    public static void setSystemProperties(final Message msg, Properties systemProperties) {
        msg.systemProperties = systemProperties;
    }

    /**
     * Used for set system property for a specified key, will used new value to replace origin system property of a
     * specified key.
     *
     * @param msg
     * @return
     */
    public static void putSystemProperties(final Message msg, final String key, final String value) {
        msg.putSystemProperties(key, value);
    }

    /**
     * Used for get a system property value for a specified key.
     *
     * @param msg
     * @return system property value of specified key
     */
    public static String getSystemProperties(final Message msg, final String key) {
        return msg.getSystemProperties(key);
    }
}