Package org.eclipse.lyo.server.oauth.consumerstore

Class FileSystemConsumerStore

java.lang.Object

org.eclipse.lyo.server.oauth.core.consumer.AbstractConsumerStore

org.eclipse.lyo.server.oauth.consumerstore.FileSystemConsumerStore

All Implemented Interfaces:

ConsumerStore

public class FileSystemConsumerStore
extends AbstractConsumerStore

A simple RDF consumer store backed by an XML file on the filesystem. NOTE: The shared consumer secret is stored as Base64 and is only obfuscated, not encrypted (unless the ctor with an encryption key is used).

Author:

Samuel Padgett

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AES_CIPHER
protected static final String	CALLBACK_URL
protected static final String	CONSUMER_KEY
protected static final String	CONSUMER_NAME
protected static final String	CONSUMER_RESOURCE
protected static final String	CONSUMER_SECRET
protected static final String	LYO_OAUTH_NAMESPACE
protected static final String	PROVISIONAL
protected static final String	TRUSTED

Constructor Summary

Constructors

Constructor	Description
FileSystemConsumerStore(String oauthStoreRoot)
FileSystemConsumerStore(String oauthStoreRoot, String encryptionKey)	This provides a extra parameter for storing the consumer secret encrypted by a userKey
FileSystemConsumerStore(Model model, String oauthStoreRoot)

Method Summary

Modifier and Type	Method	Description
LyoOAuthConsumer	addConsumer(LyoOAuthConsumer consumer)	Adds a new consumer.
void	closeConsumerStore()	Closes the consumer store.
protected void	createModel()
protected String	decrypt(String encryptedText, String decryptionKey)
protected String	encrypt(String plainText, String encryptionKey)
protected LyoOAuthConsumer	fromResource(Resource resource)
protected SecretKey	getSecreteKey(String encryptionKey)	It generate Secret Key of length 32 bytes using user provided key.
protected void	loadConsumers()
LyoOAuthConsumer	removeConsumer(String consumerKey)	Removes a consumer.
protected void	removeProperties(String consumerKey)	Removes any properties previously associated with the consumer.
protected void	removeProperties(LyoOAuthConsumer consumer)	Removes any properties previously associated with the consumer.
protected Resource	toResource(LyoOAuthConsumer consumer)
LyoOAuthConsumer	updateConsumer(LyoOAuthConsumer consumer)	Updates a consumer.
protected void	writeModel()

Methods inherited from class org.eclipse.lyo.server.oauth.core.consumer.AbstractConsumerStore

add, addAll, getAllConsumers, getConsumer, getConsumer, remove

Methods inherited from class java.lang.Object

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

Field Details

LYO_OAUTH_NAMESPACE

protected static final String LYO_OAUTH_NAMESPACE

See Also:

• Constant Field Values

CONSUMER_RESOURCE

protected static final String CONSUMER_RESOURCE

See Also:

• Constant Field Values

CALLBACK_URL

protected static final String CALLBACK_URL

See Also:

• Constant Field Values

CONSUMER_NAME

protected static final String CONSUMER_NAME

See Also:

• Constant Field Values

CONSUMER_KEY

protected static final String CONSUMER_KEY

See Also:

• Constant Field Values

CONSUMER_SECRET

protected static final String CONSUMER_SECRET

See Also:

• Constant Field Values

PROVISIONAL

protected static final String PROVISIONAL

See Also:

• Constant Field Values

TRUSTED

protected static final String TRUSTED

See Also:

• Constant Field Values

AES_CIPHER

public static final String AES_CIPHER

See Also:

• Constant Field Values

Constructor Details

FileSystemConsumerStore

public FileSystemConsumerStore(String oauthStoreRoot)
                        throws SQLException,
ConsumerStoreException,
ClassNotFoundException

Throws:

SQLException

ConsumerStoreException

ClassNotFoundException

FileSystemConsumerStore

public FileSystemConsumerStore(String oauthStoreRoot,
 String encryptionKey)
                        throws SQLException,
ConsumerStoreException,
ClassNotFoundException

This provides a extra parameter for storing the consumer secret encrypted by a userKey

Parameters:

oauthStoreRoot -

encryptionKey -

Throws:

SQLException

ConsumerStoreException

ClassNotFoundException

FileSystemConsumerStore

public FileSystemConsumerStore(Model model,
 String oauthStoreRoot)
                        throws ConsumerStoreException

Throws:

ConsumerStoreException

Method Details

createModel

protected void createModel()

writeModel

protected void writeModel()
                   throws FileNotFoundException

Throws:

FileNotFoundException

loadConsumers

protected void loadConsumers()
                      throws ConsumerStoreException

Throws:

ConsumerStoreException

addConsumer

public LyoOAuthConsumer addConsumer(LyoOAuthConsumer consumer)
                             throws ConsumerStoreException

Description copied from interface: ConsumerStore

Adds a new consumer.

Parameters:

consumer - the consumer

Returns:

the previous consumer associated with this key or null if there wasn't one

Throws:

ConsumerStoreException

removeConsumer

public LyoOAuthConsumer removeConsumer(String consumerKey)
                                throws ConsumerStoreException

Description copied from interface: ConsumerStore

Removes a consumer.

Returns:

the removed consumer or null if it wasn't previously in the store

Throws:

ConsumerStoreException - on errors

updateConsumer

public LyoOAuthConsumer updateConsumer(LyoOAuthConsumer consumer)
                                throws ConsumerStoreException

Description copied from interface: ConsumerStore

Updates a consumer.

Parameters:

consumer - the consumer

Returns:

the same consumer or null if it wasn't previously in the store

Throws:

ConsumerStoreException - on errors

closeConsumerStore

public void closeConsumerStore()

Description copied from interface: ConsumerStore

Closes the consumer store. It is unavailable for further use.

Specified by:

closeConsumerStore in interface ConsumerStore

Specified by:

closeConsumerStore in class AbstractConsumerStore

removeProperties

protected void removeProperties(String consumerKey)

Removes any properties previously associated with the consumer.

Parameters:

consumerKey - the consumer key

removeProperties

protected void removeProperties(LyoOAuthConsumer consumer)

Removes any properties previously associated with the consumer.

Parameters:

consumer - the consumer

toResource

protected Resource toResource(LyoOAuthConsumer consumer)
                       throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

fromResource

protected LyoOAuthConsumer fromResource(Resource resource)
                                 throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

encrypt

protected String encrypt(String plainText,
 String encryptionKey)

decrypt

protected String decrypt(String encryptedText,
 String decryptionKey)

getSecreteKey

protected SecretKey getSecreteKey(String encryptionKey)

It generate Secret Key of length 32 bytes using user provided key.

Returns: