net.shibboleth.idp.saml.nameid.impl

Class JDBCPersistentIdStore

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.saml.nameid.impl.JDBCPersistentIdStore

All Implemented Interfaces:

IPersistentIdStore, PersistentIdStore, Component, DestructableComponent, InitializableComponent

Deprecated.

@Deprecated
public class JDBCPersistentIdStore
extends AbstractInitializableComponent
implements PersistentIdStore

JDBC-based storage management for SAML persistent IDs.

This is a deprecated version that relies on the older, racy interface for storage. It has been superseded by the JDBCPersistentIdStoreEx class.

The DDL for the database is CREATE TABLE shibpid {localEntity VARCHAR NOT NULL, peerEntity VARCHAR NOT NULL, principalName \\ VARCHAR NOT NULL, localId VARCHAR NOT NULL, persistentId VARCHAR NOT NULL, peerProvidedId \\ VARCHAR, creationDate TIMESTAMP NOT NULL, deactivationDate TIMESTAMP} .

Field Summary

Fields

Modifier and Type	Field and Description
private String	creationTimeColumn Deprecated. Name of the creation time column.
private DataSource	dataSource Deprecated. JDBC data source for retrieving connections.
private String	deactivateSQL Deprecated. SQL used to deactivate an ID.
private String	deactivationTimeColumn Deprecated. Name of the deactivation time column.
private String	idEntrySelectSQL Deprecated. Partial select query for ID entries.
private String	issuerColumn Deprecated. Name of the issuer entityID column.
private org.slf4j.Logger	log Deprecated. Class logger.
private String	peerProvidedIdColumn Deprecated. Name of recipient-attached alias column.
private String	persistentIdColumn Deprecated. Name of the persistent ID column.
private String	principalNameColumn Deprecated. Name of the principal name column.
private long	queryTimeout Deprecated. Timeout of SQL queries in milliseconds.
private String	recipientColumn Deprecated. Name of the recipient entityID column.
private String	sourceIdColumn Deprecated. Name of the source ID column.
private String	tableName Deprecated. Name of the database table.

Constructor Summary

Constructors

Constructor and Description
JDBCPersistentIdStore() Deprecated. Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private List<PersistentIdEntry>	buildIdentifierEntries(ResultSet resultSet) Deprecated. Builds a list of PersistentIdEntrys from a result set.
void	deactivate(String persistentId, DateTime deactivation) Deprecated.
protected void	doInitialize() Deprecated.
PersistentIdEntry	getActiveEntry(String persistentId) Deprecated.
PersistentIdEntry	getActiveEntry(String issuer, String recipient, String sourceId) Deprecated.
int	getCount(String issuer, String recipient, String sourceId) Deprecated.
String	getCreateTimeColumn() Deprecated. Get the name of the creation time column.
DataSource	getDataSource() Deprecated. Get the source datasource used to communicate with the database.
String	getDeactivationTimeColumn() Deprecated. Get the name of the deactivation time column.
private String	getInsertSql() Deprecated. Code to build the INSERT SQL required by storePersistentIdEntry.
String	getLocalEntityColumn() Deprecated. Get the name of the issuer entityID column.
private String	getLogPrefix() Deprecated. Return a string which is to be prepended to all log messages.
String	getPeerEntityColumn() Deprecated. Get the name of the recipient entityID column.
String	getPeerProvidedIdColumn() Deprecated. Get the name of the peer-provided ID column.
String	getPersistentIdColumn() Deprecated. Get the name of the persistent ID column.
private PersistentIdEntry	getPersistentIdEntry(String persistentId, boolean onlyActiveId) Deprecated. Get the entry for the given ID.
String	getPrincipalNameColumn() Deprecated. Get the name of the principal name column.
long	getQueryTimeout() Deprecated. Get the SQL query timeout.
String	getSourceIdColumn() Deprecated. Get the name of the source ID column.
String	getTableName() Deprecated. Get the table name.
boolean	isAvailable(String persistentId) Deprecated.
void	setCreateTimeColumn(String name) Deprecated. Set the name of the creation time column.
void	setDataSource(DataSource source) Deprecated. Set the source datasource used to communicate with the database.
void	setDeactivationTimeColumn(String name) Deprecated. Set the name of the deactivation time column.
void	setLocalEntityColumn(String name) Deprecated. Set the name of the issuer entityID column.
void	setPeerEntityColumn(String name) Deprecated. Set the name of the recipient entityID column.
void	setPeerProvidedIdColumn(String name) Deprecated. Set the name of the peer-provided ID column.
void	setPersistentIdColumn(String name) Deprecated. Set the name of the persistent ID column.
void	setPrincipalNameColumn(String name) Deprecated. Set the name of the principal name column.
void	setQueryTimeout(long timeout) Deprecated. Set the SQL query timeout.
void	setSourceIdColumn(String name) Deprecated. Set the name of the source ID column.
void	setTableName(String name) Deprecated. Set the table name.
void	store(PersistentIdEntry entry) Deprecated.
protected void	validatePersistentIdEntry(PersistentIdEntry entry) Deprecated. Check that the entry meets the constraints imposed by the SQL DDL.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Deprecated.

