Package org.sonews.storage.impl.jdbc

Klasse JDBCDatabase

java.lang.Object

org.sonews.storage.impl.jdbc.JDBCDatabase

Alle implementierten Schnittstellen:

Storage

@Component
@Scope("prototype")
public class JDBCDatabase
extends Object
implements Storage

Storage backend facade class for a relational SQL database using JDBC. The statements used should work for at least PostgreSQL and MySQL.

Seit:

sonews/0.5.0

Autor:

Christian Lins

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected Connection	conn
private org.slf4j.Logger	log
static final int	MAX_RESTARTS
protected PreparedStatement	pstmtAddArticle1
protected PreparedStatement	pstmtAddArticle2
protected PreparedStatement	pstmtAddArticle3
protected PreparedStatement	pstmtAddArticle4
protected PreparedStatement	pstmtCountArticles
protected PreparedStatement	pstmtCreateOrUpdateGroup0
protected PreparedStatement	pstmtCreateOrUpdateGroup1
protected PreparedStatement	pstmtCreateOrUpdateGroup2
protected PreparedStatement	pstmtCreateOrUpdateGroup3
protected PreparedStatement	pstmtDeleteArticle0
protected PreparedStatement	pstmtDeleteArticle1
protected PreparedStatement	pstmtDeleteArticle2
protected PreparedStatement	pstmtDeleteArticle3
protected PreparedStatement	pstmtGetArticle0
protected PreparedStatement	pstmtGetArticle1
protected PreparedStatement	pstmtGetArticleHeaders0
protected PreparedStatement	pstmtGetArticleHeaders1
protected PreparedStatement	pstmtGetArticleHeads
protected PreparedStatement	pstmtGetArticleIDs
protected PreparedStatement	pstmtGetArticleIndex
protected PreparedStatement	pstmtGetFirstArticleNumber
protected PreparedStatement	pstmtGetGroups
protected PreparedStatement	pstmtGetLastArticleNumber
protected PreparedStatement	pstmtGetMaxArticleID
protected PreparedStatement	pstmtGetMaxArticleIndex
protected PreparedStatement	pstmtGetOldestArticle
protected PreparedStatement	pstmtGetPostingsCount
protected PreparedStatement	pstmtIsArticleExisting
protected PreparedStatement	pstmtPurgeGroup0
protected PreparedStatement	pstmtPurgeGroup1
protected PreparedStatement	pstmtUpdateWatermark
protected int	restarts	How many times the database connection was reinitialized

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
JDBCDatabase()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addArticle(Article article)	Adds an article to the database.
protected void	addArticle(Article article, int newArticleID)	Adds an article to the database.
protected void	arise()	Rises the database: reconnect and recreate all prepared statements.
boolean	authenticateUser(String username, char[] password)	TODO Move to separate Authentication Backend
void	close()	Closes the JDBCDatabase connection.
protected void	closeResultSet(ResultSet rs)
int	countArticles()
void	createOrUpdateGroup(Group group)
void	delete(String messageID)
Article	getArticle(long articleIndex, long gid)	Retrieves an article by its ID.
Article	getArticle(String messageID)
private String	getArticleHeaders(long articleID)
List<Pair<Long,String>>	getArticleHeaders(Group group, long start, long end, String headerKey, String patStr)	Searches for fitting header values using the given regular expression.
List<Pair<Long,Article>>	getArticleHeads(Group group, long first, long last)	Returns a list of Long/ArticleImpl Pairs.
long	getArticleIndex(Article article, Group group)
List<Long>	getArticleNumbers(long gid)
int	getFirstArticleNumber(Group group)
List<Group>	getGroups()
int	getLastArticleNumber(Group group)
private int	getMaxArticleID()	This method is only called by addArticle which is already synchronized, so we do not need a synchronization here.
private int	getMaxArticleIndex(long groupID)	Returns the largest article index (watermark) in this very group.
String	getOldestArticle()
int	getPostingsCount(String groupname)
boolean	isArticleExisting(String messageID)	Checks if there is an article with the given messageid in the JDBCDatabase.
protected void	prepareGetPostingsCountStatement()
void	purgeGroup(Group group)	Performes a purge operation in the storage backend, e.g. to delete old messages or release allocated resources.
protected void	restartConnection(SQLException cause)	Restart the JDBC connection to the Database server.
boolean	update(Article article)	Updates headers and group references of the given article.
protected void	updateWatermark(Group group, long watermark)

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

MAX_RESTARTS

public static final int MAX_RESTARTS

Siehe auch:

• Konstantenfeldwerte

log

private org.slf4j.Logger log

conn

protected Connection conn

pstmtAddArticle1

protected PreparedStatement pstmtAddArticle1

pstmtAddArticle2

