Package co.ecg.alpaca.toolkit.generated

Class ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest

Enclosing class:

ServiceProviderAccessDevice

@ChoiceGroup("deviceExternalId") @ChoiceGroup("serviceProviderAccessDevice")
public static class ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest
extends Request<DefaultResponse>

Request to modify a specified service provider 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: 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 Optional<@Valid DeviceManagementUserNamePassword16>	accessDeviceCredentials
protected Optional<@Size(min=1,max=80) String>	description
protected @Size(max=36) String	deviceExternalId
protected Optional<@Size(min=1,max=12) String>	macAddress
protected Optional<@Size(min=1,max=80) String>	netAddress
protected Optional<@Size(min=1,max=80) String>	outboundProxyServerNetAddress
protected Optional<@Size(min=1,max=1024) String>	physicalLocation
protected Optional<Integer>	port
protected @Size(min=1,max=20) String	protocol
protected Optional<@Size(min=1,max=80) String>	serialNumber
protected @Valid ServiceProviderAccessDevice	serviceProviderAccessDevice
protected Optional<@Size(min=1,max=80) String>	stunServerNetAddress
protected ExtendedTransportProtocol	transportProtocol
protected Boolean	useCustomUserNamePassword

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderAccessDeviceModifyRequest()
ServiceProviderAccessDeviceModifyRequest(ServiceProviderAccessDevice serviceProviderAccessDevice)
ServiceProviderAccessDeviceModifyRequest(BroadWorksServer broadWorksServer)
ServiceProviderAccessDeviceModifyRequest(BroadWorksServer broadWorksServer, String deviceExternalId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Optional<@Valid DeviceManagementUserNamePassword16>	getAccessDeviceCredentials()
Optional<@Size(min=1,max=80) String>	getDescription()
String	getDeviceExternalId()
Optional<@Size(min=1,max=12) String>	getMacAddress()
Optional<@Size(min=1,max=80) String>	getNetAddress()
Optional<@Size(min=1,max=80) String>	getOutboundProxyServerNetAddress()
Optional<@Size(min=1,max=1024) String>	getPhysicalLocation()
Optional<Integer>	getPort()
String	getProtocol()
Optional<@Size(min=1,max=80) String>	getSerialNumber()
ServiceProviderAccessDevice	getServiceProviderAccessDevice()
Optional<@Size(min=1,max=80) String>	getStunServerNetAddress()
ExtendedTransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setDescription(String description)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setDeviceExternalId(String deviceExternalId)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setMacAddress(String macAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setNetAddress(String netAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setPhysicalLocation(String physicalLocation)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setPort(Integer port)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setProtocol(String protocol)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setSerialNumber(String serialNumber)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setServiceProviderAccessDevice(ServiceProviderAccessDevice serviceProviderAccessDevice)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setStunServerNetAddress(String stunServerNetAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setTransportProtocol(ExtendedTransportProtocol transportProtocol)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetAccessDeviceCredentials()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetDescription()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetMacAddress()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetNetAddress()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetOutboundProxyServerNetAddress()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetPhysicalLocation()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetPort()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetSerialNumber()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	unsetStunServerNetAddress()

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

serviceProviderAccessDevice

@Valid
protected transient @Valid ServiceProviderAccessDevice serviceProviderAccessDevice

deviceExternalId

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

protocol

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

netAddress

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

port

protected Optional<Integer> port

outboundProxyServerNetAddress

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

stunServerNetAddress

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

macAddress

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

serialNumber

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

description

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

physicalLocation

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

transportProtocol

protected ExtendedTransportProtocol transportProtocol

useCustomUserNamePassword

protected Boolean useCustomUserNamePassword

accessDeviceCredentials

protected Optional<@Valid DeviceManagementUserNamePassword16> accessDeviceCredentials

Constructor Details

ServiceProviderAccessDeviceModifyRequest

public ServiceProviderAccessDeviceModifyRequest()

ServiceProviderAccessDeviceModifyRequest

public ServiceProviderAccessDeviceModifyRequest(BroadWorksServer broadWorksServer)

ServiceProviderAccessDeviceModifyRequest

public ServiceProviderAccessDeviceModifyRequest(ServiceProviderAccessDevice serviceProviderAccessDevice)

ServiceProviderAccessDeviceModifyRequest

public ServiceProviderAccessDeviceModifyRequest(BroadWorksServer broadWorksServer,
 String deviceExternalId)

Method Details

setServiceProviderAccessDevice

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setServiceProviderAccessDevice(ServiceProviderAccessDevice serviceProviderAccessDevice)

getServiceProviderAccessDevice

public ServiceProviderAccessDevice getServiceProviderAccessDevice()

setDeviceExternalId

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

setProtocol

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setProtocol(String protocol)

getProtocol

public String getProtocol()

unsetNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetNetAddress()

setNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setNetAddress(String netAddress)

getNetAddress

public Optional<@Size(min=1,max=80) String> getNetAddress()

unsetPort

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetPort()

setPort

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setPort(Integer port)

getPort

public Optional<Integer> getPort()

unsetOutboundProxyServerNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetOutboundProxyServerNetAddress()

setOutboundProxyServerNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)

getOutboundProxyServerNetAddress

public Optional<@Size(min=1,max=80) String> getOutboundProxyServerNetAddress()

unsetStunServerNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetStunServerNetAddress()

setStunServerNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setStunServerNetAddress(String stunServerNetAddress)

getStunServerNetAddress

public Optional<@Size(min=1,max=80) String> getStunServerNetAddress()

unsetMacAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetMacAddress()

setMacAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setMacAddress(String macAddress)

getMacAddress

public Optional<@Size(min=1,max=12) String> getMacAddress()

unsetSerialNumber

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetSerialNumber()

setSerialNumber

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setSerialNumber(String serialNumber)

getSerialNumber

public Optional<@Size(min=1,max=80) String> getSerialNumber()

unsetDescription

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetDescription()

setDescription

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setDescription(String description)

getDescription

public Optional<@Size(min=1,max=80) String> getDescription()

unsetPhysicalLocation

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetPhysicalLocation()

setPhysicalLocation

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setPhysicalLocation(String physicalLocation)

getPhysicalLocation

public Optional<@Size(min=1,max=1024) String> getPhysicalLocation()

setTransportProtocol

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setTransportProtocol(ExtendedTransportProtocol transportProtocol)

getTransportProtocol

public ExtendedTransportProtocol getTransportProtocol()

setUseCustomUserNamePassword

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

unsetAccessDeviceCredentials

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest unsetAccessDeviceCredentials()

setAccessDeviceCredentials

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)

getAccessDeviceCredentials

public Optional<@Valid DeviceManagementUserNamePassword16> getAccessDeviceCredentials()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<DefaultResponse>