org.artofsolving.jodconverter.office.ExternalOfficeManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of de.devsurf.components.converter.integrations.openoffice Show documentation
The newest version!
/**
 * Copyright (C) 2010 Daniel Manzke 
 *
 * 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.
 */
//
// JODConverter - Java OpenDocument Converter
// Copyright 2009 Art of Solving Ltd
// Copyright 2004-2009 Mirko Nasato
//
// JODConverter is free software: you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation, either version 3 of
// the License, or (at your option) any later version.
//
// JODConverter is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General
// Public License along with JODConverter.  If not, see
// .
//
package org.artofsolving.jodconverter.office;

import java.net.ConnectException;

/**
 * {@link OfficeManager} implementation that connects to an external
 * Office process.
 * 
 * The external Office process needs to be started manually, e.g. from the
 * command line with
 * 
 * soffice -accept="socket,host=127.0.0.1,port=2002;urp;"
 * 
 * 
 * Since this implementation does not manage the Office process, it does not
 * support auto-restarting the process if it exits unexpectedly.
 * 

 * It will however auto-reconnect to the external process if the latter is
 * manually restarted.
 * 
 * This {@link OfficeManager} implementation basically provides the same
 * behaviour as JODConverter 2.x, including using synchronized blocks
 * for serialising office operations.
 */
class ExternalOfficeManager implements OfficeManager {

    private final OfficeConnection connection;
    private final boolean connectOnStart;

    /**
     * @param unoUrl
     * @param connectOnStart should a connection be attempted on
     *   {@link #start()}? Default is true. If false, a
     *   connection will only be attempted the first time an {@link OfficeTask} is executed.
     */
    public ExternalOfficeManager(UnoUrl unoUrl, boolean connectOnStart) {
        connection = new OfficeConnection(unoUrl);
        this.connectOnStart = connectOnStart;
    }

    public void start() throws OfficeException {
        if (connectOnStart) {
            synchronized (connection) {
                connect();
            }
        }
    }

    public void stop() {
        synchronized (connection) {
            if (connection.isConnected()) {
                connection.disconnect();
            }
        }
    }

    public void execute(OfficeTask task) throws OfficeException {
        synchronized (connection) {
            if (!connection.isConnected()) {
                connect();
            }
            task.execute(connection);
        }
    }

    private void connect() {
        try {
            connection.connect();
        } catch (ConnectException connectException) {
            throw new OfficeException("could not connect to external office process", connectException);
        }
    }

}