Package edu.internet2.middleware.subject.provider

Class JDBCSourceAdapter

java.lang.Object

edu.internet2.middleware.subject.provider.BaseSourceAdapter

edu.internet2.middleware.subject.provider.JDBCSourceAdapter

All Implemented Interfaces:

Source

Direct Known Subclasses:

HelperGrouperJdbcSourceAdapter, JDBCSourceAdapter2

public class JDBCSourceAdapter
extends BaseSourceAdapter

JDBC Source

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	errorOnMaxResults	if error if limit is reached
static boolean	failOnSearchForTesting	for testing if we should fail on testing
protected JdbcConnectionProvider	jdbcConnectionProvider	keep a reference to the object which gets our connections for us
protected Integer	maxResults	if there is a limit to the number of results
static int	queryCountforTesting	increment a query count for testing
protected String	subjectIDAttributeName	subject id attribute name
protected String	subjectTypeString	subject type string

Fields inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter

attributes, descriptionAttributeName, id, internalAttributes, name, nameAttributeName, params, searchAttributes, searches, sortAttributes, subjectIdentifierAttributes, subjectIdentifierAttributesAll, type, types

Constructor Summary

Constructors

Constructor	Description
JDBCSourceAdapter()	Allocates new JDBCSourceAdapter;
JDBCSourceAdapter(String id1, String name1)	Allocates new JDBCSourceAdapter;

Method Summary

Modifier and Type	Method	Description
void	checkConfig()	make sure the config is ok, and log descriptive errors if not
protected void	closeStatement(PreparedStatement stmt)
String	getDatabaseType()
String	getDescriptionAttributeName()
Integer	getMaxPage()	max Page size
String	getNameAttributeName()
protected ResultSet	getSqlResults(String searchValue, PreparedStatement stmt, Search search)	Set the parameters in the prepared statement and execute the query.
protected ResultSet	getSqlResults(List<String> batchIdsOrIdentifiers, PreparedStatement stmt, int numParameters, String sql)	Set the parameters in the prepared statement and execute the query.
Subject	getSubject(String id1)	Deprecated.
Subject	getSubject(String id1, boolean exceptionIfNull)	Gets a Subject by its ID.
Subject	getSubjectByIdentifier(String id1)	Deprecated.
Subject	getSubjectByIdentifier(String id1, boolean exceptionIfNull)	note, you should implement this method since this implementation will become abstract at some point
String	getSubjectIDAttributeName()
Map<Integer,String>	getSubjectIdentifierAttributes()	Get the names of attributes that are subject identifiers.
Map<Integer,String>	getSubjectIdentifierAttributesAll()	Get all the names of attributes that are subject identifiers.
Map<String,Subject>	getSubjectsByIdentifiers(Collection<String> identifiers)	Get subjects by identifiers.
Map<String,Subject>	getSubjectsByIds(Collection<String> ids)	Get subjects by ids.
String	getSubjectTypeString()
void	init()	Called by SourceManager when it loads this source.
boolean	isChangeSearchQueryForMaxResults()	if we should change the query based on max resuuls or page
boolean	isUseInClauseForIdAndIdentifier()	if we should use an in clause for id or identifier searches
protected Map<String,Set<String>>	loadAttributes(ResultSet rs)	Loads attributes for the argument subject.
static void	loadDriver(String sourceId, String driver)	Loads the the JDBC driver.
void	loggingStart()	start logging the source low level actions
String	loggingStop()	stop logging and get the output
protected PreparedStatement	prepareStatement(Search search, Connection conn, boolean searchAll, boolean firstPageOnly)	Prepare a statement handle from the search object.
String	printConfig()	in the startup on this i2mi app, print helpful and brief info about this source
Set<String>	retrieveAllSubjectIds()	get all subject ids
Set<Subject>	search(String searchValue)	Unstructured search for Subjects.
SearchPageResult	searchPage(String searchValue)	Unstructured search for Subjects.
protected void	setupDataSource(Properties props)	DataSource connection pool setup.
String	tryToChangeQuery(String query, Connection conn, int resultSetLimit)	try to change a paging query, note it will add one to the resultSetLimit so that the caller can see if there are too many records

Methods inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter

addAttribute, addInitParam, addInternalAttribute, addSubjectType, attributeNameToViewerGroupName, convertSourceAttributeToSubjectAttribute, convertSubjectAttributeToSourceAttribute, createSubject, equals, exportLabelToAttributeName, getAttributes, getConfigId, getId, getInitParam, getInternalAttributes, getName, getSearch, getSearchAttributes, getSearches, getSortAttributes, getSourceAttributesToLowerCase, getSubject, getSubjectByIdentifier, getSubjectByIdOrIdentifier, getSubjectByIdOrIdentifier, getSubjectsByIdentifiers, getSubjectsByIds, getSubjectsByIdsOrIdentifiers, getSubjectsByIdsOrIdentifiers, getSubjectStatusConfig, getSubjectType, getSubjectTypes, hashCode, initParams, isEditable, isEnabled, loadSearch, removeInitParam, resultSetLimit, search, searchPage, setConfigId, setId, setName, setSearchAttributes, setSearches, setSortAttributes, setSubjectIdentifierAttributes, setSubjectIdentifierAttributesAll, virtualAttributesForSource, virtualAttributesForSourceLegacy, virtualAttributeVariablesForSourceLegacy

