org.miniauth.oauth.credential.mapper

Class OAuthNullTokenCredentialMapper

java.lang.Object

org.miniauth.oauth.credential.mapper.AbstractOAuthCredentialMapper

org.miniauth.oauth.credential.mapper.OAuthNullTokenCredentialMapper

All Implemented Interfaces:

Serializable, CredentialMapper, DynamicCredentialMapper, DynamicOAuthCredentialMapper, DynamicOAuthTokenCredentialMapper, OAuthCredentialMapper, OAuthTokenCredentialMapper

public final class OAuthNullTokenCredentialMapper
extends AbstractOAuthCredentialMapper
implements DynamicOAuthTokenCredentialMapper

"Dummy" implementation of OAuthTokenCredentialMapper, which defines a service that returns a "token secret" given an access token. Although it implements OAuthTokenCredentialMapper, it does not actually return real token secrets, however. This class can be used where OAuthTokenCredentialMapper is needed, but the actual implementation is not important. OAuthNullTokenCredentialMapper can be used, in particular, in Two-Legged OAuth (2LO).

See Also:

Serialized Form

Field Summary

Fields inherited from class org.miniauth.oauth.credential.mapper.AbstractOAuthCredentialMapper

CONSUMER_CREDENTIAL, TOKEN_CREDENTIAL

Constructor Summary

Constructors

Constructor and Description
OAuthNullTokenCredentialMapper(String consumerKey, String consumerSecret)

Method Summary

Methods

Modifier and Type	Method and Description
AccessIdentity	getAccessIdentity(String accessToken) Returns a pair of consumer key and access token.
AccessCredential	getAccesssCredential(String accessToken) Returns a pair of consumer secret and token secret for the given access token.
ConsumerCredential	getConsumerCredential() Returns a (unique) consumer key/secret pair associated with this mapper.
String	getConsumerKey() Returns a (unique) consumerKey associated with this mapper.
String	getConsumerSecret() Returns a (unique) consumerSecret associated with this mapper.
String	getCredentialSecret(String credentialType, String credentialKey)
String	getTokenSecret(String accessToken) Returns a token secret for the givne accessToken.
protected void	init()
AccessCredential	putAccesssCredential(String accessToken, String tokenSecret)
String	putCredentialSecret(String credentialType, String credentialKey, String credentialSecret)
String	putTokenSecret(String accessToken, String tokenSecret)
void	putTokenSecrets(Map<String,String> tokenCredentials)

Methods inherited from class org.miniauth.oauth.credential.mapper.AbstractOAuthCredentialMapper

getAccesssCredential, getConsumerSecret, putAccesssCredential, putConsumerSecret

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.miniauth.oauth.credential.mapper.DynamicOAuthCredentialMapper

putAccesssCredential, putConsumerSecret

Methods inherited from interface org.miniauth.oauth.credential.mapper.OAuthCredentialMapper

getAccesssCredential, getConsumerSecret

Constructor Detail

OAuthNullTokenCredentialMapper

public OAuthNullTokenCredentialMapper(String consumerKey,
                              String consumerSecret)

Method Detail

init

protected void init()

Overrides:

init in class AbstractOAuthCredentialMapper

getConsumerKey

public String getConsumerKey()

Description copied from interface: OAuthTokenCredentialMapper

Returns a (unique) consumerKey associated with this mapper.

Specified by:

getConsumerKey in interface OAuthTokenCredentialMapper

Returns:

Consumer key.

getConsumerSecret

public String getConsumerSecret()

Description copied from interface: OAuthTokenCredentialMapper

Returns a (unique) consumerSecret associated with this mapper.

Specified by:

getConsumerSecret in interface OAuthTokenCredentialMapper

Returns:

Consumer secret.

getConsumerCredential

public ConsumerCredential getConsumerCredential()

Description copied from interface: OAuthTokenCredentialMapper

Returns a (unique) consumer key/secret pair associated with this mapper.

Specified by:

getConsumerCredential in interface OAuthTokenCredentialMapper

Returns:

ConsumerCredential comprising consumer key/secret pair.

getCredentialSecret

public String getCredentialSecret(String credentialType,
                         String credentialKey)
                           throws CredentialStoreException

Specified by:

getCredentialSecret in interface CredentialMapper

Throws:

CredentialStoreException

putCredentialSecret

public String putCredentialSecret(String credentialType,
                         String credentialKey,
                         String credentialSecret)
                           throws CredentialStoreException

Specified by:

putCredentialSecret in interface DynamicCredentialMapper

Throws:

CredentialStoreException

getTokenSecret

public String getTokenSecret(String accessToken)
                      throws CredentialStoreException

Description copied from interface: OAuthCredentialMapper

Returns a token secret for the givne accessToken.

Specified by:

getTokenSecret in interface OAuthCredentialMapper

Overrides:

getTokenSecret in class AbstractOAuthCredentialMapper

Returns:

Token secret.

Throws:

CredentialStoreException - TODO

putTokenSecret

public String putTokenSecret(String accessToken,
                    String tokenSecret)
                      throws CredentialStoreException

Specified by:

putTokenSecret in interface DynamicOAuthCredentialMapper

Overrides:

putTokenSecret in class AbstractOAuthCredentialMapper

Throws:

CredentialStoreException

putTokenSecrets

public void putTokenSecrets(Map<String,String> tokenCredentials)
                     throws CredentialStoreException

Specified by:

putTokenSecrets in interface DynamicOAuthTokenCredentialMapper

Throws:

CredentialStoreException

getAccessIdentity

public AccessIdentity getAccessIdentity(String accessToken)
                                 throws CredentialStoreException

Description copied from interface: OAuthTokenCredentialMapper

Returns a pair of consumer key and access token.

Specified by:

getAccessIdentity in interface OAuthTokenCredentialMapper

Returns:

AccessIdentity comprising a pair of consumer key and access token.

Throws:

CredentialStoreException - TODO

getAccesssCredential

public AccessCredential getAccesssCredential(String accessToken)
                                      throws CredentialStoreException

Description copied from interface: OAuthTokenCredentialMapper

Returns a pair of consumer secret and token secret for the given access token.

Specified by:

getAccesssCredential in interface OAuthTokenCredentialMapper

Returns:

AccessCredential comprising a pair of consumer secret and token secret.

Throws:

CredentialStoreException - TODO

putAccesssCredential

public AccessCredential putAccesssCredential(String accessToken,
                                    String tokenSecret)
                                      throws CredentialStoreException

Specified by:

putAccesssCredential in interface DynamicOAuthTokenCredentialMapper

Throws:

CredentialStoreException