Package co.ecg.alpaca.toolkit.generated

Class Login.DeviceManagementFileAuthLocationGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Login.DeviceManagementFileAuthLocationGetResponse>

co.ecg.alpaca.toolkit.generated.Login.DeviceManagementFileAuthLocationGetRequest

Enclosing class:

Login

public static class Login.DeviceManagementFileAuthLocationGetRequest
extends Request<Login.DeviceManagementFileAuthLocationGetResponse>

Get the address and credentials of the File Repository hosting the requested access device file. Also get the file name and path on the File Repository. The response is either DeviceManagementFileAuthLocationGetResponse22V3 or ErrorResponse. The following elements are only used in AS data mode and will fail in XS data mode: deviceToken The following elements are only used in XS data mode and will be ignored in AS data mode: fileNameLookup fileNameOnDisk

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 @Size(min=1,max=161) String	accessDeviceUserName
protected @Size(min=1,max=60) String	accessDeviceUserPassword
protected @NotNull @Size(min=1,max=40) String	deviceAccessMethod
protected @NotNull DeviceAccessProtocol22	deviceAccessProtocol
protected @NotNull @Size(min=1,max=256) String	deviceAccessURI
protected @Size(min=1) String	deviceToken
protected @Size(min=32,max=256) String	digestHa1Complement
protected @Size(min=32,max=32) String	digestResponse
protected Boolean	fileNameLookup
protected @Size(min=1,max=265) String	fileNameOnDisk
protected @Size(min=1,max=12) String	macAddress
protected @Size(min=1,max=265) String	realmName
protected @Size(min=1) String	signedPassword

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

log

Constructor Summary

Constructors

Constructor	Description
DeviceManagementFileAuthLocationGetRequest()
DeviceManagementFileAuthLocationGetRequest(BroadWorksServer broadWorksServer, DeviceAccessProtocol22 deviceAccessProtocol, String deviceAccessMethod, String deviceAccessURI)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getAccessDeviceUserName()
String	getAccessDeviceUserPassword()
String	getDeviceAccessMethod()
DeviceAccessProtocol22	getDeviceAccessProtocol()
String	getDeviceAccessURI()
String	getDeviceToken()
String	getDigestHa1Complement()
String	getDigestResponse()
static Login.DeviceManagementFileAuthLocationGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getFileNameLookup()
String	getFileNameOnDisk()
String	getMacAddress()
String	getRealmName()
String	getSignedPassword()
Login.DeviceManagementFileAuthLocationGetRequest	setAccessDeviceUserName(String accessDeviceUserName)
Login.DeviceManagementFileAuthLocationGetRequest	setAccessDeviceUserPassword(String accessDeviceUserPassword)
Login.DeviceManagementFileAuthLocationGetRequest	setDeviceAccessMethod(String deviceAccessMethod)
Login.DeviceManagementFileAuthLocationGetRequest	setDeviceAccessProtocol(DeviceAccessProtocol22 deviceAccessProtocol)
Login.DeviceManagementFileAuthLocationGetRequest	setDeviceAccessURI(String deviceAccessURI)
Login.DeviceManagementFileAuthLocationGetRequest	setDeviceToken(String deviceToken)
Login.DeviceManagementFileAuthLocationGetRequest	setDigestHa1Complement(String digestHa1Complement)
Login.DeviceManagementFileAuthLocationGetRequest	setDigestResponse(String digestResponse)
Login.DeviceManagementFileAuthLocationGetRequest	setFileNameLookup(Boolean fileNameLookup)
Login.DeviceManagementFileAuthLocationGetRequest	setFileNameOnDisk(String fileNameOnDisk)
Login.DeviceManagementFileAuthLocationGetRequest	setMacAddress(String macAddress)
Login.DeviceManagementFileAuthLocationGetRequest	setRealmName(String realmName)
Login.DeviceManagementFileAuthLocationGetRequest	setSignedPassword(String signedPassword)

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, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, 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 Details

deviceAccessProtocol

@NotNull
protected @NotNull DeviceAccessProtocol22 deviceAccessProtocol

deviceAccessMethod

@NotNull
@Size(min=1,
      max=40)
protected @NotNull @Size(min=1,max=40) String deviceAccessMethod

deviceAccessURI

@NotNull
@Size(min=1,
      max=256)
