edu.internet2.middleware.subject.provider

Class JDBCSourceAdapter2

java.lang.Object

edu.internet2.middleware.subject.provider.BaseSourceAdapter

edu.internet2.middleware.subject.provider.JDBCSourceAdapter

edu.internet2.middleware.subject.provider.JDBCSourceAdapter2

All Implemented Interfaces:

Source

Direct Known Subclasses:

HelperGrouperJdbcSourceAdapter2

public class JDBCSourceAdapter2
extends JDBCSourceAdapter

jdbc source adapter based on one table with more complex searches

Field Summary

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

descriptionAttributeName, failOnSearchForTesting, jdbcConnectionProvider, maxResults, nameAttributeName, queryCountforTesting, subjectIDAttributeName, subjectTypeString

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

attributes, id, internalAttributes, name, params, searchAttributes, searches, sortAttributes, type, types

Constructor Summary

Constructors

Constructor and Description
JDBCSourceAdapter2()
JDBCSourceAdapter2(String id, String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkConfig() make sure the config is ok, and log descriptive errors if not
protected String	dbTableOrView() get the db table or view, considering realm
String	getDbTableOrView() table or view where each row is a subject dbTableOrView
String	getDefaultSortCol() search queries will sort by this.
String	getDescriptionCol()
String	getLowerSearchCol() for searches (not by id or identifier), this is the col which holds the search terms, in lower case lowerSearchCol
String	getNameCol() column which holds the subject name nameCol
Subject	getSubject(String id1, boolean exceptionIfNull) Gets a Subject by its ID.
Subject	getSubject(String id1, boolean exceptionIfNull, String realm) Gets a Subject by its ID.
Map<String,String>	getSubjectAttributeColToName() map of col to attribute name //subjectAttributeCol0 //subjectAttributeName0
Subject	getSubjectByIdentifier(String identifier, boolean exceptionIfNull) note, you should implement this method since this implementation will become abstract at some point
Subject	getSubjectByIdentifier(String identifier, boolean exceptionIfNull, String realm) Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID.
Subject	getSubjectByIdOrIdentifier(String idOrIdentifier, boolean exceptionIfNull) find by id or identifier
Subject	getSubjectByIdOrIdentifier(String idOrIdentifier, boolean exceptionIfNull, String realm) find by id or identifier.
String	getSubjectIdCol() column which holds the subject id subjectIdCol
Set<String>	getSubjectIdentifierCols() cols which are used in a findByIdentifier query subjectIdentifierCol0
Map<String,Subject>	getSubjectsByIdentifiers(Collection<String> identifiers) Get subjects by identifiers.
Map<String,Subject>	getSubjectsByIdentifiers(Collection<String> identifiers, String realm) Get subjects by identifiers.
Map<String,Subject>	getSubjectsByIds(Collection<String> ids) Get subjects by ids.
Map<String,Subject>	getSubjectsByIds(Collection<String> ids, String realm) Get subjects by ids.
Map<String,Subject>	getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers) Get subjects by ids or identifiers.
Map<String,Subject>	getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers, String realm) Get subjects by ids or identifiers.
protected Map<String,Set<String>>	loadAttributes(ResultSet resultSet, String query, ResultSetMetaData resultSetMetaData) Loads attributes for the argument subject.
Set<Subject>	search(String searchValue) Unstructured search for Subjects.
Set<Subject>	search(String searchValue, String realm) Unstructured search for Subjects.
SearchPageResult	searchPage(String searchValue) Unstructured search for Subjects.
SearchPageResult	searchPage(String searchValue, String realm) Unstructured search for Subjects.
void	setDbTableOrView(String dbTableOrView1) table or view where each row is a subject dbTableOrView
void	setDefaultSortCol(String defaultSortCol1) search queries will sort by this.
void	setDescriptionCol(String descriptionCol1)
void	setLowerSearchCol(String lowerSearchCol1) for searches (not by id or identifier), this is the col which holds the search terms, in lower case lowerSearchCol
void	setNameCol(String nameCol1) column which holds the subject name nameCol
void	setSubjectAttributeColToName(Map<String,String> subjectAttributeColToName1) map of col to attribute name //subjectAttributeCol0 //subjectAttributeName0
void	setSubjectIdCol(String subjectIdCol1) column which holds the subject id subjectIdCol
void	setSubjectIdentifierCols(Set<String> subjectIdentifierCols1) cols which are used in a findByIdentifier query subjectIdentifierCol0
protected void	setupDataSource(Properties props) DataSource connection pool setup.

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

