Package swiss.trustbroker.sessioncache.service

Class ArtifactStorageService

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

org.opensaml.storage.AbstractStorageService

swiss.trustbroker.sessioncache.service.ArtifactStorageService

All Implemented Interfaces:

net.shibboleth.shared.component.Component, net.shibboleth.shared.component.DestructableComponent, net.shibboleth.shared.component.IdentifiableComponent, net.shibboleth.shared.component.IdentifiedComponent, net.shibboleth.shared.component.InitializableComponent, org.opensaml.storage.StorageCapabilities, org.opensaml.storage.StorageService

public class ArtifactStorageService
extends org.opensaml.storage.AbstractStorageService

Minimal implementation with only methods used by OpenSAML StorageServiceSAMLArtifactMap

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ArtifactStorageService.ArtifactCleanupTask

Field Summary

Fields

Modifier and Type	Field	Description
final MetricsService	metricsService

Constructor Summary

Constructors

Constructor	Description
ArtifactStorageService(ArtifactCacheRepository repository, Clock clock, Duration cleanupInterval, MetricsService metricsService)

Method Summary

Modifier and Type	Method	Description
boolean	create(String context, String artifactId, String artifactValue, Long expiration)
boolean	delete(String context, String artifactId)
void	deleteContext(String context)
boolean	deleteWithVersion(long version, String context, String key)
protected TimerTask	getCleanupTask()
int	getKeySize()
boolean	isClustered()
boolean	isServerSide()
<T> org.opensaml.storage.StorageRecord<T>	read(String context, String artifactId)
<T> net.shibboleth.shared.collection.Pair<Long,org.opensaml.storage.StorageRecord<T>>	read(String context, String key, long version)
void	reap(String context)
boolean	update(String context, String key, String value, Long expiration)
void	updateContextExpiration(String context, Long expiration)
boolean	updateExpiration(String context, String key, Long expiration)
Long	updateWithVersion(long version, String context, String key, String value, Long expiration)

Methods inherited from class org.opensaml.storage.AbstractStorageService

create, create, delete, deleteWithVersion, doDestroy, doInitialize, getCapabilities, getCleanupInterval, getCleanupTaskTimer, getContextSize, getValueSize, read, setCleanupInterval, setCleanupTaskTimer, setContextSize, setKeySize, setValueSize, update, update, updateExpiration, updateWithVersion, updateWithVersion

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Field Details

metricsService

public final MetricsService metricsService

Constructor Details

ArtifactStorageService

public ArtifactStorageService(ArtifactCacheRepository repository,
 Clock clock,
 Duration cleanupInterval,
 MetricsService metricsService)

Method Details

getCleanupTask

protected TimerTask getCleanupTask()

Overrides:

getCleanupTask in class org.opensaml.storage.AbstractStorageService

getKeySize

public int getKeySize()

Specified by:

getKeySize in interface org.opensaml.storage.StorageCapabilities

Overrides:

getKeySize in class org.opensaml.storage.AbstractStorageService

isServerSide

public boolean isServerSide()

isClustered

public boolean isClustered()

create

public boolean create(@Nonnull
 String context,
 @Nonnull
 String artifactId,
 @Nonnull
 String artifactValue,
 @Nullable
 Long expiration)

read

@Nullable
public <T> org.opensaml.storage.StorageRecord<T> read(@Nonnull
 String context,
 @Nonnull
 String artifactId)

read

@Nonnull
public <T>
net.shibboleth.shared.collection.Pair<Long,org.opensaml.storage.StorageRecord<T>> read(@Nonnull
 String context,
 @Nonnull
 String key,
 long version)

update

public boolean update(@Nonnull
 String context,
 @Nonnull
 String key,
 @Nonnull
 String value,
 @Nullable
 Long expiration)

updateWithVersion

@Nullable
public Long updateWithVersion(long version,
 @Nonnull
 String context,
 @Nonnull
 String key,
 @Nonnull
 String value,
 @Nullable
 Long expiration)

updateExpiration

public boolean updateExpiration(@Nonnull
 String context,
 @Nonnull
 String key,
 @Nullable
 Long expiration)

delete

public boolean delete(@Nonnull
 String context,
 @Nonnull
 String artifactId)

deleteWithVersion

public boolean deleteWithVersion(long version,
 @Nonnull
 String context,
 @Nonnull
 String key)

reap

public void reap(@Nonnull
 String context)

updateContextExpiration

public void updateContextExpiration(@Nonnull
 String context,
 @Nullable
 Long expiration)

deleteContext

public void deleteContext(@Nonnull
 String context)