de.aristaflow.adept2.extensions.filerodatasource

Interface FileroDataSource

All Superinterfaces:

ADEPT2Service

public interface FileroDataSource
extends ADEPT2Service

Creates and manages connections to a FILERO server. Use Filero to create data sources.

See Also:

Filero

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(java.lang.String userName, java.lang.String password) Authenticates the designated user with the designated password at the FILERO server of this data source.
FileroConnection	getConnection() Returns a connection that can be used to access FILERO.
FileroConnection	getConnection(java.lang.String username) Returns a connection that can be used to access FILERO.

Methods inherited from interface de.aristaflow.adept2.base.service.ADEPT2Service

getLocalUris, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, init, ping, preShutdown, shutdown, start

Method Detail

getConnection

FileroConnection getConnection()
                        throws FileroException

Returns a connection that can be used to access FILERO. All access will be performed in the name of a singular (typically technical) user provided in the configuration of this data source. This method may block until a connection becomes available. I.e. it is important to release the connection after usage.

Returns:

a connection that can be used to access FILERO

Throws:

FileroAuthenticationException - if the login was unsuccessful

FileroInterruptedException - if the thread waiting to acquire a connection was interrupted

FileroException - if a connection could not be acquired

getConnection

FileroConnection getConnection(java.lang.String username)
                        throws FileroException

Returns a connection that can be used to access FILERO. All access will be performed in the name of the specified user. This method may block until a connection becomes available. I.e. it is important to release the connection after usage.

Parameters:

username - the user in whose name all access will be performed

Returns:

a connection that can be used to access FILERO

Throws:

FileroAuthenticationException - if the login was unsuccessful

FileroInterruptedException - if the thread waiting to acquire a connection was interrupted

FileroException - if a connection could not be acquired

authenticate

boolean authenticate(java.lang.String userName,
                     java.lang.String password)
              throws FileroException

Authenticates the designated user with the designated password at the FILERO server of this data source. This just verifies the designated user and password and has no further effect.

Parameters:

userName - The name of the user who to authenticate at FILERO.

password - The password with which to authenticate the user at FILERO.

Returns:

Whether the designated user has been successfully authenticated with the designated password at FILERO.

Throws:

FileroException - If there are (technical) problems accessing FILERO, a FileroException will be thrown.