Class logger.

dataSource

@NonnullAfterInit
private DataSource dataSource

Deprecated.

JDBC data source for retrieving connections.

queryTimeout

@Duration
@NonNegative
private long queryTimeout

Deprecated.

Timeout of SQL queries in milliseconds.

tableName

@Nonnull
@NotEmpty
private String tableName

Deprecated.

Name of the database table.

issuerColumn

@Nonnull
@NotEmpty
private String issuerColumn

Deprecated.

Name of the issuer entityID column.

recipientColumn

@Nonnull
@NotEmpty
private String recipientColumn

Deprecated.

Name of the recipient entityID column.

principalNameColumn

@Nonnull
@NotEmpty
private String principalNameColumn

Deprecated.

Name of the principal name column.

sourceIdColumn

@Nonnull
@NotEmpty
private String sourceIdColumn

Deprecated.

Name of the source ID column.

persistentIdColumn

@Nonnull
@NotEmpty
private String persistentIdColumn

Deprecated.

Name of the persistent ID column.

peerProvidedIdColumn

@Nonnull
@NotEmpty
private String peerProvidedIdColumn

Deprecated.

Name of recipient-attached alias column.

creationTimeColumn

@Nonnull
@NotEmpty
private String creationTimeColumn

Deprecated.

Name of the creation time column.

deactivationTimeColumn

@Nonnull
@NotEmpty
private String deactivationTimeColumn

Deprecated.

Name of the deactivation time column.

idEntrySelectSQL

@NonnullAfterInit
private String idEntrySelectSQL

Deprecated.

Partial select query for ID entries.

deactivateSQL

@NonnullAfterInit
private String deactivateSQL

Deprecated.

SQL used to deactivate an ID.

Constructor Detail

JDBCPersistentIdStore

public JDBCPersistentIdStore()

Deprecated.

Constructor.

Method Detail

getTableName

@Nonnull
@NotEmpty
public String getTableName()

Deprecated.

Get the table name.

Returns:

table name

setTableName

public void setTableName(@Nonnull@NotEmpty
                String name)

Deprecated.

Set the table name.

Parameters:

name - table name

getLocalEntityColumn

@Nonnull
@NotEmpty
public String getLocalEntityColumn()

Deprecated.

Get the name of the issuer entityID column.

Returns:

name of issuer column

setLocalEntityColumn

public void setLocalEntityColumn(@Nonnull@NotEmpty
                        String name)

Deprecated.

Set the name of the issuer entityID column.

Parameters:

name - name of issuer column

getPeerEntityColumn

@Nonnull
@NotEmpty
public String getPeerEntityColumn()

Deprecated.

Get the name of the recipient entityID column.

Returns:

name of recipient column

setPeerEntityColumn

public void setPeerEntityColumn(@Nonnull@NotEmpty
                       String name)

Deprecated.

Set the name of the recipient entityID column.

Parameters:

name - name of recipient column

getPrincipalNameColumn

@Nonnull
@NotEmpty
public String getPrincipalNameColumn()

Deprecated.

Get the name of the principal name column.

Returns:

name of principal name column

setPrincipalNameColumn

public void setPrincipalNameColumn(@Nonnull@NotEmpty
                          String name)

Deprecated.

Set the name of the principal name column.

Parameters:

name - name of principal name column

getSourceIdColumn

@Nonnull
@NotEmpty
public String getSourceIdColumn()

Deprecated.

Get the name of the source ID column.

Returns:

name of source ID column

setSourceIdColumn

public void setSourceIdColumn(@Nonnull@NotEmpty
                     String name)

Deprecated.

Set the name of the source ID column.

Parameters:

name - name of source ID column

getPersistentIdColumn

@Nonnull
@NotEmpty
public String getPersistentIdColumn()

Deprecated.

Get the name of the persistent ID column.

Returns:

name of persistent ID column

setPersistentIdColumn

public void setPersistentIdColumn(@Nonnull@NotEmpty
                         String name)

Deprecated.

Set the name of the persistent ID column.

Parameters:

name - name of the persistent ID column

getPeerProvidedIdColumn

@Nonnull
@NotEmpty
public String getPeerProvidedIdColumn()

Deprecated.

Get the name of the peer-provided ID column.

Returns:

name of peer-provided ID column

setPeerProvidedIdColumn

public void setPeerProvidedIdColumn(@Nonnull@NotEmpty
                           String name)

Deprecated.

Set the name of the peer-provided ID column.

Parameters:

name - name of peer-provided ID column

getCreateTimeColumn

@Nonnull
@NotEmpty
public String getCreateTimeColumn()

Deprecated.

