com.flowcentraltech.flowcentral.messaging.os.business.OSMessagingAccessManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flowcentral-messaging-os Show documentation

Flowcentral OS Messaging Module

The newest version!

/*
 * Copyright 2021-2024 FlowCentral Technologies 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.flowcentraltech.flowcentral.messaging.os.business;

import com.flowcentraltech.flowcentral.common.business.FlowCentralService;
import com.flowcentraltech.flowcentral.messaging.os.data.OSMessagingAccess;
import com.flowcentraltech.flowcentral.messaging.os.data.OSMessagingError;
import com.tcdng.unify.core.UnifyException;

/**
 * OS messaging access manager.
 * 
 * @author FlowCentral Technologies Limited
 * @since 1.0
 */
public interface OSMessagingAccessManager extends  FlowCentralService {

    /**
     * Checks if application has messaging access.
     * 
     * @param authorization
     *                      the authorization token
     * @param source
     *                      the source application
     * @param target
     *                      the target application
     * @param processor
     *                      the processor
     * @return response on error otherwise null
     * @throws UnifyException
     *                        if an error occurs
     */
    OSMessagingError checkAccess(String authorization, String source, String target, String processor)
            throws UnifyException;

    /**
     * Logs messaging access.
     * 
     * @param access
     *                    the access object
     * @throws UnifyException
     *                        if an error occurs
     */
    void logAccess(OSMessagingAccess access) throws UnifyException;
}