Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceAddRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceAddRequest

Enclosing class:

SystemAccessDevice

@ChoiceGroup("deviceName") @ChoiceGroup("deviceExternalId")
public static class SystemAccessDevice.SystemAccessDeviceAddRequest
extends Request<DefaultResponse>

Request to add a system-level access device. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: isWebexTeamsDevice defaultPathHeader deviceExternalId

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 @Valid DeviceManagementUserNamePassword16	accessDeviceCredentials
protected @Size(min=1,max=1024) String	defaultPathHeader
protected @Size(min=1,max=80) String	description
protected @Size(max=36) String	deviceExternalId
protected @Size(min=1,max=40) String	deviceName
protected @NotNull @Size(min=1,max=40) String	deviceType
protected Boolean	isWebexTeamsDevice
protected @Size(min=1,max=12) String	macAddress
protected @Size(min=1,max=80) String	netAddress
protected @Size(min=1,max=80) String	outboundProxyServerNetAddress
protected @Size(min=1,max=1024) String	physicalLocation
protected Integer	port
protected @Size(min=1,max=20) String	protocol
protected @Size(min=1,max=80) String	serialNumber
protected @Size(min=1,max=80) String	stunServerNetAddress
protected TransportProtocol	transportProtocol
protected Boolean	useCustomUserNamePassword

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceAddRequest()
SystemAccessDeviceAddRequest(BroadWorksServer broadWorksServer, String deviceType)
SystemAccessDeviceAddRequest(BroadWorksServer broadWorksServer, String deviceName, String deviceType)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
DeviceManagementUserNamePassword16	getAccessDeviceCredentials()
String	getDefaultPathHeader()
String	getDescription()
String	getDeviceExternalId()
String	getDeviceName()
String	getDeviceType()
static SystemAccessDevice.SystemAccessDeviceAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getIsWebexTeamsDevice()
String	getMacAddress()
String	getNetAddress()
String	getOutboundProxyServerNetAddress()
String	getPhysicalLocation()
Integer	getPort()
String	getProtocol()
String	getSerialNumber()
String	getStunServerNetAddress()
TransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
SystemAccessDevice.SystemAccessDeviceAddRequest	setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)
SystemAccessDevice.SystemAccessDeviceAddRequest	setDefaultPathHeader(String defaultPathHeader)
SystemAccessDevice.SystemAccessDeviceAddRequest	setDescription(String description)
SystemAccessDevice.SystemAccessDeviceAddRequest	setDeviceExternalId(String deviceExternalId)
SystemAccessDevice.SystemAccessDeviceAddRequest	setDeviceName(String deviceName)
SystemAccessDevice.SystemAccessDeviceAddRequest	setDeviceType(String deviceType)
SystemAccessDevice.SystemAccessDeviceAddRequest	setIsWebexTeamsDevice(Boolean isWebexTeamsDevice)
SystemAccessDevice.SystemAccessDeviceAddRequest	setMacAddress(String macAddress)
SystemAccessDevice.SystemAccessDeviceAddRequest	setNetAddress(String netAddress)
SystemAccessDevice.SystemAccessDeviceAddRequest	setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)
SystemAccessDevice.SystemAccessDeviceAddRequest	setPhysicalLocation(String physicalLocation)
SystemAccessDevice.SystemAccessDeviceAddRequest	setPort(Integer port)
SystemAccessDevice.SystemAccessDeviceAddRequest	setProtocol(String protocol)
SystemAccessDevice.SystemAccessDeviceAddRequest	setSerialNumber(String serialNumber)
SystemAccessDevice.SystemAccessDeviceAddRequest	setStunServerNetAddress(String stunServerNetAddress)
SystemAccessDevice.SystemAccessDeviceAddRequest	setTransportProtocol(TransportProtocol transportProtocol)
SystemAccessDevice.SystemAccessDeviceAddRequest	setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

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 Detail

deviceName

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

deviceExternalId

@Size(max=36)
protected @Size(max=36) String deviceExternalId

deviceType

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

protocol

@Size(min=1,
      max=20)
protected @Size(min=1,max=20) String protocol

netAddress

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String netAddress

port

