org.oscelot.lti.tp

Class ResourceLinkShareKey

java.lang.Object

org.oscelot.lti.tp.ResourceLinkShareKey

public class ResourceLinkShareKey
extends java.lang.Object

Class to represent a resource link share key.

A share key is a value which is generated to enable a different resource link to be treated as equivalent to the issuing resource link.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Constructor Summary

Constructors

Constructor and Description
ResourceLinkShareKey(ResourceLink resourceLink, java.lang.String id) Construct a share key for a resource link with a specified ID (may be null if a random ID is to be generated).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete() Delete the resource link share key from the database.
java.util.Calendar	getExpires() Returns the date/time when the share key expires.
java.lang.String	getId() Returns the share key value.
java.lang.Integer	getLength() Returns the length to use when generating an ID.
java.lang.Integer	getLife() Returns the life of the share key (the period of time after creation when the share key will automatically expire).
java.lang.String	getPrimaryConsumerKey() Returns the consumer key for the resource link which issued the share key.
java.lang.String	getPrimaryResourceLinkId() Returns the resource link ID for the resource link which issued the share key.
void	initialise() Initialise the resource link share key.
boolean	isAutoApprove() Returns true if a used share key should be automatically approved and be given access to the issuing resource link.
boolean	save() Save the resource link share key to the database.
void	setAutoApprove(boolean autoApprove) Sets whether the share key should be automatically approved when used.
void	setExpires(java.util.Calendar expires) Set the expiry date/time.
void	setLength(java.lang.Integer length) Set the length to use when generating a random ID value.
void	setPrimaryConsumerKey(java.lang.String primaryConsumerKey) Set consumer key representing the issuing resource link.
void	setPrimaryResourceLinkId(java.lang.String primaryResourceLinkId) Set ID for the issuing resource link.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceLinkShareKey

public ResourceLinkShareKey(ResourceLink resourceLink,
                    java.lang.String id)

Construct a share key for a resource link with a specified ID (may be null if a random ID is to be generated).

Parameters:

resourceLink - ResourceLink object

id - share key value

Method Detail

initialise

public final void initialise()

Initialise the resource link share key.

save

public boolean save()

Save the resource link share key to the database.

Returns:

true if the share key was successfully saved

delete

public boolean delete()

Delete the resource link share key from the database.

Returns:

true if the share key was successfully deleted

getId

public java.lang.String getId()

Returns the share key value.

Returns:

share key value

getLength

public java.lang.Integer getLength()

Returns the length to use when generating an ID.

Returns:

length

setLength

public void setLength(java.lang.Integer length)

Set the length to use when generating a random ID value.

Parameters:

length -

getLife

public java.lang.Integer getLife()

Returns the life of the share key (the period of time after creation when the share key will automatically expire).

Returns:

life

getExpires

public java.util.Calendar getExpires()

Returns the date/time when the share key expires.

Returns:

expiry date/time

setExpires

public void setExpires(java.util.Calendar expires)

Set the expiry date/time.

Parameters:

expires - expiry date/time

isAutoApprove

public boolean isAutoApprove()

Returns true if a used share key should be automatically approved and be given access to the issuing resource link.

Returns:

true if the share key is to be auto-approved when used

setAutoApprove

public void setAutoApprove(boolean autoApprove)

Sets whether the share key should be automatically approved when used.

Parameters:

autoApprove - true if the share key should be auto approved

getPrimaryConsumerKey

public java.lang.String getPrimaryConsumerKey()

Returns the consumer key for the resource link which issued the share key.

Returns:

primary consumer key

setPrimaryConsumerKey

public void setPrimaryConsumerKey(java.lang.String primaryConsumerKey)

Set consumer key representing the issuing resource link.

Parameters:

primaryConsumerKey - primary consumer key

getPrimaryResourceLinkId

public java.lang.String getPrimaryResourceLinkId()

Returns the resource link ID for the resource link which issued the share key.

Returns:

primary resource link ID

setPrimaryResourceLinkId

public void setPrimaryResourceLinkId(java.lang.String primaryResourceLinkId)

Set ID for the issuing resource link.

Parameters:

primaryResourceLinkId - primary resource link ID