org.opensaml.storage

Class StorageRecord<Type>

java.lang.Object

org.opensaml.storage.StorageRecord<Type>

Type Parameters:

Type - the object type represented by the record

Direct Known Subclasses:

MemcachedStorageRecord, MutableStorageRecord

@NotThreadSafe
public class StorageRecord<Type>
extends java.lang.Object

Represents a versioned record in a StorageService.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Long	expiration Expiration field.
private java.lang.String	value Value field.
private long	version Version field.

Constructor Summary

Constructors

Constructor and Description
StorageRecord(java.lang.String val, java.lang.Long exp) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getExpiration() Get the record expiration.
java.lang.String	getValue() Get the record value.
Type	getValue(StorageSerializer<Type> serializer, java.lang.String context, java.lang.String key) Get the record value, using a custom deserialization process.
long	getVersion() Get the record version.
protected long	incrementVersion() Increment the record version and returns the new value.
protected void	setExpiration(java.lang.Long exp) Set the record expiration.
protected void	setValue(java.lang.String val) Set the record value.
protected void	setValue(Type instance, StorageSerializer<Type> serializer) Set the record value, using a custom serialization process.
protected void	setVersion(long ver) Set the record version.

Methods inherited from class java.lang.Object

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

Field Detail

version

private long version

Version field.

value

private java.lang.String value

Value field.

expiration

private java.lang.Long expiration

Expiration field.

Constructor Detail

StorageRecord

public StorageRecord(@Nonnull @NotEmpty
                     java.lang.String val,
                     @Nullable
                     java.lang.Long exp)

Constructor.

Parameters:

val - value

exp - expiration, or null if none

Method Detail

getVersion

public long getVersion()

Get the record version.

Returns:

the record version

getValue

@Nonnull
public java.lang.String getValue()

Get the record value.

Returns:

the record value

getValue

@Nonnull
public Type getValue(@Nonnull
                              StorageSerializer<Type> serializer,
                              @Nonnull @NotEmpty
                              java.lang.String context,
                              @Nonnull @NotEmpty
                              java.lang.String key)
                       throws java.io.IOException

Get the record value, using a custom deserialization process.

Parameters:

serializer - a custom (de)serialization process to apply

context - context of record

key - key of record

Returns:

the record value

Throws:

java.io.IOException - if deserialization fails

getExpiration

@Nullable
public java.lang.Long getExpiration()

Get the record expiration.

Returns:

the record expiration, or null if none

setVersion

protected void setVersion(long ver)

Set the record version.

Parameters:

ver - the new record version, must be > 0

setValue

protected void setValue(@Nonnull @NotEmpty
                        java.lang.String val)

Set the record value.

Parameters:

val - the new record value

setValue

protected void setValue(@Nonnull
                        Type instance,
                        @Nonnull
                        StorageSerializer<Type> serializer)
                 throws java.io.IOException

Set the record value, using a custom serialization process.

Parameters:

instance - the new record value

serializer - a custom serialization process to apply

Throws:

java.io.IOException - if serialization fails

setExpiration

protected void setExpiration(@Nullable
                             java.lang.Long exp)

Set the record expiration.

Parameters:

exp - the new record expiration, or null if none

incrementVersion

protected long incrementVersion()

Increment the record version and returns the new value.

Returns:

the updated version