com.norconex.jef4.mail.AbstractMailNotifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of norconex-jef Show documentation

JEF is a Java API library meant to facilitate the lives of developers and integrators who have to build any kind of maintenance tasks on a server.

There is a newer version: 5.0.0-M1

Show newest version

/* Copyright 2010-2014 Norconex Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.norconex.jef4.mail;

import java.io.IOException;

import org.apache.commons.lang3.ArrayUtils;

import com.norconex.commons.lang.io.IOUtil;
import com.norconex.jef4.suite.JobSuite;

/**
 * Convenience base class for sending email notifications.
 * @author Pascal Essiembre
 */
public abstract class AbstractMailNotifier {

    /** Simple mailer. */
    private final SimpleMailer mailer;
    /** Email recipients. */
    private final String[] recipients;

    /**
     * Constructor.
     * @param host mail server host
     * @param sender email address of sender ("From" field)
     * @param recipient email address of recipient ("To" field)
     */
    public AbstractMailNotifier(
            final String host, final String sender, final String recipient) {
        super();
        this.mailer = new SimpleMailer(host, sender);
        this.recipients = new String[] {recipient};
    }
    /**
     * Constructor.
     * @param host mail server host
     * @param sender email address of sender ("From" field)
     * @param recipients email address of recipients ("To" field)
     */
    public AbstractMailNotifier(
            final String host, final String sender, final String[] recipients) {
        super();
        this.mailer = new SimpleMailer(host, sender);
        this.recipients = ArrayUtils.clone(recipients);
    }

    /**
     * Gets the mailer for this notifier.
     * @return mailer
     */
    protected final SimpleMailer getMailer() {
        return mailer;
    }

    /**
     * Gets the email recipients for this notifier.
     * @return email recipients
     */
    protected final String[] getRecipients() {
        return recipients;
    }

    /**
     * Gets the last lines from a suite log.
     * @param suite the suite to extract the log from
     * @param lineQty the number of lines to retrieve
     * @return string representation of log last lines
     * @throws IOException problem getting lines
     */
    @SuppressWarnings("nls")
    protected final String getLogTail(final JobSuite suite, final int lineQty)
            throws IOException {
        StringBuffer logTail = new StringBuffer();
        String[] lines = IOUtil.tail(
                suite.getLogManager().getLog(suite.getId()), lineQty);
        if (lines.length == 0) {
            logTail.append("*** No log found. ***\n");
        } else {
            for (int i = 0; i < lines.length; i++) {
                String line = lines[i];
                logTail.append(line);
                logTail.append('\n');
            }
        }
        return logTail.toString();
    }
}