step.grid.io.OutputMessage Maven / Gradle / Ivy

Go to download

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

There is a newer version: 2.2.0

/*******************************************************************************
 * Copyright (C) 2020, exense GmbH
 *  
 * This file is part of STEP
 *  
 * STEP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *  
 * STEP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *  
 * You should have received a copy of the GNU Affero General Public License
 * along with STEP.  If not, see .
 ******************************************************************************/
package step.grid.io;

import java.util.ArrayList;
import java.util.List;

import com.fasterxml.jackson.databind.JsonNode;

public class OutputMessage {
	
	private JsonNode payload;
	
	private AgentError agentError;

	private List attachments;
	
	public OutputMessage() {
		super();
	}
	
	/**
	 * @return an typed agent error if any
	 */
	public AgentError getAgentError() {
		return agentError;
	}
	
	public void setAgentError(AgentError agentError) {
		this.agentError = agentError;
	}

	/**
	 * @return the payload of this output message as {@link JsonNode} 
	 */
	public JsonNode getPayload() {
		return payload;
	}

	public void setPayload(JsonNode payload) {
		this.payload = payload;
	}

	public boolean addAttachment(Attachment arg0) {
		if(attachments==null) {
			attachments = new ArrayList<>();
		}
		return attachments.add(arg0);
	}

	/**
	 * @return a list of attachments that might have been generated by the agent layer in case of AgentErrors
	 */
	public List getAttachments() {
		return attachments;
	}

	public void setAttachments(List attachments) {
		this.attachments = attachments;
	}
}