protected Integer port

outboundProxyServerNetAddress

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String outboundProxyServerNetAddress

stunServerNetAddress

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String stunServerNetAddress

macAddress

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

serialNumber

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String serialNumber

description

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String description

physicalLocation

@Size(min=1,
      max=1024)
protected @Size(min=1,max=1024) String physicalLocation

transportProtocol

protected TransportProtocol transportProtocol

useCustomUserNamePassword

protected Boolean useCustomUserNamePassword

accessDeviceCredentials

@Valid
protected @Valid DeviceManagementUserNamePassword16 accessDeviceCredentials

isWebexTeamsDevice

protected Boolean isWebexTeamsDevice

defaultPathHeader

@Size(min=1,
      max=1024)
protected @Size(min=1,max=1024) String defaultPathHeader

Constructor Detail

SystemAccessDeviceAddRequest

public SystemAccessDeviceAddRequest()

SystemAccessDeviceAddRequest

public SystemAccessDeviceAddRequest(BroadWorksServer broadWorksServer,
                                    String deviceType)

SystemAccessDeviceAddRequest

public SystemAccessDeviceAddRequest(BroadWorksServer broadWorksServer,
                                    String deviceName,
                                    String deviceType)

Method Detail

setDeviceName

public SystemAccessDevice.SystemAccessDeviceAddRequest setDeviceName(String deviceName)

getDeviceName

public String getDeviceName()

setDeviceExternalId

public SystemAccessDevice.SystemAccessDeviceAddRequest setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

setDeviceType

public SystemAccessDevice.SystemAccessDeviceAddRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setProtocol

public SystemAccessDevice.SystemAccessDeviceAddRequest setProtocol(String protocol)

getProtocol

public String getProtocol()

setNetAddress

public SystemAccessDevice.SystemAccessDeviceAddRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public SystemAccessDevice.SystemAccessDeviceAddRequest setPort(Integer port)

getPort

public Integer getPort()

setOutboundProxyServerNetAddress

public SystemAccessDevice.SystemAccessDeviceAddRequest setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)

getOutboundProxyServerNetAddress

public String getOutboundProxyServerNetAddress()

setStunServerNetAddress

public SystemAccessDevice.SystemAccessDeviceAddRequest setStunServerNetAddress(String stunServerNetAddress)

getStunServerNetAddress

public String getStunServerNetAddress()

setMacAddress

public SystemAccessDevice.SystemAccessDeviceAddRequest setMacAddress(String macAddress)

getMacAddress

public String getMacAddress()

setSerialNumber

public SystemAccessDevice.SystemAccessDeviceAddRequest setSerialNumber(String serialNumber)

getSerialNumber

public String getSerialNumber()

setDescription

public SystemAccessDevice.SystemAccessDeviceAddRequest setDescription(String description)

getDescription

public String getDescription()

setPhysicalLocation

public SystemAccessDevice.SystemAccessDeviceAddRequest setPhysicalLocation(String physicalLocation)

getPhysicalLocation

public String getPhysicalLocation()

setTransportProtocol

public SystemAccessDevice.SystemAccessDeviceAddRequest setTransportProtocol(TransportProtocol transportProtocol)

getTransportProtocol

public TransportProtocol getTransportProtocol()

setUseCustomUserNamePassword

public SystemAccessDevice.SystemAccessDeviceAddRequest setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

setAccessDeviceCredentials

public SystemAccessDevice.SystemAccessDeviceAddRequest setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)

getAccessDeviceCredentials

public DeviceManagementUserNamePassword16 getAccessDeviceCredentials()

setIsWebexTeamsDevice

public SystemAccessDevice.SystemAccessDeviceAddRequest setIsWebexTeamsDevice(Boolean isWebexTeamsDevice)

getIsWebexTeamsDevice

public Boolean getIsWebexTeamsDevice()

setDefaultPathHeader

public SystemAccessDevice.SystemAccessDeviceAddRequest setDefaultPathHeader(String defaultPathHeader)

getDefaultPathHeader

public String getDefaultPathHeader()

getEmptyObject

public static SystemAccessDevice.SystemAccessDeviceAddRequest 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<DefaultResponse>