connector.ConnectorMessage.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017/2021 e-voyageurs technologies
 *
 * 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 ai.tock.bot.connector

import ai.tock.bot.engine.message.GenericMessage

/**
 * A json serializable [ConnectorMessage].
 * For a [Connector] implementation, implementing this interface for all of its [ConnectorMessage] types is prerequisite
 * in order to support bot orchestration.
 */
interface SerializableConnectorMessage : ConnectorMessage

/**
 * Connector specific message format.
 */
interface ConnectorMessage : ConnectorMessageProvider {

    /**
     * The connector type.
     */
    val connectorType: ConnectorType

    /**
     * Transforms this message into a generic [GenericMessage].
     * @return the generic transformed element, null if unsupported
     */
    fun toGenericMessage(): GenericMessage? = null

    /**
     * Obfuscate the message - by default this method does nothing.
     */
    fun obfuscate(): ConnectorMessage = this

    override fun toConnectorMessage(): ConnectorMessage = this
}