org.oscelot.lti.tp.dataconnector

Class JDBC

java.lang.Object

org.oscelot.lti.tp.DataConnector

org.oscelot.lti.tp.dataconnector.JDBC

public class JDBC
extends DataConnector

Class to represent a data connector for a JDBC database connection.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Field Summary

Fields inherited from class org.oscelot.lti.tp.DataConnector

CONSUMER_TABLE_NAME, NONCE_TABLE_NAME, RESOURCE_LINK_SHARE_KEY_TABLE_NAME, RESOURCE_LINK_TABLE_NAME, USER_TABLE_NAME

Constructor Summary

Constructors

Constructor and Description
JDBC(java.lang.String prefix, java.sql.Connection conn) Constructs a data connector object using the specified database table name prefix and JDBC database connection.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteResourceLink(ResourceLink resourceLink) Delete resource link object.
boolean	deleteResourceLinkShareKey(ResourceLinkShareKey shareKey) Delete resource link share key object.
boolean	deleteToolConsumer(ToolConsumer consumer) Delete tool consumer object.
boolean	deleteUser(User user) Delete user object.
java.util.List<ResourceLinkShare>	getShares(ResourceLink resourceLink) Get shares defined for a resource link.
java.util.List<ToolConsumer>	getToolConsumers() Load tool consumer objects.
java.util.Map<java.lang.String,User>	getUserResultSourcedIDs(ResourceLink resourceLink, boolean localOnly, int scope) Get array of user objects.
boolean	loadConsumerNonce(Nonce nonce) Load nonce object.
boolean	loadResourceLink(ResourceLink resourceLink) Load resource link object.
boolean	loadResourceLinkShareKey(ResourceLinkShareKey shareKey) Load resource link share key object.
boolean	loadToolConsumer(ToolConsumer consumer) Load tool consumer object.
boolean	loadUser(User user) Load user object.
boolean	saveConsumerNonce(Nonce nonce) Save nonce object.
boolean	saveResourceLink(ResourceLink resourceLink) Save resource link object.
boolean	saveResourceLinkShareKey(ResourceLinkShareKey shareKey) Save resource link share key object.
boolean	saveToolConsumer(ToolConsumer consumer) Save tool consumer object.
boolean	saveUser(User user) Save user object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBC

public JDBC(java.lang.String prefix,
    java.sql.Connection conn)

Constructs a data connector object using the specified database table name prefix and JDBC database connection.

Parameters:

prefix - table name prefix

conn - database connection

Method Detail

loadToolConsumer

public boolean loadToolConsumer(ToolConsumer consumer)

Load tool consumer object.

Specified by:

loadToolConsumer in class DataConnector

Parameters:

consumer - ToolConsumer object

Returns:

true if the tool consumer object was successfully loaded

saveToolConsumer

public boolean saveToolConsumer(ToolConsumer consumer)

Save tool consumer object.

Specified by:

saveToolConsumer in class DataConnector

Parameters:

consumer - ToolConsumer object

Returns:

true if the tool consumer object was successfully saved

deleteToolConsumer

public boolean deleteToolConsumer(ToolConsumer consumer)

Delete tool consumer object.

Specified by:

deleteToolConsumer in class DataConnector

Parameters:

consumer - ToolConsumer object

Returns:

true if the tool consumer object was successfully deleted

getToolConsumers

public java.util.List<ToolConsumer> getToolConsumers()

Load tool consumer objects.

Specified by:

getToolConsumers in class DataConnector

Returns:

array of all defined ToolConsumer objects

loadResourceLink

public boolean loadResourceLink(ResourceLink resourceLink)

Load resource link object.

Specified by:

loadResourceLink in class DataConnector

Parameters:

resourceLink - ResourceLink object

Returns:

true if the resource link object was successfully loaded

saveResourceLink

public boolean saveResourceLink(ResourceLink resourceLink)

Save resource link object.

Specified by:

saveResourceLink in class DataConnector

Parameters:

resourceLink - ResourceLink object

Returns:

true if the resource link object was successfully saved

deleteResourceLink

public boolean deleteResourceLink(ResourceLink resourceLink)

Delete resource link object.

Specified by:

deleteResourceLink in class DataConnector

Parameters:

resourceLink - ResourceLink object

Returns:

true if the resourceLink object was successfully deleted

getUserResultSourcedIDs

public java.util.Map<java.lang.String,User> getUserResultSourcedIDs(ResourceLink resourceLink,
                                                           boolean localOnly,
                                                           int scope)

Get array of user objects.

Specified by:

getUserResultSourcedIDs in class DataConnector

Parameters:

resourceLink - ResourceLink object

localOnly - true if only users for the resource link are to be returned (excluding users sharing this resource link)

scope - Scope value to use for user IDs

Returns:

array of User objects

getShares

public java.util.List<ResourceLinkShare> getShares(ResourceLink resourceLink)

Get shares defined for a resource link.

Specified by:

getShares in class DataConnector

Parameters:

resourceLink - ResourceLink object

Returns:

array of resourceLinkShare objects

loadConsumerNonce

public boolean loadConsumerNonce(Nonce nonce)

Load nonce object.

Specified by:

loadConsumerNonce in class DataConnector

Parameters:

nonce - Nonce object

Returns:

true if the nonce object was successfully loaded

saveConsumerNonce

public boolean saveConsumerNonce(Nonce nonce)

Save nonce object.

Specified by:

saveConsumerNonce in class DataConnector

Parameters:

nonce - Nonce object

Returns:

true if the nonce object was successfully saved

loadResourceLinkShareKey

public boolean loadResourceLinkShareKey(ResourceLinkShareKey shareKey)

Load resource link share key object.

Specified by:

loadResourceLinkShareKey in class DataConnector

Parameters:

shareKey - Resource link share key object

Returns:

true if the resource link share key object was successfully loaded

saveResourceLinkShareKey

public boolean saveResourceLinkShareKey(ResourceLinkShareKey shareKey)

Save resource link share key object.

Specified by:

saveResourceLinkShareKey in class DataConnector

Parameters:

shareKey - Resource link share key object

Returns:

true if the resource link share key object was successfully saved

deleteResourceLinkShareKey

public boolean deleteResourceLinkShareKey(ResourceLinkShareKey shareKey)

Delete resource link share key object.

Specified by:

deleteResourceLinkShareKey in class DataConnector

Parameters:

shareKey - Resource link share key object

Returns:

true if the resource link share key object was successfully deleted

loadUser

public boolean loadUser(User user)

Load user object.

Specified by:

loadUser in class DataConnector

Parameters:

user - User object

Returns:

true if the user object was successfully loaded

saveUser

public boolean saveUser(User user)

Save user object.

Specified by:

saveUser in class DataConnector

Parameters:

user - User object

Returns:

true if the user object was successfully saved

deleteUser

public boolean deleteUser(User user)

Delete user object.

Specified by:

deleteUser in class DataConnector

Parameters:

user - User object

Returns:

true if the user object was successfully deleted