Package com.atlassian.bitbucket.jenkins.internal.applink.oauth.serviceprovider.token

Class PersistentServiceProviderTokenStore

java.lang.Object

com.atlassian.bitbucket.jenkins.internal.applink.oauth.serviceprovider.AbstractPersistentStore<ServiceProviderToken>

com.atlassian.bitbucket.jenkins.internal.applink.oauth.serviceprovider.token.PersistentServiceProviderTokenStore

All Implemented Interfaces:

ServiceProviderTokenStore, Saveable, OnMaster

@Singleton
public class PersistentServiceProviderTokenStore
extends AbstractPersistentStore<ServiceProviderToken>
implements ServiceProviderTokenStore

A ServiceProviderTokenStore implementation that persists the tokens to an XML file

Only one instance of this class must be created per Jenkins instance.

See Also:

• Saveable
• XStream2

Field Summary

Fields inherited from class com.atlassian.bitbucket.jenkins.internal.applink.oauth.serviceprovider.AbstractPersistentStore

entityMap, xStream

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
PersistentServiceProviderTokenStore(ServiceProviderConsumerStore consumerStore)

Method Summary

Modifier and Type	Method	Description
Optional<ServiceProviderToken>	get(String token)	Retrieve a ServiceProviderToken from the store whose token attribute is equal to the token parameter.
Iterable<ServiceProviderToken>	getAccessTokensForUser(String username)	Retrieves all the access tokens the user has approved.
protected Class<ServiceProviderToken>	getEntityClass()
protected String	getStoreEntryName()
protected String	getStoreKeyName()
protected String	getStoreValueName()
ServiceProviderToken	put(ServiceProviderToken token)	Put the token in the store.
void	remove(String token)	Remove a ServiceProviderToken from the store whose token attribute value is equal to the token parameter.
void	removeByConsumer(String consumerKey)	Remove all the ServiceProviderTokens created by the consumer.
void	removeExpiredSessions()	Remove all sessions and ServiceProviderTokens from the store whose session has expired.
void	removeExpiredTokens()	Remove all ServiceProviderTokens from the store that do not have sessions and whose timeToLive has been exceeded.

Methods inherited from class com.atlassian.bitbucket.jenkins.internal.applink.oauth.serviceprovider.AbstractPersistentStore

decrypt, encrypt, getConfigFile, load, save

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentServiceProviderTokenStore

@Inject
public PersistentServiceProviderTokenStore(ServiceProviderConsumerStore consumerStore)

Method Details

get

public Optional<ServiceProviderToken> get(String token)

Description copied from interface: ServiceProviderTokenStore

Retrieve a ServiceProviderToken from the store whose token attribute is equal to the token parameter.

Specified by:

get in interface ServiceProviderTokenStore

Parameters:

token - token value of the ServiceProviderToken to retrieve

Returns:

Optional of ServiceProviderToken whose value is token, Optional.absent() if there is no ServiceProviderToken instance matching the token parameter

getAccessTokensForUser

public Iterable<ServiceProviderToken> getAccessTokensForUser(String username)

Description copied from interface: ServiceProviderTokenStore

Retrieves all the access tokens the user has approved.

Specified by:

getAccessTokensForUser in interface ServiceProviderTokenStore

Parameters:

username - the user that approved the access tokens to retrieve

Returns:

all the access tokens the user has approved

put

public ServiceProviderToken put(ServiceProviderToken token)

Description copied from interface: ServiceProviderTokenStore

Put the token in the store.

Specified by:

put in interface ServiceProviderTokenStore

Parameters:

token - ServiceProviderToken to store

Returns:

the ServiceProviderToken that was stored

remove

public void remove(String token)

Description copied from interface: ServiceProviderTokenStore

Remove a ServiceProviderToken from the store whose token attribute value is equal to the token parameter.

Specified by:

remove in interface ServiceProviderTokenStore

Parameters:

token - token value of the ServiceProviderToken to remove

removeExpiredTokens

public void removeExpiredTokens()

Description copied from interface: ServiceProviderTokenStore

Remove all ServiceProviderTokens from the store that do not have sessions and whose timeToLive has been exceeded. ServiceProviderTokens with session information should be left as-is, to be removed by the ServiceProviderTokenStore.removeExpiredSessions() method when the session expires.

Note: In 1.4.0 support for OAuth sessions was implemented. Rather than create an entirely separate entity, session information is carried along with access tokens. This means that if we remove expired tokens that have sessions, we will also be removing the session information. Consequently, we don't want to remove an expired token until the session has expired and the token cannot be renewed. To remove expired sessions and the tokens associated with them, use ServiceProviderTokenStore.removeExpiredSessions() instead.

Specified by:

removeExpiredTokens in interface ServiceProviderTokenStore

removeExpiredSessions

public void removeExpiredSessions()

Description copied from interface: ServiceProviderTokenStore

Remove all sessions and ServiceProviderTokens from the store whose session has expired.

Specified by:

removeExpiredSessions in interface ServiceProviderTokenStore

removeByConsumer

public void removeByConsumer(String consumerKey)

Description copied from interface: ServiceProviderTokenStore

Remove all the ServiceProviderTokens created by the consumer.

Specified by:

removeByConsumer in interface ServiceProviderTokenStore

Parameters:

consumerKey - key of the consumer that created the tokens which are to be removed

getEntityClass

protected Class<ServiceProviderToken> getEntityClass()

Specified by:

getEntityClass in class AbstractPersistentStore<ServiceProviderToken>

getStoreValueName

protected String getStoreValueName()

Specified by:

getStoreValueName in class AbstractPersistentStore<ServiceProviderToken>

getStoreKeyName

protected String getStoreKeyName()

Specified by:

getStoreKeyName in class AbstractPersistentStore<ServiceProviderToken>

getStoreEntryName

protected String getStoreEntryName()

Specified by:

getStoreEntryName in class AbstractPersistentStore<ServiceProviderToken>