com.threatconnect.sdk.app.App Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation
The ThreatConnect Java SDK. Used to communicate with teh ThreatConnect Threat Intelligence Platform
The newest version!
package com.threatconnect.sdk.app;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.util.Map;

/**
 * Represents the core of an app
 * 
 * @author Greg Marut
 */
public abstract class App
{
	private final Logger logger = LoggerFactory.getLogger(getClass());
	
	// holds the reference to the app config object
	private AppConfig appConfig;
	
	/**
	 * Executes the app
	 * 
	 * @param appConfig
	 * the configuration for this app
	 * @return abstract
	 * @throws Exception on error
	 */
	public abstract ExitStatus execute(AppConfig appConfig) throws Exception;
	
	/**
	 * Retrieves the name of the log file for this app to log to
	 * 
	 * @return the name of the log file for this app to log to
	 */
	public abstract String getLogFilename();
	
	/**
	 * Writes a message out to the application's message log file
	 * 
	 * @param message Message to append to to log
	 */
	public void writeMessageTc(String message)
	{
		PrintWriter writer = null;
		
		try
		{
			// write the message out to the message.tc file
			writer = new PrintWriter(getMessageLogFile(), "UTF-8");
			writer.println(message);
		}
		catch (FileNotFoundException | UnsupportedEncodingException e)
		{
			LoggerUtil.logErr(e, "Failed to write message.tc file");
		}
		finally
		{
			// make sure the writer is not null
			if (null != writer)
			{
				writer.close();
			}
		}
	}
	
	/**
	 * Writes the results out to the application's results log file
	 * 
	 * @param results Results to write to log file
	 */
	public void writeResultsTc(Map results)
	{
		PrintWriter writer = null;
		
		try
		{
			// create the writer object
			writer = new PrintWriter(getResultsLogFile(), "UTF-8");
			
			// for each of the results
			for (Map.Entry entry : results.entrySet())
			{
				// write the result to the file
				writer.println(String.format("%s = %s", entry.getKey(), entry.getValue()));
			}
		}
		catch (FileNotFoundException | UnsupportedEncodingException e)
		{
			LoggerUtil.logErr(e, "Failed to write message.tc file");
		}
		finally
		{
			// make sure the writer is not null
			if (null != writer)
			{
				writer.close();
			}
		}
	}
	
	public Logger getLogger()
	{
		return logger;
	}
	
	public AppConfig getAppConfig()
	{
		return appConfig;
	}
	
	public void setAppConfig(AppConfig appConfig)
	{
		this.appConfig = appConfig;
	}
	
	/**
	 * Returns the log file for this app
	 * 
	 * @return the log file for this app
	 */
	public File getAppLogFile()
	{
		return new File(getAppConfig().getTcLogPath() + File.separator + getLogFilename());
	}
	
	/**
	 * Returns the message.tc log file
	 * 
	 * @return the message.tc log file
	 */
	public File getMessageLogFile()
	{
		return new File(getAppConfig().getTcOutPath() + File.separator + "message.tc");
	}
	
	/**
	 * Returns the results.tc log file
	 * 
	 * @return the results.tc log file
	 */
	public File getResultsLogFile()
	{
		return new File(getAppConfig().getTcOutPath() + File.separator + "results.tc");
	}
}