closeStatement, getDatabaseType, getDescriptionAttributeName, getMaxPage, getNameAttributeName, getSqlResults, getSqlResults, getSubject, getSubjectByIdentifier, getSubjectIDAttributeName, getSubjectTypeString, init, isChangeSearchQueryForMaxResults, isUseInClauseForIdAndIdentifier, loadAttributes, loadDriver, prepareStatement, printConfig, tryToChangeQuery

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

addAttribute, addInitParam, addInternalAttribute, addSubjectType, equals, getAttributes, getId, getInitParam, getInternalAttributes, getName, getSearch, getSearchAttributes, getSearches, getSortAttributes, getSubjectStatusConfig, getSubjectType, getSubjectTypes, hashCode, initParams, loadSearch, removeInitParam, resultSetLimit, setId, setName, setSearchAttributes, setSearches, setSortAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCSourceAdapter2

public JDBCSourceAdapter2()

JDBCSourceAdapter2

public JDBCSourceAdapter2(String id,
                  String name)

Parameters:

id -

name -

Method Detail

checkConfig

public void checkConfig()

Description copied from interface: Source

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

Specified by:

checkConfig in interface Source

Overrides:

checkConfig in class JDBCSourceAdapter

See Also:

Source.checkConfig()

getSubject

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

Description copied from interface: Source

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

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

BaseSourceAdapter.getSubject(java.lang.String, boolean, java.lang.String)

getSubjectByIdentifier

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

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

Overrides:

getSubjectByIdentifier in class BaseSourceAdapter

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

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

getSubjectByIdOrIdentifier

public Subject getSubjectByIdOrIdentifier(String idOrIdentifier,
                                 boolean exceptionIfNull,
                                 String realm)
                                   throws SubjectNotFoundException,
                                          SubjectNotUniqueException

Description copied from interface: Source

find by id or identifier. pass in either an id or an identifier

Specified by:

getSubjectByIdOrIdentifier in interface Source

Overrides:

getSubjectByIdOrIdentifier in class BaseSourceAdapter

exceptionIfNull - if SubjectNotFoundException or null

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

the subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

BaseSourceAdapter.getSubjectByIdOrIdentifier(java.lang.String, boolean, java.lang.String)

getSubjectByIdOrIdentifier

public Subject getSubjectByIdOrIdentifier(String idOrIdentifier,
                                 boolean exceptionIfNull)
                                   throws SubjectNotFoundException,
                                          SubjectNotUniqueException

Description copied from class: BaseSourceAdapter

find by id or identifier

Specified by:

getSubjectByIdOrIdentifier in interface Source

Overrides:

getSubjectByIdOrIdentifier in class BaseSourceAdapter

exceptionIfNull - if SubjectNotFoundException or null

Returns:

the subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

BaseSourceAdapter.getSubjectByIdOrIdentifier(java.lang.String, boolean)

getSubjectsByIdentifiers

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

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

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

a map of results never null indexed by the identifiers

See Also:

BaseSourceAdapter.getSubjectsByIdentifiers(java.util.Collection, java.lang.String)

getSubjectsByIds

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

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

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

a map of results never null indexed by the id

See Also:

BaseSourceAdapter.getSubjectsByIds(java.util.Collection, java.lang.String)

getSubjectsByIdsOrIdentifiers

public Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers,
                                                String realm)

Description copied from interface: Source

Get subjects by ids or 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:

getSubjectsByIdsOrIdentifiers in interface Source

Overrides:

getSubjectsByIdsOrIdentifiers in class BaseSourceAdapter

Parameters:

idsOrIdentifiers - each string could be a subject id or identifier

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

a map of results never null indexed by the id or identifier that was passed in. Note, the same subject could be returned twice if looked up by id and identifier (two inputs)

See Also:

BaseSourceAdapter.getSubjectsByIdsOrIdentifiers(java.util.Collection, java.lang.String)

getSubjectsByIdsOrIdentifiers

public Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)

Description copied from interface: Source

Get subjects by ids or 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:

getSubjectsByIdsOrIdentifiers in interface Source

Overrides:

getSubjectsByIdsOrIdentifiers in class BaseSourceAdapter

Parameters:

idsOrIdentifiers - each string could be a subject id or identifier

Returns:

a map of results never null indexed by the id or identifier that was passed in. Note, the same subject could be returned twice if looked up by id and identifier (two inputs)

See Also:

BaseSourceAdapter.getSubjectsByIdsOrIdentifiers(java.util.Collection)

search

public Set<Subject> search(String searchValue,
                  String realm)

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

Specified by:

search in interface Source

Overrides:

search in class BaseSourceAdapter

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

set

See Also:

BaseSourceAdapter.search(java.lang.String, java.lang.String)

searchPage

public SearchPageResult searchPage(String searchValue,
                          String realm)

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 sources.xml, 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

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

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

