org.oscelot.lti.tp

Class DataConnector

java.lang.Object

org.oscelot.lti.tp.DataConnector

Direct Known Subclasses:

JDBC, None

public abstract class DataConnector
extends java.lang.Object

Abstract class to represent a data connector.

A data connector provides methods to load and save LTI objects.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONSUMER_TABLE_NAME Default name for database table used to store tool consumers.
static java.lang.String	NONCE_TABLE_NAME Default name for database table used to store nonce values.
static java.lang.String	RESOURCE_LINK_SHARE_KEY_TABLE_NAME Default name for database table used to store resource link share keys.
static java.lang.String	RESOURCE_LINK_TABLE_NAME Default name for database table used to store resource links.
static java.lang.String	USER_TABLE_NAME Default name for database table used to store users.

Constructor Summary

Constructors

Constructor and Description
DataConnector()

Method Summary

Methods

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

Field Detail

CONSUMER_TABLE_NAME

public static final java.lang.String CONSUMER_TABLE_NAME

Default name for database table used to store tool consumers.

See Also:

Constant Field Values

RESOURCE_LINK_TABLE_NAME

public static final java.lang.String RESOURCE_LINK_TABLE_NAME

Default name for database table used to store resource links.

See Also:

Constant Field Values

USER_TABLE_NAME

public static final java.lang.String USER_TABLE_NAME

Default name for database table used to store users.

See Also:

Constant Field Values

RESOURCE_LINK_SHARE_KEY_TABLE_NAME

public static final java.lang.String RESOURCE_LINK_SHARE_KEY_TABLE_NAME

Default name for database table used to store resource link share keys.

See Also:

Constant Field Values

NONCE_TABLE_NAME

public static final java.lang.String NONCE_TABLE_NAME

Default name for database table used to store nonce values.

See Also:

Constant Field Values

Constructor Detail

DataConnector

public DataConnector()

Method Detail

loadToolConsumer

public abstract boolean loadToolConsumer(ToolConsumer consumer)

Load tool consumer object.

Parameters:

consumer - ToolConsumer object

Returns:

true if the tool consumer object was successfully loaded

saveToolConsumer

public abstract boolean saveToolConsumer(ToolConsumer consumer)

Save tool consumer object.

Parameters:

consumer - ToolConsumer object

Returns:

true if the tool consumer object was successfully saved

deleteToolConsumer

public abstract boolean deleteToolConsumer(ToolConsumer consumer)

Delete tool consumer object.

Parameters:

consumer - ToolConsumer object

Returns:

true if the tool consumer object was successfully deleted

getToolConsumers

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

Load tool consumer objects.

Returns:

array of all defined ToolConsumer objects

loadResourceLink

public abstract boolean loadResourceLink(ResourceLink resourceLink)

Load resource link object.

Parameters:

resourceLink - ResourceLink object

Returns:

true if the resource link object was successfully loaded

saveResourceLink

public abstract boolean saveResourceLink(ResourceLink resourceLink)

Save resource link object.

Parameters:

resourceLink - ResourceLink object

Returns:

true if the resource link object was successfully saved

deleteResourceLink

public abstract boolean deleteResourceLink(ResourceLink resourceLink)

Delete resource link object.

Parameters:

resourceLink - ResourceLink object

Returns:

true if the resourceLink object was successfully deleted

getUserResultSourcedIDs

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

Get array of user objects.

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 abstract java.util.List<ResourceLinkShare> getShares(ResourceLink resourceLink)

Get shares defined for a resource link.

Parameters:

resourceLink - ResourceLink object

Returns:

array of resourceLinkShare objects

loadConsumerNonce

public abstract boolean loadConsumerNonce(Nonce nonce)

Load nonce object.

Parameters:

nonce - Nonce object

Returns:

true if the nonce object was successfully loaded

saveConsumerNonce

public abstract boolean saveConsumerNonce(Nonce nonce)

Save nonce object.

Parameters:

nonce - Nonce object

Returns:

true if the nonce object was successfully saved

loadResourceLinkShareKey

public abstract boolean loadResourceLinkShareKey(ResourceLinkShareKey shareKey)

Load resource link share key object.

Parameters:

shareKey - Resource link share key object

Returns:

true if the resource link share key object was successfully loaded

saveResourceLinkShareKey

public abstract boolean saveResourceLinkShareKey(ResourceLinkShareKey shareKey)

Save resource link share key object.

Parameters:

shareKey - Resource link share key object

Returns:

true if the resource link share key object was successfully saved

deleteResourceLinkShareKey

public abstract boolean deleteResourceLinkShareKey(ResourceLinkShareKey shareKey)

Delete resource link share key object.

Parameters:

shareKey - Resource link share key object

Returns:

true if the resource link share key object was successfully deleted

loadUser

public abstract boolean loadUser(User user)

Load user object.

Parameters:

user - User object

Returns:

true if the user object was successfully loaded

saveUser

public abstract boolean saveUser(User user)

Save user object.

Parameters:

user - User object

Returns:

true if the user object was successfully saved

deleteUser

public abstract boolean deleteUser(User user)

Delete user object.

Parameters:

user - User object

Returns:

true if the user object was successfully deleted