protected @NotNull @Size(min=1,max=256) String deviceAccessURI

accessDeviceUserName

@Size(min=1,
      max=161)
protected @Size(min=1,max=161) String accessDeviceUserName

accessDeviceUserPassword

@Size(min=1,
      max=60)
protected @Size(min=1,max=60) String accessDeviceUserPassword

deviceToken

@Size(min=1)
protected @Size(min=1) String deviceToken

signedPassword

@Size(min=1)
protected @Size(min=1) String signedPassword

macAddress

@Size(min=1,
      max=12)
protected @Size(min=1,max=12) String macAddress

realmName

@Size(min=1,
      max=265)
protected @Size(min=1,max=265) String realmName

digestHa1Complement

@Size(min=32,
      max=256)
protected @Size(min=32,max=256) String digestHa1Complement

digestResponse

@Size(min=32,
      max=32)
protected @Size(min=32,max=32) String digestResponse

fileNameLookup

protected Boolean fileNameLookup

fileNameOnDisk

@Size(min=1,
      max=265)
protected @Size(min=1,max=265) String fileNameOnDisk

Constructor Details

DeviceManagementFileAuthLocationGetRequest

public DeviceManagementFileAuthLocationGetRequest()

DeviceManagementFileAuthLocationGetRequest

public DeviceManagementFileAuthLocationGetRequest(BroadWorksServer broadWorksServer,
 DeviceAccessProtocol22 deviceAccessProtocol,
 String deviceAccessMethod,
 String deviceAccessURI)

Method Details

setDeviceAccessProtocol

public Login.DeviceManagementFileAuthLocationGetRequest setDeviceAccessProtocol(DeviceAccessProtocol22 deviceAccessProtocol)

getDeviceAccessProtocol

public DeviceAccessProtocol22 getDeviceAccessProtocol()

setDeviceAccessMethod

public Login.DeviceManagementFileAuthLocationGetRequest setDeviceAccessMethod(String deviceAccessMethod)

getDeviceAccessMethod

public String getDeviceAccessMethod()

setDeviceAccessURI

public Login.DeviceManagementFileAuthLocationGetRequest setDeviceAccessURI(String deviceAccessURI)

getDeviceAccessURI

public String getDeviceAccessURI()

setAccessDeviceUserName

public Login.DeviceManagementFileAuthLocationGetRequest setAccessDeviceUserName(String accessDeviceUserName)

getAccessDeviceUserName

public String getAccessDeviceUserName()

setAccessDeviceUserPassword

public Login.DeviceManagementFileAuthLocationGetRequest setAccessDeviceUserPassword(String accessDeviceUserPassword)

getAccessDeviceUserPassword

public String getAccessDeviceUserPassword()

setDeviceToken

public Login.DeviceManagementFileAuthLocationGetRequest setDeviceToken(String deviceToken)

getDeviceToken

public String getDeviceToken()

setSignedPassword

public Login.DeviceManagementFileAuthLocationGetRequest setSignedPassword(String signedPassword)

getSignedPassword

public String getSignedPassword()

setMacAddress

public Login.DeviceManagementFileAuthLocationGetRequest setMacAddress(String macAddress)

getMacAddress

public String getMacAddress()

setRealmName

public Login.DeviceManagementFileAuthLocationGetRequest setRealmName(String realmName)

getRealmName

public String getRealmName()

setDigestHa1Complement

public Login.DeviceManagementFileAuthLocationGetRequest setDigestHa1Complement(String digestHa1Complement)

getDigestHa1Complement

public String getDigestHa1Complement()

setDigestResponse

public Login.DeviceManagementFileAuthLocationGetRequest setDigestResponse(String digestResponse)

getDigestResponse

public String getDigestResponse()

setFileNameLookup

public Login.DeviceManagementFileAuthLocationGetRequest setFileNameLookup(Boolean fileNameLookup)

getFileNameLookup

public Boolean getFileNameLookup()

setFileNameOnDisk

public Login.DeviceManagementFileAuthLocationGetRequest setFileNameOnDisk(String fileNameOnDisk)

getFileNameOnDisk

public String getFileNameOnDisk()

getEmptyObject

public static Login.DeviceManagementFileAuthLocationGetRequest 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<Login.DeviceManagementFileAuthLocationGetResponse>