FileDocCategorySizeDatePackage
CompositeMetadata.javaAPI DocGlassfish v2 API4507Fri May 04 22:35:28 BST 2007com.sun.appserv.ha.spi

CompositeMetadata

public final class CompositeMetadata extends Metadata
A class to hold a collection of children AttributeMetadata. This class is used mainly to store a collection of AttributeMetaData that are part of a WebSession. The metadata about the web session itself can be obtained directly from the CompositeMetadata itself, while the metadata of its attributes can be obtained from the individual AttributeMetadata that is part of the collection returned by getEntries().

Fields Summary
private byte[]
state
private Collection
entries
private String
extraParam
Constructors Summary
public CompositeMetadata(long version, long lastAccessTime, long maxInactiveInterval, Collection entries, byte[] state, String extraParam)
Construct a CompositeMetadata object

param
version The version of the data. A freshly created state has a version == 0
param
lastAccesstime the last access time of the state. This must be used in conjunction with getMaxInactiveInterval to determine if the state is idle enough to be removed.
param
maxInactiveInterval the maximum time that this state can be idle in the store before it can be removed.
param
state The (trunk) state
param
extraParam Some more data
param
entries the AttributeMetadata that are part of this Metadata

        super(version, lastAccessTime, maxInactiveInterval);
        this.entries = entries;
        this.state = state;
        this.extraParam = extraParam;
Methods Summary
public java.util.CollectiongetEntries()
Returns a collection of Metadata (or its subclass). Note that though it is possible to have a compositeMetadata itself as part of this collection, typically they contain only AttributeMetaData

return
a collection of AttributeMetadata

        return entries;
public java.lang.StringgetExtraParam()
Get the extra param associated with this metadata

return
the extra param or null

        return extraParam;
public byte[]getState()
Get the state of the object that is stored.

return
the state or null

        return state;