IPublisherInfo.java

/*
 * #%L
 * carewebframework
 * %%
 * Copyright (C) 2008 - 2016 Regenstrief Institute, Inc.
 * %%
 * 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.
 * 
 * This Source Code Form is also subject to the terms of the Health-Related
 * Additional Disclaimer of Warranty and Limitation of Liability available at
 *
 *      http://www.carewebframework.org/licensing/disclaimer.
 *
 * #L%
 */
package org.carewebframework.api.messaging;

import java.util.Map;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

/**
 * Returns information about a global event publisher.
 */
@JsonDeserialize(as = PublisherInfo.class)
public interface IPublisherInfo {
    
    /**
     * Returns the user's domain id.
     * 
     * @return The user's domain id.
     */
    String getUserId();
    
    /**
     * Returns the full name of the user.
     * 
     * @return The user's full name.
     */
    String getUserName();
    
    /**
     * Returns the application name.
     * 
     * @return The application name.
     */
    String getAppName();
    
    /**
     * Returns the unique id of the message producer's node.
     * 
     * @return The producer's unique id.
     */
    String getProducerId();
    
    /**
     * Returns the unique id of the message consumer's node.
     * 
     * @return The consumer's unique id.
     */
    String getConsumerId();
    
    /**
     * Returns the unique id of an application instance.
     * 
     * @return The unique id of the application instance.
     */
    String getSessionId();
    
    /**
     * Returns a map of message routing attributes.
     * 
     * @return Map of routining attributes.
     */
    Map<String, String> getAttributes();
    
}