org.lockss.laaws.rs.impl

Class ArtifactContinuationToken

java.lang.Object

org.lockss.laaws.rs.impl.ArtifactContinuationToken

public class ArtifactContinuationToken
extends Object

The continuation token used to paginate through a list of artifacts.

Author:

Fernando García-Loygorri

Constructor Summary

Constructors

Constructor and Description
ArtifactContinuationToken(String webRequestContinuationToken) Constructor from a web request continuation token.
ArtifactContinuationToken(String collectionId, String auid, String uri, Integer version, Integer iteratorHashCode) Constructor from members.

Method Summary

Modifier and Type	Method and Description
String	getAuid() Provides the archival unit identifier of the last artifact transferred.
String	getCollectionId() Provides the collection identifier of the last artifact transferred.
Integer	getIteratorHashCode() Provides the hash code of the iterator used.
String	getUri() Provides the URI of the last artifact transferred.
Integer	getVersion() Provides the version of the last artifact transferred.
String	toString()
String	toWebResponseContinuationToken() Provides this object in the form of a web response continuation token.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactContinuationToken

public ArtifactContinuationToken(String webRequestContinuationToken)
                          throws IllegalArgumentException

Constructor from a web request continuation token.

Parameters:

webRequestContinuationToken - A String with the web request continuation token.

Throws:

IllegalArgumentException - if the web request continuation token is not syntactically valid.

ArtifactContinuationToken

public ArtifactContinuationToken(String collectionId,
                                 String auid,
                                 String uri,
                                 Integer version,
                                 Integer iteratorHashCode)

Constructor from members.

Parameters:

collectionId - A String with the collection identifier of the last artifact transferred.

auid - A String with the archival unit identifier of the last artifact transferred.

uri - A String with the URI of the last artifact transferred.

version - An Integer with the version of the last artifact transferred.

iteratorHashCode - An Integer with the hash code of the iterator used.

Method Detail

getCollectionId

public String getCollectionId()

Provides the collection identifier of the last artifact transferred.

Returns:

a String with the collection identifier of the last artifact transferred.

getAuid

public String getAuid()

Provides the archival unit identifier of the last artifact transferred.

Returns:

a String with the archival unit identifier of the last artifact transferred.

getUri

public String getUri()

Provides the URI of the last artifact transferred.

Returns:

a String with the URI of the last artifact transferred.

getVersion

public Integer getVersion()

Provides the version of the last artifact transferred.

Returns:

an Integer with the version of the last artifact transferred.

getIteratorHashCode

public Integer getIteratorHashCode()

Provides the hash code of the iterator used.

Returns:

an Integer with the hash code of the iterator used.

toWebResponseContinuationToken

public String toWebResponseContinuationToken()

Provides this object in the form of a web response continuation token.

Returns:

a String with this object in the form of a web response continuation token.

toString

public String toString()

Overrides:

toString in class Object