[Babeldoc-devel] babeldoc/modules/core/src/com/babeldoc/core/pipeline/stage JournalUpdatePipelineStage.java,NONE,1.1

[<dgl...@us...>]

Update of /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/pipeline/stage
In directory sc8-pr-cvs1:/tmp/cvs-serv32424/modules/core/src/com/babeldoc/core/pipeline/stage

Added Files:
	JournalUpdatePipelineStage.java 
Log Message:
Added JournalUpdatePipelineStage, added support for logging arbitrary messages into the journal

--- NEW FILE: JournalUpdatePipelineStage.java ---
/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact ap...@ap....
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * Portions of this software are based upon public domain software
 * originally written at the National Center for Supercomputing Applications,
 * University of Illinois, Urbana-Champaign.
 * ====================================================================
 *
 * Babeldoc:  The Universal Document Processor
 *
 * $Header$
 * $DateTime$
 * $Author: dglick02 $
 *
 */
package com.babeldoc.core.pipeline.stage;

import com.babeldoc.core.I18n;
import com.babeldoc.core.journal.IJournalTicket;
import com.babeldoc.core.journal.JournalException;
import com.babeldoc.core.journal.JournalStatus;
import com.babeldoc.core.journal.simple.SimpleJournal;
import com.babeldoc.core.option.ConfigOption;
import com.babeldoc.core.option.IConfigOptionType;
import com.babeldoc.core.option.ValueListConfigOptionType;
import com.babeldoc.core.pipeline.PipelineDocument;
import com.babeldoc.core.pipeline.PipelineException;
import com.babeldoc.core.pipeline.PipelineStage;
import com.babeldoc.core.pipeline.PipelineStageResult;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import java.util.*;

import javax.activation.DataHandler;
import javax.activation.DataSource;
import javax.activation.FileDataSource;

import javax.mail.*;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeBodyPart;
import javax.mail.internet.MimeMessage;
import javax.mail.internet.MimeMultipart;


/**
 * Add an entry to the Journal.
 * 
 * <p>
 * Copyright: Copyright (c) 2002, 2003
 * </p>
 *
 * @author David Glick
 * @version 1.0
 */
public class JournalUpdatePipelineStage extends PipelineStage {
  /** Constants */
  public static final String JOURNAL_MESSAGE = "message";

  /**
   * Constructor with this stage's info
   */
  public JournalUpdatePipelineStage() {
    super(new com.babeldoc.core.pipeline.PipelineStageInfo() {
        public String getName() {
          return "JournalUpdate";
        }

        public String getDescription() {
          return I18n.get("core.pipeline.stage.journalupdate.description");
        }

        public Collection getTypeSpecificOptions() {
          ArrayList options = new ArrayList();

          options.add(new ConfigOption(JOURNAL_MESSAGE, IConfigOptionType.STRING,
              null, true, I18n.get("core.pipeline.stage.journalupdate.opt.message")));

          return options;
        }
      });
  }

  /**
   * pipeline stage
   *
   * @return the name of the next stage in the pipe line or nothing
   * @throws PipelineException If no message option exists, this exception is thrown
   */
  public PipelineStageResult[] process() throws PipelineException {
    if (!hasOption(JOURNAL_MESSAGE)) {
      throw new PipelineException(I18n.get("core.pipeline.stage.journalupdate.error.message"));
    }

	// Add a journal entry for the nessage
	try {
		((SimpleJournal)getJournal()).logMessage(getTicket(), getPipelineName() + "." + getName(), 
				getOptions(JOURNAL_MESSAGE));
	}
	catch (JournalException e) {
		throw new PipelineException(e.toString());
	}
	
    return super.processHelper();
  }
}