the.driver

Class TheDriver

java.lang.Object

fr.gouv.vitam.storage.driver.AbstractDriver

the.driver.TheDriver

All Implemented Interfaces:

VitamAutoCloseable, Driver, AutoCloseable

public class TheDriver
extends AbstractDriver

Implementation of driver

Field Summary

Fields inherited from class fr.gouv.vitam.storage.driver.AbstractDriver

connectionFactories

Constructor Summary

Constructors

Constructor and Description
TheDriver()

Method Summary

Modifier and Type	Method and Description
protected VitamClientFactoryInterface	addInternalOfferAsFactory(StorageOffer offer, Properties parameters) This method must be implemented in the final Driver Implementation to add the ClientFactory to the driver
Connection	connect(String offerId) Create a connection to the distant offer service based on given offer Id name.
int	getMajorVersion() Retrieves the driver's major version number.
int	getMinorVersion() Retrieves the driver's minor version number.
String	getName() The driver implementation MUST provide a constant name which SHOULD be shared accross instances of the same driver implementation.
boolean	isStorageOfferAvailable(String s, Properties properties) Is Storage Offer Available

Methods inherited from class fr.gouv.vitam.storage.driver.AbstractDriver

addOffer, close, hasOffer, isStorageOfferAvailable, removeOffer

Methods inherited from class java.lang.Object

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

Constructor Detail

TheDriver

public TheDriver()

Method Detail

isStorageOfferAvailable

public boolean isStorageOfferAvailable(String s,
                                       Properties properties)
                                throws StorageDriverException

Is Storage Offer Available

Parameters:

s -

properties -

Returns:

false

Throws:

StorageDriverException

getName

public String getName()

Description copied from interface: Driver

The driver implementation MUST provide a constant name which SHOULD be shared accross instances of the same driver implementation. Then it is strongly recommended to use a static final field in your driver implementation.

This name MAY be used in user interface to provide information on the driver.

Returns:

The name of the driver which SHOULD be constant

getMajorVersion

public int getMajorVersion()

Description copied from interface: Driver

Retrieves the driver's major version number.

This number MAY be used in user interface to provide information on the driver.

Returns:

this driver's major version number

getMinorVersion

public int getMinorVersion()

Description copied from interface: Driver

Retrieves the driver's minor version number.

This number MAY be used in user interface to provide information on the driver.

Returns:

this driver's minor version number

connect

public Connection connect(String offerId)
                   throws StorageDriverException

Description copied from interface: Driver

Create a connection to the distant offer service based on given offer Id name. If no connection could be made, the driver MUST throw a StorageException

Parameters:

offerId - the offerId name

Returns:

a connection which MUST contains all necessary parameters and initial configurations to allow further requests to the distant offer service without needing to pass parameters/configurations.

Throws:

StorageDriverException - if any problem occurs during connection

addInternalOfferAsFactory

protected VitamClientFactoryInterface addInternalOfferAsFactory(StorageOffer offer,
                                                                Properties parameters)

Description copied from class: AbstractDriver

This method must be implemented in the final Driver Implementation to add the ClientFactory to the driver

Specified by:

addInternalOfferAsFactory in class AbstractDriver

Returns:

true if added