protected PreparedStatement pstmtAddArticle2

pstmtAddArticle3

protected PreparedStatement pstmtAddArticle3

pstmtAddArticle4

protected PreparedStatement pstmtAddArticle4

pstmtCountArticles

protected PreparedStatement pstmtCountArticles

pstmtCreateOrUpdateGroup0

protected PreparedStatement pstmtCreateOrUpdateGroup0

pstmtCreateOrUpdateGroup1

protected PreparedStatement pstmtCreateOrUpdateGroup1

pstmtCreateOrUpdateGroup2

protected PreparedStatement pstmtCreateOrUpdateGroup2

pstmtCreateOrUpdateGroup3

protected PreparedStatement pstmtCreateOrUpdateGroup3

pstmtDeleteArticle0

protected PreparedStatement pstmtDeleteArticle0

pstmtDeleteArticle1

protected PreparedStatement pstmtDeleteArticle1

pstmtDeleteArticle2

protected PreparedStatement pstmtDeleteArticle2

pstmtDeleteArticle3

protected PreparedStatement pstmtDeleteArticle3

pstmtGetArticle0

protected PreparedStatement pstmtGetArticle0

pstmtGetArticle1

protected PreparedStatement pstmtGetArticle1

pstmtGetArticleHeaders0

protected PreparedStatement pstmtGetArticleHeaders0

pstmtGetArticleHeaders1

protected PreparedStatement pstmtGetArticleHeaders1

pstmtGetArticleHeads

protected PreparedStatement pstmtGetArticleHeads

pstmtGetArticleIDs

protected PreparedStatement pstmtGetArticleIDs

pstmtGetArticleIndex

protected PreparedStatement pstmtGetArticleIndex

pstmtGetFirstArticleNumber

protected PreparedStatement pstmtGetFirstArticleNumber

pstmtGetGroups

protected PreparedStatement pstmtGetGroups

pstmtGetLastArticleNumber

protected PreparedStatement pstmtGetLastArticleNumber

pstmtGetMaxArticleID

protected PreparedStatement pstmtGetMaxArticleID

pstmtGetMaxArticleIndex

protected PreparedStatement pstmtGetMaxArticleIndex

pstmtGetOldestArticle

protected PreparedStatement pstmtGetOldestArticle

pstmtGetPostingsCount

protected PreparedStatement pstmtGetPostingsCount

pstmtIsArticleExisting

protected PreparedStatement pstmtIsArticleExisting

pstmtPurgeGroup0

protected PreparedStatement pstmtPurgeGroup0

pstmtPurgeGroup1

protected PreparedStatement pstmtPurgeGroup1

pstmtUpdateWatermark

protected PreparedStatement pstmtUpdateWatermark

restarts

protected int restarts

How many times the database connection was reinitialized

Konstruktordetails

JDBCDatabase

public JDBCDatabase()

Methodendetails

prepareGetPostingsCountStatement

protected void prepareGetPostingsCountStatement()
                                         throws SQLException

Löst aus:

SQLException

arise

@PostConstruct
protected void arise()
              throws SQLException

Rises the database: reconnect and recreate all prepared statements.

Löst aus:

SQLException

closeResultSet

protected void closeResultSet(ResultSet rs)

addArticle

public void addArticle(Article article)
                throws StorageBackendException

Adds an article to the database.

Angegeben von:

addArticle in Schnittstelle Storage

Parameter:

article -

Löst aus:

StorageBackendException

addArticle

protected void addArticle(Article article,
 int newArticleID)
                   throws SQLException,
StorageBackendException

Adds an article to the database. Method is not synchronized as it is only called by an already synchronized method.

Parameter:

article -

newArticleID -

Löst aus:

SQLException

StorageBackendException

countArticles

public int countArticles()
                  throws StorageBackendException

Angegeben von:

countArticles in Schnittstelle Storage

Löst aus:

StorageBackendException

createOrUpdateGroup

public void createOrUpdateGroup(Group group)
                         throws StorageBackendException

Angegeben von:

createOrUpdateGroup in Schnittstelle Storage

Löst aus:

StorageBackendException

delete

public void delete(String messageID)
            throws StorageBackendException

Angegeben von:

delete in Schnittstelle Storage

Löst aus:

StorageBackendException

getArticle

public Article getArticle(String messageID)
                   throws StorageBackendException

Angegeben von:

getArticle in Schnittstelle Storage

Löst aus:

StorageBackendException

getArticle

public Article getArticle(long articleIndex,
 long gid)
                   throws StorageBackendException

Retrieves an article by its ID.

Angegeben von:

getArticle in Schnittstelle Storage

Parameter:

articleIndex -

gid -

Gibt zurück:

Löst aus:

StorageBackendException

