Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice

java.lang.Object

co.ecg.alpaca.toolkit.model.BroadWorksObject

co.ecg.alpaca.toolkit.generated.AccessDevice

co.ecg.alpaca.toolkit.generated.SystemAccessDevice

All Implemented Interfaces:

Serializable

public class SystemAccessDevice
extends AccessDevice

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemAccessDevice.SystemAccessDeviceAddRequest	Request to add a system-level access device.
static class	SystemAccessDevice.SystemAccessDeviceCustomTagAddOrModifyListRequest	Request to add or modify a list of static configuration tag for a system access device.
static class	SystemAccessDevice.SystemAccessDeviceCustomTagAddRequest	Request to add a static configuration tag for a system access device.
static class	SystemAccessDevice.SystemAccessDeviceCustomTagDeleteListRequest	Request to delete static configuration tags for a system access device.
static class	SystemAccessDevice.SystemAccessDeviceCustomTagGetListRequest	Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis.
static class	SystemAccessDevice.SystemAccessDeviceCustomTagGetListResponse	Response to SystemAccessDeviceCustomTagGetListRequest.
static class	SystemAccessDevice.SystemAccessDeviceCustomTagModifyRequest	Request to modify a static configuration tag for a system access device.
static class	SystemAccessDevice.SystemAccessDeviceDeleteRequest	Request to delete a specified system access device.
static class	SystemAccessDevice.SystemAccessDeviceDeviceActivationGetRequest	Requests the activation information for a device configured at System level.
static class	SystemAccessDevice.SystemAccessDeviceDeviceActivationGetResponse	Response to SystemAccessDeviceDeviceActivationGetRequest.
static class	SystemAccessDevice.SystemAccessDeviceDeviceActivationModifyRequest	Activates or deactivates a device configured at the System level.
static class	SystemAccessDevice.SystemAccessDeviceFileGetListRequest	Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
static class	SystemAccessDevice.SystemAccessDeviceFileGetListResponse	Response to SystemAccessDeviceFileGetListRequest14sp8.
static class	SystemAccessDevice.SystemAccessDeviceFileGetRequest	Request to get a device profile file.
static class	SystemAccessDevice.SystemAccessDeviceFileGetResponse	Response to SystemAccessDeviceFileGetRequest20.
static class	SystemAccessDevice.SystemAccessDeviceFileModifyRequest	Request to modify a specified system access device file.
static class	SystemAccessDevice.SystemAccessDeviceGenerateActivationCodeRequest	Requests a new activation code for a device configured at the System level.
static class	SystemAccessDevice.SystemAccessDeviceGetAllRequest	Requests the list of all access devices in the entire system.
static class	SystemAccessDevice.SystemAccessDeviceGetAllResponse	Response to SystemAccessDeviceGetAllRequest.
static class	SystemAccessDevice.SystemAccessDeviceGetAvailableCustomTagListRequest	Get the list of all available custom tags managed by the Device Management System, on a per-device profile basis.
static class	SystemAccessDevice.SystemAccessDeviceGetAvailableCustomTagListResponse	Response to SystemAccessDeviceGetAvailableCustomTagListRequest.
static class	SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest	Requests the list of linked leaf devices for the system level tree device passed in the request.
static class	SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListResponse	Response to SystemAccessDeviceGetLinkedLeafDeviceListRequest.
static class	SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceRequest	Requests the tree device linked with the system level leaf device passed in the request.
static class	SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceResponse	Response to SystemAccessDeviceGetLinkedTreeDeviceRequest.
static class	SystemAccessDevice.SystemAccessDeviceGetListRequest	Requests the list of access devices defined at the System-level.
static class	SystemAccessDevice.SystemAccessDeviceGetListResponse	Response to SystemAccessDeviceGetListRequest14.
static class	SystemAccessDevice.SystemAccessDeviceGetNativeTagsWithLogicListRequest	Get the list of all native tags with logic managed by the Device Management System, on a per-device profile basis.
static class	SystemAccessDevice.SystemAccessDeviceGetNativeTagsWithLogicListResponse	Response to SystemAccessDeviceGetNativeTagsWithLogicListRequest.
static class	SystemAccessDevice.SystemAccessDeviceGetPagedSortedListRequest	Requests the list of system-level access devices.
static class	SystemAccessDevice.SystemAccessDeviceGetPagedSortedListResponse	Response to SystemAccessDeviceGetPagedSortedListRequest.
static class	SystemAccessDevice.SystemAccessDeviceGetRequest	Requests the configuration of a specified system access device.
static class	SystemAccessDevice.SystemAccessDeviceGetResponse	Response to SystemAccessDeviceGetRequest24 The following elements are only used in AS data mode: version deviceName deviceExternalId The following elements are only used in AS data mode and not returned in XS data mode: isWebexTeamsDevice defaultPathHeader
static class	SystemAccessDevice.SystemAccessDeviceGetUserListRequest	Requests the users associated with a specified system access device.
static class	SystemAccessDevice.SystemAccessDeviceGetUserListResponse	Response to SystemAccessDeviceGetUserListRequest21sp1.
static class	SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest	Request to link one or more leaf devices to a system level tree device.
static class	SystemAccessDevice.SystemAccessDeviceModifyRequest	Request to modify a specified system access device.
static class	SystemAccessDevice.SystemAccessDeviceModifyUserRequest	Request to modify attributes for line/ports assigned on the system device profile.
static class	SystemAccessDevice.SystemAccessDeviceMonitorAddDeviceTypeRequest	Add a device type to be monitored.
static class	SystemAccessDevice.SystemAccessDeviceMonitorDeleteDeviceTypeRequest	Remove a device type to be monitored.
static class	SystemAccessDevice.SystemAccessDeviceMonitorGetDeviceTypeListRequest	Get a list of monitored device types.
static class	SystemAccessDevice.SystemAccessDeviceMonitorGetDeviceTypeListResponse	Response to SystemAccessDeviceMonitorGetDeviceTypeListRequest.
static class	SystemAccessDevice.SystemAccessDeviceMonitorParametersGetRequest	Request to get the list of Access Device Monitor system parameters.
static class	SystemAccessDevice.SystemAccessDeviceMonitorParametersGetResponse	Response to SystemAccessDeviceMonitorParametersGetListRequest.
static class	SystemAccessDevice.SystemAccessDeviceMonitorParametersModifyRequest	Request to modify Access Device Monitor system parameters.
static class	SystemAccessDevice.SystemAccessDeviceResetRequest	Reset a specific system SIP device that supports the reset operation.
static class	SystemAccessDevice.SystemAccessDeviceTagSetGetRequest	Request to get the custom configuration tag set defined at the access device.
static class	SystemAccessDevice.SystemAccessDeviceTagSetGetResponse	Response to SystemAccessDeviceTagSetGetRequest.
static class	SystemAccessDevice.SystemAccessDeviceTagSetModifyRequest	Request to modify a static configuration tag set.
static class	SystemAccessDevice.SystemAccessDeviceTypeGetEnhancedConfigurableListRequest	Requests the list of device types supporting enhanced configuration.
static class	SystemAccessDevice.SystemAccessDeviceTypeGetEnhancedConfigurableListResponse	Response to SystemAccessDeviceTypeGetEnhancedConfigurableListRequest.
static class	SystemAccessDevice.SystemAccessDeviceTypeGetListRequest	Requests the list of access device types.
static class	SystemAccessDevice.SystemAccessDeviceTypeGetListResponse	Response to SystemAccessDeviceTypeGetListRequest.
static class	SystemAccessDevice.SystemAccessDeviceUnlinkDeviceListRequest	Request to unlink one or more leaf access devices from a tree device.
static class	SystemAccessDevice.SystemTemplateOnlyDeviceFileGetListRequest	Request to get the list of template files used to support a VDM device defined at system level.
static class	SystemAccessDevice.SystemTemplateOnlyDeviceFileGetListResponse	Response to SystemTemplateOnlyDeviceFileGetListRequest.
static class	SystemAccessDevice.SystemVisualDeviceManagementGetDeviceInfoRequest	Get the information for a specified device supporting visual device management.
static class	SystemAccessDevice.SystemVisualDeviceManagementGetDeviceInfoResponse	Response to SystemVisualDeviceManagementGetDeviceInfoRequest.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	defaultPathHeader
protected String	description
protected String	deviceExternalId
protected String	deviceType
protected Boolean	isWebexTeamsDevice
protected String	macAddress
protected String	netAddress
protected Integer	numberOfAssignedPorts
protected UnboundedPositiveInt	numberOfPorts
protected String	outboundProxyServerNetAddress
protected String	physicalLocation
protected Integer	port
protected String	protocol
protected String	serialNumber
protected AccessDeviceStatus	status
protected String	stunServerNetAddress
protected ExtendedTransportProtocol	transportProtocol
protected Boolean	useCustomUserNamePassword
protected String	userName
protected String	version

