co.aurasphere.botmill.kik.KikBotMillContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kik-botmill Show documentation
Event-driven framework for Kik Messenger's bots
There is a newer version: 2.0.0-RC1
/**
 * 
 * MIT License
 *
 * Copyright (c) 2017 BotMill.io
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * 
 */
package co.aurasphere.botmill.kik;

import java.util.ArrayList;
import java.util.List;
import co.aurasphere.botmill.kik.configuration.Authentication;
import co.aurasphere.botmill.kik.incoming.event.AnyEvent;
import co.aurasphere.botmill.kik.model.ActionFrame;
import co.aurasphere.botmill.kik.model.Domain;
import co.aurasphere.botmill.kik.model.Frame;

/**
 * KikBotMillContext
 * 
 * This class is used to access all globally defined objects being used on the
 * application. Developers will be able to do the following using this class:
 * 
 * - Setup the environment (Api and username) - Get and Set the list of domains,
 * action frames and broadcast frames - Get and Set the Entrypoints.
 * 
 * @author Alvin P. Reyes
 */
public class KikBotMillContext {

	/** The instance. */
	private static KikBotMillContext instance;

	/** The authentication. */
	private Authentication authentication;

	/** The webhook url. */
	private String webhookUrl;

	/** The bots. */
	private List entryPoints;

	/** The domains. */
	private List domains;

	/** The action frames. */
	private List actionFrames;

	/** The any event action frames. */
	private List anyEventActionFrames;
	
	/** The broadcast action frames. */
	private List broadcastActionFrames;

	/**
	 * Instantiates a new kik bot mill context.
	 * The KikBotMillContext is the heart of it all. This where all the Domains, Events and Replies
	 * are located.
	 */
	public KikBotMillContext() {
		this.entryPoints = new ArrayList();
		this.domains = new ArrayList();
		this.actionFrames = new ArrayList();
		this.anyEventActionFrames = new ArrayList();
		this.broadcastActionFrames = new ArrayList(); 
	}

	/**
	 * Gets the single instance of KikBotMillContext.
	 *
	 * @return {@link KikBotMillContext} single instance of KikBotMillContext
	 */
	public static KikBotMillContext getInstance() {
		if (instance == null) {
			instance = new KikBotMillContext();
		}
		return instance;
	}

	/**
	 * Method to get all available domains created by the developer.
	 *
	 * @return list of {@link Domain}
	 */
	public List getDomains() {
		return domains;
	}

	/**
	 * Method to get all available action frames created by the developer.
	 *
	 * @return list of {@link ActionFrame}
	 */
	public List getActionFrames() {
		return actionFrames;
	}

	/**
	 * Gets the any event action frames.
	 *
	 * @return the any event action frames
	 */
	public List getAnyEventActionFrames() {
		return anyEventActionFrames;
	}
	
	/**
	 * Gets the broadcast message action frames.
	 *
	 * @return the broadcast message action frames
	 */
	public List getBroadcastMessageActionFrames() {
		return broadcastActionFrames;
	}

	/**
	 * Gets the user.
	 *
	 * @return the user
	 */
	public String getUser() {
		return this.authentication.getUser();
	}

	/**
	 * Gets the api key.
	 *
	 * @return the api key
	 */
	public String getApiKey() {
		return this.authentication.getApiKey();
	}

	/**
	 * This is the main setup method. 
	 *
	 * @param username
	 *            the username
	 * @param apiKey
	 *            the api key
	 */
	public void setup(String username, String apiKey) {
		this.authentication = new Authentication();
		this.authentication.setUser(username);
		this.authentication.setApiKey(apiKey);
	}

	/**
	 * Register kik bot.
	 *
	 * @param kikBotMillEntry
	 *            the kikBotMillEntry
	 */
	public void registerEntryPoint(KikBotMillEntry kikBotMillEntry) {
		this.entryPoints.add(kikBotMillEntry);
	}

	/**
	 * Sets the web hook url.
	 *
	 * @param url
	 *            the new web hook url
	 */
	public void setWebHookUrl(String url) {
		this.webhookUrl = url;
	}

	/**
	 * Gets the web hook url.
	 *
	 * @return the web hook url
	 */
	public String getWebHookUrl() {
		return this.webhookUrl;
	}

	/**
	 * Register domain.
	 *
	 * @param domain
	 *            the domain
	 */
	public void registerDomain(Domain domain) {
		this.domains.add(domain);
	}
	
	/**
	 * Register annotated domain.
	 *
	 * @param domain the domain
	 */
	public void registerAnnotatedDomain(Domain domain) {
		
	}

	/**
	 * Adds the action frame to context.
	 *
	 * @param actionFrame
	 *            the action frame
	 */
	public void addActionFrameToContext(Frame actionFrame) {
		if (actionFrame.getEvent() instanceof AnyEvent) {
			this.anyEventActionFrames.add(actionFrame);
		} else {
			this.actionFrames.add(actionFrame);
		}
	}

	/**
	 * Adds the action frames to context.
	 *
	 * @param frames
	 *            the frames
	 */
	public void addActionFramesToContext(List frames) {
		for (Frame actionFrame : frames) {
			if (actionFrame.getEvent() instanceof AnyEvent) {
				this.anyEventActionFrames.add(actionFrame);
			} else {
				this.actionFrames.add(actionFrame);
			}
		}
	}

	/**
	 * Adds the action frame to broadcast.
	 *
	 * @param actionFrame
	 *            the action frame
	 */
	public void addActionFrameToBroadcast(Frame actionFrame) {
		this.broadcastActionFrames.add(actionFrame);
	}
}