DocumentManagementBase.java

package com.bagri.core.api.impl;

import static com.bagri.support.util.FileUtils.def_encoding;
import static com.bagri.support.util.FileUtils.readTextFile;
import static com.bagri.support.util.XMLUtils.textToString;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.nio.file.Paths;
import java.util.Properties;

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

import com.bagri.core.api.BagriException;
import com.bagri.core.model.Document;

/**
 * Base implementation for XDM Document Management interface. SEveral common methods implemented 
 * 
 * @author Denis Sukhoroslov
 *
 */
public abstract class DocumentManagementBase {
	
    protected final transient Logger logger = LoggerFactory.getLogger(getClass());
	
	/**
	 * 
	 * @param uri the XDM document uri
	 * @param props result production properties
	 * @return Document content as a plain text
	 * @throws BagriException in case of any error
	 */
	public abstract String getDocumentAsString(String uri, Properties props) throws BagriException;
	
	
	/**
	 * Creates a new Document or overrides an existing one in Repository
	 * 
	 * @param uri String; the Document uri  
	 * @param content document's text (JSON, XML, ..) representation, can not be null
	 * @param props Properties; the document processing instructions
	 * @return Document created or overridden (versioned) document
	 * @throws BagriException in case of any error
	 */
	public abstract Document storeDocumentFromString(String uri, String content, Properties props) throws BagriException;

	/**
	 * constructs {@link InputStream} over Document content identified by the uri provided 
	 * 
	 * @param uri the Document uri
	 * @param props result production properties
	 * @return {@link InputStream} over the document's content
	 * @throws BagriException in case of any error
	 */
	public InputStream getDocumentAsSream(String uri, Properties props) throws BagriException {
		String content = getDocumentAsString(uri, props);
		if (content != null) {
			try {
				return new ByteArrayInputStream(content.getBytes(def_encoding));
			} catch (UnsupportedEncodingException ex) {
				throw new BagriException(ex, BagriException.ecInOut);
			}
		}
		return null;
	}

	/**
	 * constructs new Document or overrides an existing one in Repository
	 * 
	 * @param uri the file uri containing Document content
	 * @param props Properties; the document processing instructions
	 * @return Document created or overridden (versioned) document
	 * @throws BagriException in case of any error
	 */
	public Document storeDocumentFromFile(String uri, Properties props) throws BagriException {
		try {
			String content = readTextFile(uri);
			uri = Paths.get(uri).getFileName().toString();
			return storeDocumentFromString(uri, content, props);
		} catch (IOException ex) {
			throw new BagriException(ex, BagriException.ecInOut);
		}
	}
	
	/**
	 * constructs new Document or overrides an existing one in Repository
	 * 
	 * @param uri String; the Document uri  
	 * @param stream the {@link InputStream} over document's text (JSON, XML, ..) representation, can not be null
	 * @param props Properties; the document processing instructions
	 * @return Document created or overridden (versioned) document
	 * @throws BagriException in case of any error
	 */
	public Document storeDocumentFromStream(String uri, InputStream stream, Properties props) throws BagriException {
		try {
			String xml = textToString(stream);
			return storeDocumentFromString(uri, xml, props);
		} catch (IOException ex) {
			logger.error("storeDocumentFromStream.error", ex);
			throw new BagriException(ex, BagriException.ecInOut);
		}
	}

}