cz.ues.platform.udds

Class UESObjectListing

java.lang.Object

cz.ues.platform.udds.UESObjectListing

public abstract class UESObjectListing
extends java.lang.Object

Contains the results of listing the objects in a UDDS bucket.

Since:

UES6-06

See Also:

UESStorageService.getObjectList(String, UESObjectListingCriteria), UESStorageService.getNextObjectList(String, UESObjectListing)

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	commonPrefixes Common prefixes included in this object listing.
private java.lang.String	delimiter The delimiter parameter originally used to request this object listing, or null if no delimiter specified.
private java.lang.String	marker The marker parameter originally used to request this object listing, or null if no marker was specified.
private java.lang.String	nextMarker The marker to use in the next getObjectList request in order to see the next page of results.
private java.util.List<UESStorageObjectSummary>	objectSummaries List of object summaries describing the objects stored in the UDDS bucket.
private int	pageSize The maxListingLength parameter originally used to request this object listing, or the default maxListingLength value provided by UDDS if the requester didn't specify a value.
private java.lang.String	prefix The prefix parameter originally used to request this object listing, or null if no prefix was specified.
private boolean	trunkated Whether or not this object listing is complete.

Constructor Summary

Constructors

Constructor and Description
UESObjectListing()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCommonPrefixes() Gets the common prefixes included in this object listing.
java.lang.String	getDelimiter() Getter for property delimiter.
java.lang.String	getMarker() Getter for property marker.
java.lang.String	getNextMarker() Getter for property nextMarker.
java.util.List<UESStorageObjectSummary>	getObjectSummaries() Gets the list of object summaries describing the objects stored in the UDDS bucket.
int	getPageSize() Getter for property pageSize.
java.lang.String	getPrefix() Getter for property prefix.
boolean	isTrunkated() Getter for property trunkated.
void	setCommonPrefixes(java.util.List<java.lang.String> commonPrefixes) Setter for property commonPrefixes.
void	setDelimiter(java.lang.String delimiter) Setter for property delimiter.
void	setMarker(java.lang.String marker) Setter for property marker.
void	setNextMarker(java.lang.String nextMarker) Setter for property nextMarker.
protected void	setObjectSummaries(java.util.List<UESStorageObjectSummary> objectSummaries) Setter for property objectSummaries.
void	setPageSize(int pageSize) Setter for property pageSize.
void	setPrefix(java.lang.String prefix) Setter for property prefix.
void	setTrunkated(boolean trunkated) Setter for property trunkated.

Methods inherited from class java.lang.Object

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

Field Detail

prefix

private prefix

The prefix parameter originally used to request this object listing, or null if no prefix was specified.

Since:

UES6-06

marker

private marker

The marker parameter originally used to request this object listing, or null if no marker was specified.

Since:

UES6-06

delimiter

private delimiter

The delimiter parameter originally used to request this object listing, or null if no delimiter specified.

Since:

UES6-06

pageSize

private pageSize

The maxListingLength parameter originally used to request this object listing, or the default maxListingLength value provided by UDDS if the requester didn't specify a value.

Since:

UES6-06

nextMarker

private nextMarker

The marker to use in the next getObjectList request in order to see the next page of results.

Since:

UES6-06

commonPrefixes

private commonPrefixes

Common prefixes included in this object listing.

Since:

UES6-06

trunkated

private trunkated

Whether or not this object listing is complete.

Since:

UES6-06

objectSummaries

private objectSummaries

List of object summaries describing the objects stored in the UDDS bucket.

Since:

UES6-06

Constructor Detail

UESObjectListing

public UESObjectListing()

Method Detail

getPrefix

public java.lang.String getPrefix()

Getter for property prefix.

Returns:

the prefix

Since:

UES6-06

setPrefix

public void setPrefix(java.lang.String prefix)

Setter for property prefix.

Parameters:

prefix - the prefix to set

Since:

UES6-06

getMarker

public java.lang.String getMarker()

Getter for property marker.

Returns:

the marker

Since:

UES6-06

setMarker

public void setMarker(java.lang.String marker)

Setter for property marker.

Parameters:

marker - the marker to set

Since:

UES6-06

getDelimiter

public java.lang.String getDelimiter()

Getter for property delimiter.

Returns:

the delimiter

Since:

UES6-06

setDelimiter

public void setDelimiter(java.lang.String delimiter)

Setter for property delimiter.

Parameters:

delimiter - the delimiter to set

Since:

UES6-06

getPageSize

public int getPageSize()

Getter for property pageSize.

Returns:

the pageSize

Since:

UES6-06

setPageSize

public void setPageSize(int pageSize)

Setter for property pageSize.

Parameters:

pageSize - the pageSize to set

Since:

UES6-06

getNextMarker

public java.lang.String getNextMarker()

Getter for property nextMarker.

Returns:

the nextMarker

Since:

UES6-06

setNextMarker

public void setNextMarker(java.lang.String nextMarker)

Setter for property nextMarker.

Parameters:

nextMarker - the nextMarker to set

Since:

UES6-06

getCommonPrefixes

public java.util.List<java.lang.String> getCommonPrefixes()

Gets the common prefixes included in this object listing. Common prefixes are only present if a delimiter was specified in the original request.

Each common prefix represents a set of keys in the UDDS bucket that have been condensed and omitted from the object summary results. This allows applications to organize and browse their keys hierarchically, similar to how a file system organizes files into directories.

For example, consider a bucket that contains the following keys:

• "foo/bar/baz"
• "foo/bar/bash"
• "foo/bar/bang"
• "foo/boo"

If calling getObjectList with the prefix="foo/" and the delimiter="/" on this bucket, the returned UESObjectListing will contain one entry in the common prefixes list ("foo/bar/") and none of the keys beginning with that common prefix will be included in the object summaries list.

Returns:

the commonPrefixes

Since:

UES6-06

setCommonPrefixes

public void setCommonPrefixes(java.util.List<java.lang.String> commonPrefixes)

Setter for property commonPrefixes.

Parameters:

commonPrefixes - the commonPrefixes to set

Since:

UES6-06

isTrunkated

public boolean isTrunkated()

Getter for property trunkated.

Returns:

the trunkated

Since:

UES6-06

setTrunkated

public void setTrunkated(boolean trunkated)

Setter for property trunkated.

Parameters:

trunkated - the trunkated to set

Since:

UES6-06

getObjectSummaries

public java.util.List<UESStorageObjectSummary> getObjectSummaries()

Gets the list of object summaries describing the objects stored in the UDDS bucket. Listings for large buckets can be truncated for performance reasons. Always check the UESObjectListing.isTrunkated() method to see if the returned listing is complete or if additional calls are needed to get more results. Callers might need to make additional calls to UESStorageService#getNextObjectIdList(String, UESObjectListing) to get additional results.

Returns:

A list of the object summaries describing the objects stored in the UDDS bucket.

Since:

UES6-06

setObjectSummaries

protected final void setObjectSummaries(java.util.List<UESStorageObjectSummary> objectSummaries)

Setter for property objectSummaries.

Parameters:

objectSummaries - the objectSummaries to set

Since:

UES6-06