Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemFileGetContentRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BWSystem.SystemFileGetContentResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemFileGetContentRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemFileGetContentRequest
extends Request<BWSystem.SystemFileGetContentResponse>

Requests the contents of a file. This transaction is only allowed to get content for files under /var/broadworks/userfiles/AuditLogs/ or /var/broadworks/IpDeviceConfig/. The response is either a SystemFileGetContentResponse or an ErrorResponse.

Author:

AlpacaGenerator

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull @Size(min=1) String	fileName

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor	Description
SystemFileGetContentRequest()
SystemFileGetContentRequest(BroadWorksServer broadWorksServer, String fileName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemFileGetContentRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getFileName()
BWSystem.SystemFileGetContentRequest	setFileName(String fileName)

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

fileName

@NotNull
@Size(min=1)
protected @NotNull @Size(min=1) String fileName

Constructor Detail

SystemFileGetContentRequest

public SystemFileGetContentRequest()

SystemFileGetContentRequest

public SystemFileGetContentRequest(BroadWorksServer broadWorksServer,
                                   String fileName)

Method Detail

setFileName

public BWSystem.SystemFileGetContentRequest setFileName(String fileName)

getFileName

public String getFileName()

getEmptyObject

public static BWSystem.SystemFileGetContentRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<BWSystem.SystemFileGetContentResponse>