Methods inherited from class java.lang.Object

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

Field Details

subjectIDAttributeName

protected String subjectIDAttributeName

subject id attribute name

subjectTypeString

protected String subjectTypeString

subject type string

maxResults

protected Integer maxResults

if there is a limit to the number of results

errorOnMaxResults

protected boolean errorOnMaxResults

if error if limit is reached

jdbcConnectionProvider

protected JdbcConnectionProvider jdbcConnectionProvider

keep a reference to the object which gets our connections for us

failOnSearchForTesting

public static boolean failOnSearchForTesting

for testing if we should fail on testing

queryCountforTesting

public static int queryCountforTesting

increment a query count for testing

Constructor Details

JDBCSourceAdapter

public JDBCSourceAdapter()

Allocates new JDBCSourceAdapter;

JDBCSourceAdapter

public JDBCSourceAdapter(String id1,
 String name1)

Allocates new JDBCSourceAdapter;

Parameters:

id1 -

name1 -

Method Details

loggingStart

public void loggingStart()

Description copied from interface: Source

start logging the source low level actions

loggingStop

public String loggingStop()

Description copied from interface: Source

stop logging and get the output

retrieveAllSubjectIds

public Set<String> retrieveAllSubjectIds()

Description copied from interface: Source

get all subject ids

Specified by:

retrieveAllSubjectIds in interface Source

Overrides:

retrieveAllSubjectIds in class BaseSourceAdapter

Returns:

all subjectIds

See Also:

• BaseSourceAdapter.retrieveAllSubjectIds()

tryToChangeQuery

public String tryToChangeQuery(String query,
 Connection conn,
 int resultSetLimit)

try to change a paging query, note it will add one to the resultSetLimit so that the caller can see if there are too many records

Parameters:

query -

conn -

resultSetLimit -

Returns:

the query with paging or original query if cant change it

getDatabaseType

public String getDatabaseType()

Returns:

the databaseType

isChangeSearchQueryForMaxResults

public boolean isChangeSearchQueryForMaxResults()

if we should change the query based on max resuuls or page

Returns:

the changeSearchQueryForMaxResults

getSubject

public Subject getSubject(String id1,
 boolean exceptionIfNull)
                   throws SubjectNotFoundException,
SubjectNotUniqueException

Gets a Subject by its ID.

Specified by:

getSubject in interface Source

Overrides:

getSubject in class BaseSourceAdapter

exceptionIfNull - if SubjectNotFoundException should be throws if the subject is null, or if null should be returned

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• Source.getSubject(java.lang.String, boolean)

getSubjectByIdentifier

public Subject getSubjectByIdentifier(String id1,
 boolean exceptionIfNull)
                               throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from class: BaseSourceAdapter

note, you should implement this method since this implementation will become abstract at some point

Specified by:

getSubjectByIdentifier in interface Source

Overrides:

getSubjectByIdentifier in class BaseSourceAdapter

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• BaseSourceAdapter.getSubjectByIdentifier(java.lang.String, boolean)

search

public Set<Subject> search(String searchValue)

Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema. Note if config param: throwErrorOnFindAllFailure is false, then swallow and log exceptions

Specified by:

search in interface Source

Specified by:

search in class BaseSourceAdapter

Returns:

set

searchPage

public SearchPageResult searchPage(String searchValue)

Description copied from interface: Source

Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema. Note if config param: throwErrorOnFindAllFailure is false, then swallow and log exceptions if maxPageSize is set in subject.properties, then only return max that many, and if there are more, set the tooManyResults flag

Specified by:

searchPage in interface Source

Overrides:

searchPage in class BaseSourceAdapter

Returns:

results and if there are too many, never return null!!!

See Also:

• BaseSourceAdapter.searchPage(java.lang.String)

prepareStatement

protected PreparedStatement prepareStatement(Search search,
 Connection conn,
 boolean searchAll,
 boolean firstPageOnly)
                                      throws InvalidQueryException,
SQLException

Prepare a statement handle from the search object.

Parameters:

search -

conn -

searchAll - true if a searchAll method

firstPageOnly -

Returns:

the prepared statement

Throws:

InvalidQueryException

SQLException

getSqlResults

protected ResultSet getSqlResults(String searchValue,
 PreparedStatement stmt,
 Search search)
                           throws SQLException

Set the parameters in the prepared statement and execute the query.

Parameters:

searchValue -

stmt -

search -

Returns:

resultSet

Throws:

SQLException

getSqlResults

