org.ojai.store

Class DriverManager

java.lang.Object

org.ojai.store.DriverManager

@API.Public
 @API.Factory
public final class DriverManager
extends Object

A factory class to manage OJAI Drivers. This is the entry point for any OJAI implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	OJAI_PROTOCOL_PATTERN Pattern for OJAI Connection URLs.

Constructor Summary

Constructors

Constructor and Description
DriverManager()

Method Summary

Modifier and Type	Method and Description
static Connection	getConnection(String url) Establishes and returns a Connection to an OJAI data source.
static Connection	getConnection(String url, Document options) Establishes and returns a Connection to an OJAI data source.
static Driver	getDriver(String url) Discovers and loads the OJAI Driver implementation which supported the specified URL.
static void	registerDriver(Driver driver) Registers the specified Driver with this DriverManager.

Methods inherited from class java.lang.Object

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

Field Detail

OJAI_PROTOCOL_PATTERN

public static final Pattern OJAI_PROTOCOL_PATTERN

Pattern for OJAI Connection URLs.

Constructor Detail

DriverManager

public DriverManager()

Method Detail

getDriver

public static Driver getDriver(@API.NonNullable
                               String url)
                        throws OjaiException

Discovers and loads the OJAI Driver implementation which supported the specified URL.

Parameters:

url - a URL of the form "ojai:"

Throws:

NullPointerException - if the specified URL is null

IllegalArgumentException - if the specified URL does does not begin with "ojai:"

OjaiException - if no registered driver for found for the specified URL

getConnection

public static Connection getConnection(@API.NonNullable
                                       String url)
                                throws OjaiException

Establishes and returns a Connection to an OJAI data source. The returned Connection is thread-safe.

Parameters:

url - a URL of the form "ojai::[]"

Throws:

NullPointerException - if the specified URL is null

IllegalArgumentException - if the specified URL does does not begin with "ojai:"

OjaiException - if no registered driver for found for the specified URL

StoreException - if connection to the data-source failed

getConnection

public static Connection getConnection(@API.NonNullable
                                       String url,
                                       @API.NonNullable
                                       Document options)
                                throws OjaiException

Establishes and returns a Connection to an OJAI data source. The returned Connection is thread-safe.

Parameters:

url - a URL of the form "ojai::[]"

options - an OJAI Document of arbitrary, implementation specific settings

Throws:

NullPointerException - if the specified URL is null

IllegalArgumentException - if the specified URL does does not begin with "ojai:"

OjaiException - if no registered driver for found for the specified URL

StoreException - if connection to the data-source failed

registerDriver

@API.Internal
public static void registerDriver(@API.NonNullable
                                                Driver driver)

Registers the specified Driver with this DriverManager.

All OJAI Driver should register themselves with DriverManager during their class initialization using this method.