Package com.uc4.communication.requests

Class GetStorageItems

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetStorageItems

All Implemented Interfaces:

Iterable<StorageItem>

public class GetStorageItems
extends XMLRequest
implements Iterable<StorageItem>

Lists all resources from a storage object. Class contains also static method GetStorageItems.getECCPlugIns() which will generate list with all ECCPlugIns.

Constructor Summary

Constructors

Constructor	Description
GetStorageItems(UC4ObjectName name)	Construct this object and set requested storage name.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
static GetStorageItems	getECCPlugIns()	Create new object which points to storage with all ECC PlugIns.
protected String	getSrc()	Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
Iterator<StorageItem>	iterator()	Returns an Iterator which can be used to step through the StorageItem.
int	size()	Returns the total number of items in the storage object.

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

GetStorageItems

public GetStorageItems(UC4ObjectName name)

Construct this object and set requested storage name.

Parameters:

name - Name of the storage object

Method Details

getSrc

protected String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
 Element request,
 ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
 ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise

iterator

public Iterator<StorageItem> iterator()

Returns an Iterator which can be used to step through the StorageItem.

Specified by:

iterator in interface Iterable<StorageItem>

Returns:

Iterator containing StorageItem

size

public int size()

Returns the total number of items in the storage object.

Returns:

number of StorageItem

getECCPlugIns

public static GetStorageItems getECCPlugIns()

Create new object which points to storage with all ECC PlugIns.

Returns:

items object GetStorageItems