Fields inherited from class co.ecg.alpaca.toolkit.generated.AccessDevice

deviceLevel, deviceName

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

broadWorksServer, populated

Constructor Summary

Constructors

Constructor	Description
SystemAccessDevice()	Serializable Constructor
SystemAccessDevice(BroadWorksServer broadWorksServer, String deviceName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getClassName()
String	getDefaultPathHeader()
String	getDescription()
String	getDeviceExternalId()
String	getDeviceType()
Boolean	getIsWebexTeamsDevice()
String	getMacAddress()
String	getNetAddress()
Integer	getNumberOfAssignedPorts()
UnboundedPositiveInt	getNumberOfPorts()
String	getOutboundProxyServerNetAddress()
String	getPhysicalLocation()
static SystemAccessDevice	getPopulatedSystemAccessDevice(BroadWorksServer broadWorksServer, String deviceName)	Retrieves a populated SystemAccessDevice
Integer	getPort()
String	getProtocol()
String	getSerialNumber()
AccessDeviceStatus	getStatus()
String	getStunServerNetAddress()
ExtendedTransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
String	getUserName()
String	getVersion()
int	hashCode()
Response	populate()	Method to populate the Fields of the Object via the Associated BroadWorks request
Response	populate(SystemAccessDevice.SystemAccessDeviceGetResponse resp)	Method to populate the Fields of the Object via the Associated BroadWorks request
SystemAccessDevice	setDefaultPathHeader(String defaultPathHeader)
SystemAccessDevice	setDescription(String description)
SystemAccessDevice	setDeviceExternalId(String deviceExternalId)
SystemAccessDevice	setDeviceType(String deviceType)
SystemAccessDevice	setIsWebexTeamsDevice(Boolean isWebexTeamsDevice)
SystemAccessDevice	setMacAddress(String macAddress)
SystemAccessDevice	setNetAddress(String netAddress)
SystemAccessDevice	setNumberOfAssignedPorts(Integer numberOfAssignedPorts)
SystemAccessDevice	setNumberOfPorts(UnboundedPositiveInt numberOfPorts)
SystemAccessDevice	setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)
SystemAccessDevice	setPhysicalLocation(String physicalLocation)
SystemAccessDevice	setPort(Integer port)
SystemAccessDevice	setProtocol(String protocol)
SystemAccessDevice	setSerialNumber(String serialNumber)
SystemAccessDevice	setStatus(AccessDeviceStatus status)
SystemAccessDevice	setStunServerNetAddress(String stunServerNetAddress)
SystemAccessDevice	setTransportProtocol(ExtendedTransportProtocol transportProtocol)
SystemAccessDevice	setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)
SystemAccessDevice	setUserName(String userName)
SystemAccessDevice	setVersion(String version)
String	toString()

