Package com.uc4.communication.requests

Class TemplateList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.TemplateList

All Implemented Interfaces:

java.lang.Iterable<Template>

public class TemplateList
extends XMLRequest
implements java.lang.Iterable<Template>

Returns a list of templates for UC4 Objects.

Constructor Summary

Constructors

Constructor	Description
TemplateList()	Creates a template list of all Automic objects.
TemplateList(IFolder folder)	Creates a list of templates in a specified folder.

Method Summary

Modifier and Type	Method	Description
static TemplateList	agentTemplatesOnly()	Creates a request for agent templates defined in UC_OBJECT_TEMPLATES of client zero.
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected java.lang.String	getSrc()	Returns the request source.
Template	getTemplate(java.lang.String templateName)	Returns a Template given template name or null if the template was not found.
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.
java.util.Iterator<Template>	iterator()	Returns an Iterator to iterate over the template collection.
int	size()	Returns the number of templates.

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 Detail

TemplateList

public TemplateList()

Creates a template list of all Automic objects.

TemplateList

public TemplateList(IFolder folder)

Creates a list of templates in a specified folder. This checks the folder permissions.

Parameters:

folder - Folder where an object should be created

Method Detail

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

agentTemplatesOnly

public static TemplateList agentTemplatesOnly()

Creates a request for agent templates defined in UC_OBJECT_TEMPLATES of client zero. This request can be used in any client.

Returns:

TemplateList request that returns only agents

iterator

public java.util.Iterator<Template> iterator()

Returns an Iterator to iterate over the template collection.

Specified by:

iterator in interface java.lang.Iterable<Template>

Returns:

Iterator

getTemplate

public Template getTemplate(java.lang.String templateName)

Returns a Template given template name or null if the template was not found.

Parameters:

templateName - template name

Returns:

Template object

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.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

size

public int size()

Returns the number of templates.

Returns:

Integer containing the number of templates