org.jodconverter.office.OnlineOfficeManager.java Source code

Introduction

Here is the source code for org.jodconverter.office.OnlineOfficeManager.java

Source

/*
 * Copyright 2004 - 2012 Mirko Nasato and contributors
 *           2016 - 2018 Simon Braconnier and contributors
 *
 * This file is part of JODConverter - Java OpenDocument Converter.
 *
 * 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 org.jodconverter.office;

import java.io.File;
import java.util.stream.IntStream;

import org.apache.commons.lang3.Validate;

import org.jodconverter.ssl.SslConfig;

/**
 * {@link OfficeManager} pool implementation that does not depend on an office installation to
 * process conversion taks.
 */
public final class OnlineOfficeManager extends AbstractOfficeManagerPool {

    private final int poolSize;
    private final String urlConnection;
    private final SslConfig sslConfig;

    /**
     * Creates a new builder instance.
     *
     * @return A new builder instance.
     */
    public static Builder builder() {
        return new Builder();
    }

    /**
     * Creates a new {@link OnlineOfficeManager} with default configuration.
     *
     * @param urlConnection The URL to the LibreOfficeOnline server.
     * @return A {@link OnlineOfficeManager} with default configuration.
     */
    public static OnlineOfficeManager make(final String urlConnection) {
        return builder().urlConnection(urlConnection).build();
    }

    /**
     * Creates a new {@link OnlineOfficeManager} with default configuration. The created manager will
     * then be the unique instance of the {@link InstalledOfficeManagerHolder} class. Note that if the
     * {@code InstalledOfficeManagerHolder} class already holds an {@code OfficeManager} instance, the
     * owner of this existing manager is responsible to stopped it.
     *
     * @param urlConnection The URL to the LibreOfficeOnline server.
     * @return A {@link OnlineOfficeManager} with default configuration.
     */
    public static OnlineOfficeManager install(final String urlConnection) {
        return builder().urlConnection(urlConnection).install().build();
    }

    private OnlineOfficeManager(final int poolSize, final String urlConnection, final SslConfig sslConfig,
            final OnlineOfficeManagerPoolConfig config) {
        super(poolSize, config);

        this.poolSize = poolSize;
        this.urlConnection = urlConnection;
        this.sslConfig = sslConfig;
    }

    @Override
    protected OnlineOfficeManagerPoolEntry[] createPoolEntries() {

        return IntStream.range(0, poolSize).mapToObj(idx -> new OnlineOfficeManagerPoolEntry(urlConnection,
                sslConfig, (OnlineOfficeManagerPoolEntryConfig) config))
                .toArray(OnlineOfficeManagerPoolEntry[]::new);
    }

    /**
     * A builder for constructing a {@link OnlineOfficeManager}.
     *
     * @see OnlineOfficeManager
     */
    public static final class Builder extends AbstractOfficeManagerPoolBuilder<Builder> {

        /** The default size of the pool. */
        public static final int DEFAULT_POOL_SIZE = 1;

        /** The maximum size of the pool. */
        public static final int MAX_POOL_SIZE = 1000;

        private int poolSize = DEFAULT_POOL_SIZE;
        private String urlConnection;
        private SslConfig sslConfig;

        // Private ctor so only OnlineOfficeManager can initialize an instance of this builder.
        private Builder() {
            super();
        }

        /**
         * Creates the converter that is specified by this builder.
         *
         * @return The converter that is specified by this builder.
         */
        public OnlineOfficeManager build() {

            Validate.notEmpty(urlConnection, "The URL connection is missing");

            if (workingDir == null) {
                workingDir = new File(System.getProperty("java.io.tmpdir"));
            }

            final OnlineOfficeManagerPoolConfig config = new OnlineOfficeManagerPoolConfig(workingDir);
            config.setTaskExecutionTimeout(taskExecutionTimeout);
            config.setTaskQueueTimeout(taskQueueTimeout);

            final OnlineOfficeManager manager = new OnlineOfficeManager(poolSize, urlConnection, sslConfig, config);
            if (install) {
                InstalledOfficeManagerHolder.setInstance(manager);
            }
            return manager;
        }

        /**
         * Specifies the pool size of the manager.
         *
         * @param poolSize The pool size.
         * @return This builder instance.
         */
        public Builder poolSize(final int poolSize) {

            Validate.inclusiveBetween(0, MAX_POOL_SIZE, poolSize,
                    String.format("The poolSize %s must be between %d and %d", poolSize, 1, MAX_POOL_SIZE));
            this.poolSize = poolSize;
            return this;
        }

        /**
         * Specifies the URL connection of the manager.
         *
         * @param urlConnection The URL connection.
         * @return This builder instance.
         */
        public Builder urlConnection(final String urlConnection) {

            Validate.notBlank(urlConnection);
            this.urlConnection = urlConnection;
            return this;
        }

        /**
         * Specifies the SSL configuration to secure communication with LibreOffice Online.
         *
         * @param sslConfig TheSSL configuration .
         * @return This builder instance.
         */
        public Builder sslConfig(final SslConfig sslConfig) {

            this.sslConfig = sslConfig;
            return this;
        }
    }
}