Methods inherited from class co.ecg.alpaca.toolkit.generated.AccessDevice

formRequest, getArrayFromNode, getArrayFromNode, getDeviceLevel, getDeviceName, getFromNode, setDeviceLevel, setDeviceName

Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

getBroadWorksServer, hasPopulated, isPopulated, setBroadWorksServer, setPopulated

Methods inherited from class java.lang.Object

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

Field Details

deviceType

protected String deviceType

protocol

protected String protocol

netAddress

protected String netAddress

port

protected Integer port

outboundProxyServerNetAddress

protected String outboundProxyServerNetAddress

stunServerNetAddress

protected String stunServerNetAddress

macAddress

protected String macAddress

serialNumber

protected String serialNumber

description

protected String description

numberOfPorts

protected UnboundedPositiveInt numberOfPorts

numberOfAssignedPorts

protected Integer numberOfAssignedPorts

status

protected AccessDeviceStatus status

physicalLocation

protected String physicalLocation

transportProtocol

protected ExtendedTransportProtocol transportProtocol

useCustomUserNamePassword

protected Boolean useCustomUserNamePassword

userName

protected String userName

version

protected String version

isWebexTeamsDevice

protected Boolean isWebexTeamsDevice

defaultPathHeader

protected String defaultPathHeader

deviceExternalId