getArticleHeaders

public List<Pair<Long,String>> getArticleHeaders(Group group,
 long start,
 long end,
 String headerKey,
 String patStr)
                                          throws StorageBackendException,
PatternSyntaxException

Searches for fitting header values using the given regular expression.

Angegeben von:

getArticleHeaders in Schnittstelle Storage

Parameter:

group -

start -

end -

headerKey -

patStr -

Gibt zurück:

Löst aus:

StorageBackendException

PatternSyntaxException

getArticleHeaders

private String getArticleHeaders(long articleID)
                          throws StorageBackendException

Löst aus:

StorageBackendException

getArticleIndex

public long getArticleIndex(Article article,
 Group group)
                     throws StorageBackendException

Angegeben von:

getArticleIndex in Schnittstelle Storage

Löst aus:

StorageBackendException

getArticleHeads

public List<Pair<Long,Article>> getArticleHeads(Group group,
 long first,
 long last)
                                         throws StorageBackendException

Returns a list of Long/ArticleImpl Pairs.

Angegeben von:

getArticleHeads in Schnittstelle Storage

Parameter:

group -

first -

last -

Gibt zurück:

Löst aus:

StorageBackendException

getArticleNumbers

public List<Long> getArticleNumbers(long gid)
                             throws StorageBackendException

Angegeben von:

getArticleNumbers in Schnittstelle Storage

Löst aus:

StorageBackendException

getMaxArticleIndex

private int getMaxArticleIndex(long groupID)
                        throws StorageBackendException

Returns the largest article index (watermark) in this very group. Currently this method returns an int but this is probably not enough for VERY large (or old) groups. The SQL template was changed to BIGINT but some servers may still use INTEGER here.

Parameter:

groupID -

Gibt zurück:

Löst aus:

StorageBackendException

getGroups

public List<Group> getGroups()
                      throws StorageBackendException

Angegeben von:

getGroups in Schnittstelle Storage

Löst aus:

StorageBackendException

getMaxArticleID

private int getMaxArticleID()
                     throws StorageBackendException

This method is only called by addArticle which is already synchronized, so we do not need a synchronization here.

Gibt zurück:

Löst aus:

StorageBackendException

getLastArticleNumber

public int getLastArticleNumber(Group group)
                         throws StorageBackendException

Angegeben von:

getLastArticleNumber in Schnittstelle Storage

Löst aus:

StorageBackendException

getFirstArticleNumber

public int getFirstArticleNumber(Group group)
                          throws StorageBackendException

Angegeben von:

getFirstArticleNumber in Schnittstelle Storage

Löst aus:

StorageBackendException

getOldestArticle

public String getOldestArticle()
                        throws StorageBackendException

Angegeben von:

getOldestArticle in Schnittstelle Storage

Löst aus:

StorageBackendException

getPostingsCount

public int getPostingsCount(String groupname)
                     throws StorageBackendException

Angegeben von:

getPostingsCount in Schnittstelle Storage

Löst aus:

StorageBackendException

isArticleExisting

public boolean isArticleExisting(String messageID)
                          throws StorageBackendException

Checks if there is an article with the given messageid in the JDBCDatabase.

Angegeben von:

isArticleExisting in Schnittstelle Storage

Parameter:

messageID -

Gibt zurück:

Löst aus:

StorageBackendException

close

@PreDestroy
public void close()

Closes the JDBCDatabase connection.

purgeGroup

public void purgeGroup(Group group)
                throws StorageBackendException

Beschreibung aus Schnittstelle kopiert: Storage

Performes a purge operation in the storage backend, e.g. to delete old messages or release allocated resources.

Angegeben von:

purgeGroup in Schnittstelle Storage

Parameter:

group -

Löst aus:

StorageBackendException

restartConnection

protected void restartConnection(SQLException cause)
                          throws StorageBackendException

Restart the JDBC connection to the Database server.

Parameter:

cause -

Löst aus:

StorageBackendException

update

public boolean update(Article article)
               throws StorageBackendException

Beschreibung aus Schnittstelle kopiert: Storage

Updates headers and group references of the given article.

Angegeben von:

update in Schnittstelle Storage

Parameter:

article -

Gibt zurück:

Löst aus:

StorageBackendException

updateWatermark

protected void updateWatermark(Group group,
 long watermark)
                        throws StorageBackendException

Löst aus:

StorageBackendException

authenticateUser

public boolean authenticateUser(String username,
 char[] password)
                         throws StorageBackendException

Beschreibung aus Schnittstelle kopiert: Storage

TODO Move to separate Authentication Backend

Angegeben von:

authenticateUser in Schnittstelle Storage

Parameter:

username -

password -

Gibt zurück:

Löst aus:

StorageBackendException