protected ResultSet getSqlResults(List<String> batchIdsOrIdentifiers,
 PreparedStatement stmt,
 int numParameters,
 String sql)
                           throws SQLException

Set the parameters in the prepared statement and execute the query.

Parameters:

searchValue -

stmt -

search -

Returns:

resultSet

Throws:

SQLException

getSubjectsByIdentifiers

public Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers)

Description copied from interface: Source

Get subjects by identifiers. Note, if the subjects arent found or arent unique, they wont be returned. Identifiers are unique ways to refer to a subject that isnt its id (e.g. netid). Duplicates are ok on the input, but will return one output.

Specified by:

getSubjectsByIdentifiers in interface Source

Overrides:

getSubjectsByIdentifiers in class BaseSourceAdapter

Returns:

a map of results never null indexed by the identifiers

See Also:

• Source.getSubjectsByIdentifiers(Collection)

getSubjectsByIds

public Map<String,Subject> getSubjectsByIds(Collection<String> ids)

Description copied from interface: Source

Get subjects by ids. Note, if the subjects arent found or arent unique, they wont be returned. Duplicates are ok on the input, but will return one output.

Specified by:

getSubjectsByIds in interface Source

Overrides:

getSubjectsByIds in class BaseSourceAdapter

Returns:

a map of results never null indexed by the id

See Also:

• Source.getSubjectsByIds(Collection)

loadAttributes

protected Map<String,Set<String>> loadAttributes(ResultSet rs)

Loads attributes for the argument subject.

Parameters:

rs -

Returns:

attributes

init

public void init()
          throws SourceUnavailableException

Called by SourceManager when it loads this source.

Specified by:

init in interface Source

Specified by:

init in class BaseSourceAdapter

Throws:

SourceUnavailableException

loadDriver

public static void loadDriver(String sourceId,
 String driver)
                       throws SourceUnavailableException

Loads the the JDBC driver.

Parameters:

sourceId -

driver -

Throws:

SourceUnavailableException

setupDataSource

protected void setupDataSource(Properties props)
                        throws SourceUnavailableException

DataSource connection pool setup.

Parameters:

props -

Throws:

SourceUnavailableException

getMaxPage

public Integer getMaxPage()

max Page size

Returns:

the maxPage

isUseInClauseForIdAndIdentifier

public boolean isUseInClauseForIdAndIdentifier()

if we should use an in clause for id or identifier searches

Returns:

true if should

closeStatement

protected void closeStatement(PreparedStatement stmt)

Parameters:

stmt -

getDescriptionAttributeName

public String getDescriptionAttributeName()

Returns:

the descriptionAttributeName

getNameAttributeName

public String getNameAttributeName()

Returns:

the nameAttributeName

getSubjectIDAttributeName

public String getSubjectIDAttributeName()

Returns:

the subjectIDAttributeName

getSubjectTypeString

public String getSubjectTypeString()

Returns:

the subjectTypeString

checkConfig

public void checkConfig()

Description copied from interface: Source

make sure the config is ok, and log descriptive errors if not

See Also:

• Source.checkConfig()

printConfig

public String printConfig()

Description copied from interface: Source

in the startup on this i2mi app, print helpful and brief info about this source

Returns:

the info

See Also:

• Source.printConfig()

getSubject

@Deprecated
public Subject getSubject(String id1)
                   throws SubjectNotFoundException,
SubjectNotUniqueException

Deprecated.

Description copied from interface: Source

Gets a Subject by its ID.

Specified by:

getSubject in interface Source

Specified by:

getSubject in class BaseSourceAdapter

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• BaseSourceAdapter.getSubject(java.lang.String)

getSubjectByIdentifier

@Deprecated
public Subject getSubjectByIdentifier(String id1)
                               throws SubjectNotFoundException,
SubjectNotUniqueException

Deprecated.

Description copied from interface: Source

Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID.

Specified by:

getSubjectByIdentifier in interface Source

Specified by:

getSubjectByIdentifier in class BaseSourceAdapter

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• BaseSourceAdapter.getSubjectByIdentifier(java.lang.String)

getSubjectIdentifierAttributes

public Map<Integer,String> getSubjectIdentifierAttributes()

Description copied from interface: Source

Get the names of attributes that are subject identifiers. This only returns the first

Specified by:

getSubjectIdentifierAttributes in interface Source

Overrides:

getSubjectIdentifierAttributes in class BaseSourceAdapter

Returns:

subject identifiers

See Also:

• Source.getSubjectIdentifierAttributes()

getSubjectIdentifierAttributesAll

public Map<Integer,String> getSubjectIdentifierAttributesAll()

Description copied from interface: Source

Get all the names of attributes that are subject identifiers.

Specified by:

getSubjectIdentifierAttributesAll in interface Source

Overrides:

getSubjectIdentifierAttributesAll in class BaseSourceAdapter

Returns:

subject identifiers

See Also:

• Source.getSubjectIdentifierAttributesAll()