Package co.ecg.alpaca.toolkit.generated

Class ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest

Enclosing class:

ServiceProviderAccessDevice

@ChoiceGroup({"serviceProviderId","deviceName"}) @ChoiceGroup({"serviceProviderExternalId","deviceExternalId"})
public static class ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest
extends Request<DefaultResponse>

Request to add a 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: serviceProviderExternalId deviceExternalId deviceIPEI

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=80) String	description
protected @Size(max=36) String	deviceExternalId
protected @Size(min=1,max=80) String	deviceIPEI
protected @Size(min=1,max=40) String	deviceName
protected @NotNull @Size(min=1,max=40) String	deviceType
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(max=36) String	serviceProviderExternalId
protected @Size(min=1,max=30) String	serviceProviderId
protected @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
ServiceProviderAccessDeviceAddRequest()
ServiceProviderAccessDeviceAddRequest(BroadWorksServer broadWorksServer, String deviceType)
ServiceProviderAccessDeviceAddRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String deviceName, String deviceType)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
DeviceManagementUserNamePassword16	getAccessDeviceCredentials()
String	getDescription()
String	getDeviceExternalId()
String	getDeviceIPEI()
String	getDeviceName()
String	getDeviceType()
static ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getMacAddress()
String	getNetAddress()
String	getOutboundProxyServerNetAddress()
String	getPhysicalLocation()
Integer	getPort()
String	getProtocol()
String	getSerialNumber()
String	getServiceProviderExternalId()
String	getServiceProviderId()
String	getStunServerNetAddress()
ExtendedTransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setDescription(String description)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setDeviceExternalId(String deviceExternalId)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setDeviceIPEI(String deviceIPEI)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setDeviceName(String deviceName)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setDeviceType(String deviceType)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setMacAddress(String macAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setNetAddress(String netAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setPhysicalLocation(String physicalLocation)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setPort(Integer port)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setProtocol(String protocol)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setSerialNumber(String serialNumber)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setServiceProviderExternalId(String serviceProviderExternalId)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setServiceProviderId(String serviceProviderId)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setStunServerNetAddress(String stunServerNetAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	setTransportProtocol(ExtendedTransportProtocol transportProtocol)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	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 Details

serviceProviderId

@Size(min=1,
      max=30)
protected @Size(min=1,max=30) String serviceProviderId

deviceName

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

serviceProviderExternalId

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

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 ExtendedTransportProtocol transportProtocol

useCustomUserNamePassword

protected Boolean useCustomUserNamePassword

accessDeviceCredentials

@Valid
protected @Valid DeviceManagementUserNamePassword16 accessDeviceCredentials

deviceIPEI

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

Constructor Details

ServiceProviderAccessDeviceAddRequest

public ServiceProviderAccessDeviceAddRequest()

ServiceProviderAccessDeviceAddRequest

public ServiceProviderAccessDeviceAddRequest(BroadWorksServer broadWorksServer,
 String deviceType)

ServiceProviderAccessDeviceAddRequest

public ServiceProviderAccessDeviceAddRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String deviceName,
 String deviceType)

Method Details

setServiceProviderId

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setDeviceName

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setDeviceName(String deviceName)

getDeviceName

public String getDeviceName()

setServiceProviderExternalId

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setServiceProviderExternalId(String serviceProviderExternalId)

getServiceProviderExternalId

public String getServiceProviderExternalId()

setDeviceExternalId

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

setDeviceType

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setProtocol

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setProtocol(String protocol)

getProtocol

public String getProtocol()

setNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setPort(Integer port)

getPort

public Integer getPort()

setOutboundProxyServerNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)

getOutboundProxyServerNetAddress

public String getOutboundProxyServerNetAddress()

setStunServerNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setStunServerNetAddress(String stunServerNetAddress)

getStunServerNetAddress

public String getStunServerNetAddress()

setMacAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setMacAddress(String macAddress)

getMacAddress

public String getMacAddress()

setSerialNumber

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setSerialNumber(String serialNumber)

getSerialNumber

public String getSerialNumber()

setDescription

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setDescription(String description)

getDescription

public String getDescription()

setPhysicalLocation

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setPhysicalLocation(String physicalLocation)

getPhysicalLocation

public String getPhysicalLocation()

setTransportProtocol

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setTransportProtocol(ExtendedTransportProtocol transportProtocol)

getTransportProtocol

public ExtendedTransportProtocol getTransportProtocol()

setUseCustomUserNamePassword

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

setAccessDeviceCredentials

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)

getAccessDeviceCredentials

public DeviceManagementUserNamePassword16 getAccessDeviceCredentials()

setDeviceIPEI

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest setDeviceIPEI(String deviceIPEI)

getDeviceIPEI

public String getDeviceIPEI()

getEmptyObject

public static ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest 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>