Get the name of the creation time column.

Returns:

name of creation time column

setCreateTimeColumn

public void setCreateTimeColumn(@Nonnull@NotEmpty
                       String name)

Deprecated.

Set the name of the creation time column.

Parameters:

name - name of creation time column

getDeactivationTimeColumn

@Nonnull
@NotEmpty
public String getDeactivationTimeColumn()

Deprecated.

Get the name of the deactivation time column.

Returns:

name of deactivation time column

setDeactivationTimeColumn

public void setDeactivationTimeColumn(@Nonnull@NotEmpty
                             String name)

Deprecated.

Set the name of the deactivation time column.

Parameters:

name - name of deactivation time column

getDataSource

@NonnullAfterInit
public DataSource getDataSource()

Deprecated.

Get the source datasource used to communicate with the database.

Returns:

the data source;

setDataSource

public void setDataSource(@Nonnull
                 DataSource source)

Deprecated.

Set the source datasource used to communicate with the database.

Parameters:

source - the data source

getQueryTimeout

@NonNegative
@Duration
public long getQueryTimeout()

Deprecated.

Get the SQL query timeout.

Returns:

the timeout in milliseconds

setQueryTimeout

@Duration
public void setQueryTimeout(@Duration@NonNegative
                            long timeout)

Deprecated.

Set the SQL query timeout.

Parameters:

timeout - the timeout to set in milliseconds

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Deprecated.

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

isAvailable

public boolean isAvailable(@Nonnull@NotEmpty
                  String persistentId)
                    throws IOException

Deprecated.

Specified by:

isAvailable in interface PersistentIdStore

Throws:

IOException

store

public void store(@Nonnull
         PersistentIdEntry entry)
           throws IOException

Deprecated.

Specified by:

store in interface PersistentIdStore

Throws:

IOException

getCount

public int getCount(@Nonnull@NotEmpty
           String issuer,
           @Nonnull@NotEmpty
           String recipient,
           @Nonnull@NotEmpty
           String sourceId)
             throws IOException

Deprecated.

Specified by:

getCount in interface PersistentIdStore

Throws:

IOException

getActiveEntry

@Nullable
public PersistentIdEntry getActiveEntry(@Nonnull@NotEmpty
                                        String persistentId)
                                 throws IOException

Deprecated.

Specified by:

getActiveEntry in interface PersistentIdStore

Throws:

IOException

getActiveEntry

@Nullable
public PersistentIdEntry getActiveEntry(@Nonnull@NotEmpty
                                        String issuer,
                                        @Nonnull@NotEmpty
                                        String recipient,
                                        @Nonnull@NotEmpty
                                        String sourceId)
                                 throws IOException

Deprecated.

Specified by:

getActiveEntry in interface PersistentIdStore

Throws:

IOException

deactivate

public void deactivate(@Nonnull@NotEmpty
              String persistentId,
              @Nullable
              DateTime deactivation)
                throws IOException

Deprecated.

Specified by:

deactivate in interface PersistentIdStore

Throws:

IOException

getPersistentIdEntry

@Nullable
private PersistentIdEntry getPersistentIdEntry(@Nonnull@NotEmpty
                                              String persistentId,
                                              boolean onlyActiveId)
                                        throws IOException

Deprecated.

Get the entry for the given ID.

Parameters:

persistentId - the persistent ID

onlyActiveId - true if only an active ID should be returned, false if a deactivated ID may be returned

Returns:

the ID entry for the given ID or null if none exists

Throws:

IOException - thrown if there is a problem communication with the database

validatePersistentIdEntry

protected void validatePersistentIdEntry(@Nonnull
                             PersistentIdEntry entry)
                                  throws SQLException

Deprecated.

Check that the entry meets the constraints imposed by the SQL DDL. localEntity VARCHAR NOT NULL,
peerEntity VARCHAR NOT NULL,
principalName VARCHAR NOT NULL,
localId VARCHAR NOT NULL,
persistentId VARCHAR NOT NULL,

Parameters:

entry - what to look at

Throws:

SQLException - if we go against the constraint.

getInsertSql

@Nonnull
@NotEmpty
private String getInsertSql()

Deprecated.

Code to build the INSERT SQL required by storePersistentIdEntry.

Returns:

the SQL statement

buildIdentifierEntries

@Nonnull
@NonnullElements
@Live
private List<PersistentIdEntry> buildIdentifierEntries(@Nonnull
                                                                          ResultSet resultSet)
                                                throws SQLException

Deprecated.

Builds a list of PersistentIdEntrys from a result set.

Parameters:

resultSet - the result set

Returns:

list of PersistentIdEntrys

Throws:

SQLException - thrown if there is a problem reading the information from the database

getLogPrefix

@Nonnull
@NotEmpty
private String getLogPrefix()

Deprecated.

Return a string which is to be prepended to all log messages.

Returns:

"Stored Id Store:"