protected String deviceExternalId

Constructor Details

SystemAccessDevice

public SystemAccessDevice()

Serializable Constructor

SystemAccessDevice

public SystemAccessDevice(BroadWorksServer broadWorksServer,
 String deviceName)

Parameters:

broadWorksServer -

deviceName -

Method Details

getPopulatedSystemAccessDevice

public static SystemAccessDevice getPopulatedSystemAccessDevice(BroadWorksServer broadWorksServer,
 String deviceName)
                                                         throws BroadWorksObjectException

Retrieves a populated SystemAccessDevice

Parameters:

broadWorksServer -

deviceName -

Throws:

BroadWorksObjectException

getClassName

public String getClassName()

Overrides:

getClassName in class AccessDevice

setDeviceType

public SystemAccessDevice setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setProtocol

public SystemAccessDevice setProtocol(String protocol)

getProtocol

public String getProtocol()

setNetAddress

public SystemAccessDevice setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public SystemAccessDevice setPort(Integer port)

getPort

public Integer getPort()

setOutboundProxyServerNetAddress

public SystemAccessDevice setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)

getOutboundProxyServerNetAddress

public String getOutboundProxyServerNetAddress()

setStunServerNetAddress

public SystemAccessDevice setStunServerNetAddress(String stunServerNetAddress)

getStunServerNetAddress

public String getStunServerNetAddress()

setMacAddress

public SystemAccessDevice setMacAddress(String macAddress)

getMacAddress

public String getMacAddress()

setSerialNumber

public SystemAccessDevice setSerialNumber(String serialNumber)

getSerialNumber

public String getSerialNumber()

setDescription

public SystemAccessDevice setDescription(String description)

getDescription

public String getDescription()

setNumberOfPorts

public SystemAccessDevice setNumberOfPorts(UnboundedPositiveInt numberOfPorts)

getNumberOfPorts

public UnboundedPositiveInt getNumberOfPorts()

setNumberOfAssignedPorts

public SystemAccessDevice setNumberOfAssignedPorts(Integer numberOfAssignedPorts)

getNumberOfAssignedPorts

public Integer getNumberOfAssignedPorts()

setStatus

public SystemAccessDevice setStatus(AccessDeviceStatus status)

getStatus

public AccessDeviceStatus getStatus()

setPhysicalLocation

public SystemAccessDevice setPhysicalLocation(String physicalLocation)

getPhysicalLocation

public String getPhysicalLocation()

setTransportProtocol

public SystemAccessDevice setTransportProtocol(ExtendedTransportProtocol transportProtocol)

getTransportProtocol

public ExtendedTransportProtocol getTransportProtocol()

setUseCustomUserNamePassword

public SystemAccessDevice setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

setUserName

public SystemAccessDevice setUserName(String userName)

getUserName

public String getUserName()

setVersion

public SystemAccessDevice setVersion(String version)

getVersion

public String getVersion()

setIsWebexTeamsDevice

public SystemAccessDevice setIsWebexTeamsDevice(Boolean isWebexTeamsDevice)

getIsWebexTeamsDevice

public Boolean getIsWebexTeamsDevice()

setDefaultPathHeader

public SystemAccessDevice setDefaultPathHeader(String defaultPathHeader)

getDefaultPathHeader

public String getDefaultPathHeader()

setDeviceExternalId

public SystemAccessDevice setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

populate

public Response populate()

Method to populate the Fields of the Object via the Associated BroadWorks request

Overrides:

populate in class AccessDevice

populate

public Response populate(SystemAccessDevice.SystemAccessDeviceGetResponse resp)

Method to populate the Fields of the Object via the Associated BroadWorks request

Parameters:

resp - The response object to perform population

equals

public boolean equals(Object obj)

Overrides:

equals in class AccessDevice

hashCode

public int hashCode()

Overrides:

hashCode in class AccessDevice

toString

public String toString()

Overrides:

toString in class AccessDevice