org.daisy.pipeline.client.models.Callback Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of clientlib-java Show documentation

A Java library for communicating with the DAISY Pipeline 2.

There is a newer version: 5.0.1

package org.daisy.pipeline.client.models;

import org.daisy.pipeline.client.Pipeline2Exception;
import org.daisy.pipeline.client.Pipeline2Logger;
import org.daisy.pipeline.client.utils.XML;
import org.daisy.pipeline.client.utils.XPath;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

/** A callback for job updates. */
public class Callback implements Comparable {
	
	public enum Type { messages, status };
	
	public String href;
	public Type type;
	public String frequency;
	
	public Callback(String href, Type type, String frequency) {
		this.href = href;
		this.type = type;
		this.frequency = frequency;
	}
	
	public Callback(Node callbackElement) {
		try {
			this.href = XPath.selectText("@href", callbackElement, XPath.dp2ns);
			String type = XPath.selectText("@href", callbackElement, XPath.dp2ns);
			for (Type t : Type.values()) {
				if (t.toString().equals(type)) {
					this.type = t;
					break;
				}
			}
			this.frequency = XPath.selectText("@frequency", callbackElement, XPath.dp2ns);
			
		} catch (Pipeline2Exception e) {
			Pipeline2Logger.logger().error("Unable to parse callback XML", e);
		}
	}
	
	@Override
	public int compareTo(Callback other) {
		assert(href != null);
		assert(type != null);
		return (this.type+this.href).compareTo((other.type+other.href));
	}

	public Document toXml() {
		Document callbackDocument = XML.getXml("");
		Element callbackElement = callbackDocument.getDocumentElement();

		if (href != null) {
			callbackElement.setAttribute("href", href);
		}
		if (type != null) {
			callbackElement.setAttribute("type", type.toString());
		}
		if (frequency != null) {
			callbackElement.setAttribute("frequency", frequency);
		}
		
		return callbackDocument;
	}
	
}