Package net.shibboleth.sp.storage.impl

Class FilesystemStorageService

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

org.opensaml.storage.AbstractStorageService

net.shibboleth.sp.storage.impl.FilesystemStorageService

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, StorageCapabilities, StorageService

public class FilesystemStorageService
extends AbstractStorageService

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	clustered	Tracks use of a shared file system for capability method.
private boolean	readOnly	Whether service is read only.
private String	storageBase	Base location of storage tree in filesystem.

Constructor Summary

Constructors

Constructor	Description
FilesystemStorageService()

Method Summary

Modifier and Type	Method	Description
boolean	create(String context, String key, String value, Long expiration)
boolean	delete(String context, String key)
void	deleteContext(String context)
boolean	deleteWithVersion(long version, String context, String key)
protected void	doInitialize()
boolean	isClustered()
boolean	isServerSide()
<T> StorageRecord<T>	read(String context, String key)
<T> Pair<Long,StorageRecord<T>>	read(String context, String key, long version)
void	reap(String context)
void	setClustered(boolean flag)	Sets whether the file system is clustered.
void	setReadOnly(boolean flag)	Sets whether the service should operate read-only.
void	setStorageBase(String base)	Sets the base/root directory under which objects will be created and deleted.
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, getCapabilities, getCleanupInterval, getCleanupTask, getCleanupTaskTimer, getContextSize, getKeySize, 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

clustered

private boolean clustered

Tracks use of a shared file system for capability method.

readOnly

private boolean readOnly

Whether service is read only.

storageBase

@NonnullAfterInit
private String storageBase

Base location of storage tree in filesystem.

Constructor Details

FilesystemStorageService

public FilesystemStorageService()

Method Details

setClustered

public void setClustered(boolean flag)

Sets whether the file system is clustered.

Defaults to false.

Parameters:

flag - flag to set

setReadOnly

public void setReadOnly(boolean flag)

Sets whether the service should operate read-only.

Defaults to false.

Parameters:

flag - flag to set

setStorageBase

public void setStorageBase(@Nonnull @NotEmpty
 String base)

Sets the base/root directory under which objects will be created and deleted.

Must be an absolute path.

Parameters:

base - storage root location

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractStorageService

Throws:

ComponentInitializationException

create

public boolean create(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nonnull @NotEmpty
 String value,
 @Nullable @Positive
 Long expiration)
               throws IOException

Throws:

IOException

read

@Nullable
public <T> StorageRecord<T> read(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key)
                          throws IOException

Throws:

IOException

read

@Nonnull
public <T> Pair<Long,StorageRecord<T>> read(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 long version)
                                     throws IOException

Throws:

IOException

update

public boolean update(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nonnull @NotEmpty
 String value,
 @Nullable @Positive
 Long expiration)
               throws IOException

Throws:

IOException

updateWithVersion

public Long updateWithVersion(long version,
 @Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nonnull @NotEmpty
 String value,
 @Nullable @Positive
 Long expiration)
                       throws IOException,
VersionMismatchException

Throws:

IOException

VersionMismatchException

updateExpiration

public boolean updateExpiration(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key,
 @Nullable @Positive
 Long expiration)
                         throws IOException

Throws:

IOException

delete

public boolean delete(@Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key)
               throws IOException

Throws:

IOException

deleteWithVersion

public boolean deleteWithVersion(long version,
 @Nonnull @NotEmpty
 String context,
 @Nonnull @NotEmpty
 String key)
                          throws IOException,
VersionMismatchException

Throws:

IOException

VersionMismatchException

reap

public void reap(@Nonnull @NotEmpty
 String context)
          throws IOException

Throws:

IOException

updateContextExpiration

public void updateContextExpiration(@Nonnull @NotEmpty
 String context,
 @Nullable @Positive
 Long expiration)
                             throws IOException

Throws:

IOException

deleteContext

public void deleteContext(@Nonnull @NotEmpty
 String context)
                   throws IOException

Throws:

IOException

isServerSide

public boolean isServerSide()

isClustered

public boolean isClustered()