sirius.biz.i5.I5Connection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sirius-biz Show documentation
Provides a framework for building web based business applications
There is a newer version: 9.6
/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.biz.i5;

import com.google.common.collect.Lists;
import com.ibm.as400.access.AS400;
import com.ibm.as400.access.AS400Message;
import com.ibm.as400.access.DataQueue;
import com.ibm.as400.access.DataQueueEntry;
import com.ibm.as400.access.ProgramCall;
import com.ibm.as400.access.ProgramParameter;
import sirius.kernel.async.Operation;
import sirius.kernel.commons.Watch;
import sirius.kernel.health.Exceptions;
import sirius.kernel.nls.NLS;

import javax.annotation.Nonnull;
import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;

/**
 * Represents a connection to an IBM AS400 also known as i5.
 */
public class I5Connection {

    protected AS400 i5;
    protected I5ConnectionPool pool;
    protected boolean borrowed = false;
    protected long lastUse;
    protected String lastJob;

    /**
     * Releases / closes the connection.
     */
    public void release() {
        try {
            i5.disconnectAllServices();
        } catch (Throwable e) {
            throw Exceptions.handle()
                            .to(I5Connector.LOG)
                            .error(e)
                            .withSystemErrorMessage(
                                    "An error occurred while releasing an i5 connection of pool %s: %s (%s)",
                                    pool)
                            .handle();
        }
    }

    /**
     * Initializes the connection and verifies the installed version of OS400.
     */
    public void initialize() {
        try {
            if (i5.getVersion() < 6) {
                throw new IllegalStateException("We require at least V6R1M0 to run successfully");
            }

            pool.initConnection(this);
        } catch (Throwable e) {
            throw Exceptions.handle()
                            .to(I5Connector.LOG)
                            .error(e)
                            .withSystemErrorMessage(
                                    "An error occurred while creating an i5 connection for pool %s: %s (%s)",
                                    pool)
                            .handle();
        }
    }

    /**
     * Checks if the connection is still healthy.
     *
     * @return true if the connection is still healthy, false otherwise.
     */
    public boolean check() {
        return i5.isConnectionAlive(AS400.COMMAND);
    }

    /**
     * Closes the connection by returning it back to the connection pool.
     */
    public void close() {
        if (borrowed) {
            pool.returnConnection(this);
        }
    }

    /**
     * Calls a program on the i5.
     *
     * @param pgm    the name of the program to call
     * @param params the parameters to pass
     * @throws Exception in case on a communication or execution error
     */
    public void call(String pgm, ProgramParameter... params) throws Exception {
        Watch w = Watch.start();
        lastUse = System.currentTimeMillis();
        try {
            ProgramCall p = new ProgramCall(i5, pgm, params);
            if (I5Connector.LOG.isFINE()) {
                I5Connector.LOG.FINE("PGM: " + pgm);
                I5Connector.LOG.FINE("JOB-ID: " + p.getServerJob());
                I5Connector.LOG.FINE("JOB-NAME: " + p.getServerJob().getName());
            }
            String currentJob = pgm + "/" + p.getServerJob() + " / " + p.getServerJob().getName();
            lastJob = currentJob;

            AtomicBoolean success = new AtomicBoolean();
            Operation.cover("i5", () -> currentJob, Duration.ofMinutes(1), () -> {
                try {
                    success.set(p.run());
                } catch (Throwable t) {
                    throw Exceptions.handle()
                                    .to(I5Connector.LOG)
                                    .error(t)
                                    .withSystemErrorMessage("Error while executing '%s': %s (%s)", currentJob)
                                    .handle();
                }
            });
            if (!success.get()) {
                StringBuilder err = new StringBuilder();
                for (AS400Message msg : p.getMessageList()) {
                    err.append(msg.getText());
                }

                throw Exceptions.handle()
                                .to(I5Connector.LOG)
                                .withSystemErrorMessage("Error while executing '%s': %s", currentJob, err.toString())
                                .handle();
            }
            pool.i5Connector.callUtilization.addValue(p.getServerJob().getCPUUsed());
            if (I5Connector.LOG.isFINE()) {
                StringBuilder sb = new StringBuilder();
                for (ProgramParameter param : params) {
                    if (param.getOutputDataLength() > 0) {
                        sb.append("[");
                        sb.append(new String(param.getOutputData()));
                        sb.append("]\n");
                    }
                }
                I5Connector.LOG.FINE("i5-Call OUTPUT: " + pgm + " - " + sb);
            }
        } finally {
            w.submitMicroTiming("i5", "I5Connection.call#" + pgm);
            pool.i5Connector.calls.inc();
            pool.i5Connector.callDuration.addValue(w.elapsedMillis());
        }
    }

    /**
     * Reads all entries available in the given queue.
     *
     * @param queue          the name of the queue to read
     * @param timeoutSeconds the max timeout to wait for entries
     * @return the list of entries read
     * @throws Exception in case of a communication or host error
     */
    @Nonnull
    public List readQueue(String queue, int timeoutSeconds) throws Exception {
        List result = Lists.newArrayList();
        DataQueue q = new DataQueue(i5, queue);
        if (q != null) {
            DataQueueEntry entry = q.read(timeoutSeconds);
            while (entry != null) {
                result.add(entry);
                entry = q.read(timeoutSeconds);
            }
        }

        return result;
    }

    /**
     * Returns the timestamp of the last usage of this connection.
     *
     * @return the last time the connection was used as formatted timestamp
     */
    public String getLastUse() {
        return NLS.toUserString(Instant.ofEpochMilli(lastUse));
    }

    /**
     * The id of the last job executed on the host
     *
     * @return the id of the last job
     */
    public String getLastJob() {
        return lastJob;
    }

    /**
     * Determines if the connection is currently borrowed or not.
     *
     * @return true if the connection is currently in use, false if it is idle in a connection pool
     */
    public boolean isBorrowed() {
        return borrowed;
    }

    @Override
    public String toString() {
        return pool + ": " + i5;
    }
}