See Also:

BaseSourceAdapter.searchPage(java.lang.String, java.lang.String)

setupDataSource

protected void setupDataSource(Properties props)
                        throws SourceUnavailableException

DataSource connection pool setup.

Overrides:

setupDataSource in class JDBCSourceAdapter

Parameters:

props -

Throws:

SourceUnavailableException

getDbTableOrView

public String getDbTableOrView()

table or view where each row is a subject dbTableOrView

Returns:

table or view

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 JDBCSourceAdapter

Returns:

a map of results never null indexed by the identifiers

See Also:

JDBCSourceAdapter.getSubjectsByIdentifiers(java.util.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 JDBCSourceAdapter

Returns:

a map of results never null indexed by the id

See Also:

JDBCSourceAdapter.getSubjectsByIds(java.util.Collection)

getSubject

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

Description copied from class: JDBCSourceAdapter

Gets a Subject by its ID.

Specified by:

getSubject in interface Source

Overrides:

getSubject in class JDBCSourceAdapter

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

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

JDBCSourceAdapter.getSubject(java.lang.String, boolean)

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 sources.xml, 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 JDBCSourceAdapter

Returns:

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

See Also:

BaseSourceAdapter.searchPage(java.lang.String)

search

public Set<Subject> search(String searchValue)

Description copied from class: JDBCSourceAdapter

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

Overrides:

search in class JDBCSourceAdapter

Returns:

set

See Also:

JDBCSourceAdapter.search(java.lang.String)

dbTableOrView

protected String dbTableOrView()

get the db table or view, considering realm

Returns:

the db table or view

getSubjectByIdentifier

public Subject getSubjectByIdentifier(String identifier,
                             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 JDBCSourceAdapter

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

JDBCSourceAdapter.getSubjectByIdentifier(java.lang.String, boolean)

loadAttributes

protected Map<String,Set<String>> loadAttributes(ResultSet resultSet,
                                     String query,
                                     ResultSetMetaData resultSetMetaData)
                                          throws SQLException

Loads attributes for the argument subject.

Parameters:

resultSet -

query - for logging

resultSetMetaData -

Returns:

attributes

Throws:

SQLException

setDbTableOrView

public void setDbTableOrView(String dbTableOrView1)

table or view where each row is a subject dbTableOrView

Parameters:

dbTableOrView1 -

getSubjectIdCol

public String getSubjectIdCol()

column which holds the subject id subjectIdCol

Returns:

the subject id col

setSubjectIdCol

public void setSubjectIdCol(String subjectIdCol1)

column which holds the subject id subjectIdCol

Parameters:

subjectIdCol1 -

getNameCol

public String getNameCol()

column which holds the subject name nameCol

Returns:

the col for name

setNameCol

public void setNameCol(String nameCol1)

column which holds the subject name nameCol

Parameters:

nameCol1 -

getDescriptionCol

public String getDescriptionCol()

Returns:

description col

setDescriptionCol

public void setDescriptionCol(String descriptionCol1)

Parameters:

descriptionCol1 -

getLowerSearchCol

public String getLowerSearchCol()

for searches (not by id or identifier), this is the col which holds the search terms, in lower case lowerSearchCol

Returns:

lower search col

setLowerSearchCol

public void setLowerSearchCol(String lowerSearchCol1)

for searches (not by id or identifier), this is the col which holds the search terms, in lower case lowerSearchCol

Parameters:

lowerSearchCol1 -

getDefaultSortCol

public String getDefaultSortCol()

search queries will sort by this. Note it might be overridden by caller, e.g. UI defaultSortCol

Returns:

sort col

setDefaultSortCol

public void setDefaultSortCol(String defaultSortCol1)

search queries will sort by this. Note it might be overridden by caller, e.g. UI defaultSortCol

Parameters:

defaultSortCol1 -

getSubjectIdentifierCols

public Set<String> getSubjectIdentifierCols()

cols which are used in a findByIdentifier query subjectIdentifierCol0

Returns:

subject id cols

setSubjectIdentifierCols

public void setSubjectIdentifierCols(Set<String> subjectIdentifierCols1)

cols which are used in a findByIdentifier query subjectIdentifierCol0

Parameters:

subjectIdentifierCols1 -

getSubjectAttributeColToName

public Map<String,String> getSubjectAttributeColToName()

map of col to attribute name //subjectAttributeCol0 //subjectAttributeName0

Returns:

subject attribute col

setSubjectAttributeColToName

public void setSubjectAttributeColToName(Map<String,String> subjectAttributeColToName1)

map of col to attribute name //subjectAttributeCol0 //subjectAttributeName0

Parameters:

subjectAttributeColToName1 -