Skip navigation links

com.oracle.outsidein
Class OutsideIn

java.lang.Object
com.oracle.outsidein.OutsideIn

public class OutsideIn

extends java.lang.Object

Class for instantiating a concrete Exporter object through static factory methods. Currently, only a local Exporter object is supported.

Method Summary

static OutsideInVersion	getCoreVersion() Retrieves the version information of the underlying native OutsideIn libraries.
static Exporter	newLocalExporter() Creates a new Exporter object that processes conversions on the local machine.
static Exporter	newLocalExporter(Exporter toClone) Clones an Exporter object that processes conversions on the local machine.
static Exporter	newLocalExporter(java.lang.String username) Used internally by the Outside In API, and not to be used externally.
static void	setLocation(java.io.File oilinkDir) Sets an explicit path to the native Outside In libraries and oilink.exe.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newLocalExporter

public static Exporter newLocalExporter()
                                 throws OutsideInException

Creates a new Exporter object that processes conversions on the local machine. Although the source documents and destination files may be redirected from/to any location, all processing is executed using the local machine's resources.

Returns:

a concrete Exporter object

Throws:

OutsideInException - if the underlying technology (oilink) fails to initialize

newLocalExporter

public static Exporter newLocalExporter(java.lang.String username)
                                 throws OutsideInException

Used internally by the Outside In API, and not to be used externally.

Throws:

OutsideInException

newLocalExporter

public static Exporter newLocalExporter(Exporter toClone)
                                 throws OutsideInException

Clones an Exporter object that processes conversions on the local machine. Although the source documents and destination files may be redirected from/to any location, all export processing is executed using the local machine's resources. All option values in the original Exporter object are copied into the cloned Exporter object except the SourceFile and DestinationFile options. Annotations do not get copied to the new cloned Exporter object.

Parameters:

toClone - The exporter object to clone

Returns:

a new concrete Exporter object with the same options as the provided exporter toClone

Throws:

OutsideInException - if the underlying technology (oilink) fails to initialize

getCoreVersion

public static OutsideInVersion getCoreVersion()

Retrieves the version information of the underlying native OutsideIn libraries.

Returns:

object containing the version information

setLocation

public static void setLocation(java.io.File oilinkDir)
                        throws OutsideInException

Sets an explicit path to the native Outside In libraries and oilink.exe. If used, this method must be called prior to any other Outside In method or this method will throw an exception. If setLocation() is not used, the location will be determined by searching for the Outside In libraries in the following order:

1. the location specified in the 'OILinkLocation' Java property
2. the 'oit' subdirectory under the directory containing oilink.jar
3. the directory containing oilink.jar

Parameters:

oilinkDir - a File object that references the directory containing the native Outside In libraries

Throws:

OutsideInException - if the location has already been set or the underlying technology (oilink) cannot be executed

java.lang.IllegalArgumentException - if the specified location does not exist or the location does not reference a directory

Skip navigation links