
001/*- 002 * #%L 003 * HAPI FHIR - Server Framework 004 * %% 005 * Copyright (C) 2014 - 2025 Smile CDR, Inc. 006 * %% 007 * Licensed under the Apache License, Version 2.0 (the "License"); 008 * you may not use this file except in compliance with the License. 009 * You may obtain a copy of the License at 010 * 011 * http://www.apache.org/licenses/LICENSE-2.0 012 * 013 * Unless required by applicable law or agreed to in writing, software 014 * distributed under the License is distributed on an "AS IS" BASIS, 015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 016 * See the License for the specific language governing permissions and 017 * limitations under the License. 018 * #L% 019 */ 020package ca.uhn.fhir.rest.server.messaging; 021 022import org.hl7.fhir.instance.model.api.IIdType; 023 024/** 025 * IMessage implementations that deliver a FHIR Resource payload can implement this interface to 026 * make the resource id available to loggers. 027 */ 028public interface IResourceMessage extends IHasPayloadMessageKey { 029 /** 030 * @param theResourceId of the resource contained in the payload 031 */ 032 void setPayloadId(IIdType theResourceId); 033 034 /** 035 * This method is primarily used for logging 036 * @return the id of the resource contained in the payload 037 */ 038 String getPayloadId(); 039 040 /** 041 * In cases where the IMessage extracts the message key from the payload, this method can be used to set 042 * the message key that will be used. 043 * 044 * See {@link IMessage#getMessageKey()} and {@link IHasPayloadMessageKey#getPayloadMessageKey()} 045 * @param thePayloadMessageKey the message key that should be used for the message delivering this payload 046 */ 047 void setPayloadMessageKey(String thePayloadMessageKey); 048}