Package co.ecg.alpaca.toolkit.generated

Class ServiceProviderAccessDevice

java.lang.Object

co.ecg.alpaca.toolkit.model.BroadWorksObject

co.ecg.alpaca.toolkit.generated.AccessDevice

co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice

All Implemented Interfaces:

Serializable

public class ServiceProviderAccessDevice
extends AccessDevice

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest	Request to add a service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceCustomTagAddOrModifyListRequest	Request to add or modify a list of static configuration tag for a service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceCustomTagAddRequest	Request to add a static configuration tag for a service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceCustomTagDeleteListRequest	Request to delete static configuration tags for a service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceCustomTagGetListRequest	Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceCustomTagGetListResponse	Response to ServiceProviderAccessDeviceCustomTagGetListRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceCustomTagModifyRequest	Request to modify a static configuration tag for a service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceDeleteRequest	Request to delete a specified service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceDeviceActivationGetRequest	Requests the activation information for a device configured at the Service Provider level.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceDeviceActivationGetResponse	Response to ServiceProviderAccessDeviceDeviceActivationGetRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceDeviceActivationModifyRequest	Activates or deactivates a device configured at the Service Provider level.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileGetListRequest	Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileGetListResponse	Response to ServiceProviderAccessDeviceFileGetListRequest14sp8.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileGetRequest	Request to get a service provider device profile file.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileGetResponse	Response to ServiceProviderAccessDeviceFileGetRequest21.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileModifyRequest	Request to modify a specified service provider/enterprise access device file.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGenerateActivationCodeRequest	Requests a new activation code for a device configured at the Service Provider level.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetAvailableCustomTagListRequest	Get the list of all available custom tags managed by the Device Management System, on a per-device profile basis.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetAvailableCustomTagListResponse	Response to ServiceProviderAccessDeviceGetAvailableCustomTagListRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetEnhancedConfigurationTypeListRequest	Requests the list of configurable device types of devices that have already been added to the service provider.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetEnhancedConfigurationTypeListResponse	Response to ServiceProviderAccessDeviceGetEnhancedConfigurationTypeListRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetEnhancedConfigurationTypeRequest	Requests the details of a specified configurable device type for a service provider.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetEnhancedConfigurationTypeResponse	Response to ServiceProviderAccessDeviceGetEnhancedConfigurationTypeRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetLinkedLeafDeviceListRequest	Requests the list of linked leaf devices for the service provider level tree device passed in the request.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetLinkedLeafDeviceListResponse	Response to ServiceProviderAccessDeviceGetLinkedLeafDeviceListRequest22.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetLinkedTreeDeviceRequest	Requests the tree device linked with the service provider level leaf device passed in the request.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetLinkedTreeDeviceResponse	Response to ServiceProviderAccessDeviceGetLinkedTreeDeviceRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	Requests the list of access devices in a service provider.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListResponse	Response to ServiceProviderAccessDeviceGetListRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetNativeTagsWithLogicListRequest	Get the list of all native tags with logic managed by the Device Management System, on a per-device profile basis.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetNativeTagsWithLogicListResponse	Response to ServiceProviderAccessDeviceGetNativeTagsWithLogicListRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetPagedSortedListRequest	Requests the list of service provider level access devices.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetPagedSortedListResponse	Response to ServiceProviderAccessDeviceGetPagedSortedListRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetRequest	Requests the configuration of a specified service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetResponse	Response to ServiceProviderAccessDeviceGetRequest24V3.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetTrunkGroupListRequest	Request to get the list of trunk group names associated with the Access Device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetTrunkGroupListResponse	Response to ServiceProviderAccessDeviceGetTrunkGroupListRequest24.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	Requests the list of users on a specified device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListResponse	Response to ServiceProviderAccessDeviceGetUserListRequest21sp1.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceLinkDeviceListRequest	Request to link one or more leaf devices to a service provider level tree device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest	Request to modify a specified service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyUserRequest	Request to modify attributes for line/ports assigned on the service provider device profile.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceResetRequest	Reset a specific service provider SIP device that supports the reset operation.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceTagSetGetRequest	Request to get the custom configuration tag set defined at the access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceTagSetGetResponse	Response to ServiceProviderAccessDeviceTagSetGetRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceTagSetModifyRequest	Request to modify a static configuration tag set.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceUnlinkDeviceListRequest	Request to unlink one or more leaf access devices from a tree device.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	authBearerSubject
protected String	description
protected String	deviceCode
protected String	deviceExternalId
protected Integer	deviceIndex
protected String	deviceIPEI
protected String	deviceType
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 String	serviceProviderId
protected AccessDeviceStatus	status
protected String	stunServerNetAddress
protected ExtendedTransportProtocol	transportProtocol
protected Boolean	useCustomUserNamePassword
protected Boolean	useDeviceCode
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
ServiceProviderAccessDevice()	Serializable Constructor
ServiceProviderAccessDevice(ServiceProvider serviceProvider, String deviceName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAuthBearerSubject()
String	getClassName()
String	getDescription()
String	getDeviceCode()
String	getDeviceExternalId()
Integer	getDeviceIndex()
String	getDeviceIPEI()
String	getDeviceType()
String	getMacAddress()
String	getNetAddress()
Integer	getNumberOfAssignedPorts()
UnboundedPositiveInt	getNumberOfPorts()
String	getOutboundProxyServerNetAddress()
String	getPhysicalLocation()
static ServiceProviderAccessDevice	getPopulatedServiceProviderAccessDevice(ServiceProvider serviceProvider, String deviceName)	Retrieves a populated ServiceProviderAccessDevice
Integer	getPort()
String	getProtocol()
String	getSerialNumber()
ServiceProvider	getServiceProvider()	Returns a handle on the User's Service Provider
String	getServiceProviderId()
AccessDeviceStatus	getStatus()
String	getStunServerNetAddress()
ExtendedTransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
Boolean	getUseDeviceCode()
String	getUserName()
String	getVersion()
int	hashCode()
Response	populate()	Method to populate the Fields of the Object via the Associated BroadWorks request
Response	populate(ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetResponse resp)	Method to populate the Fields of the Object via the Associated BroadWorks request
ServiceProviderAccessDevice	setAuthBearerSubject(String authBearerSubject)
ServiceProviderAccessDevice	setDescription(String description)
ServiceProviderAccessDevice	setDeviceCode(String deviceCode)
ServiceProviderAccessDevice	setDeviceExternalId(String deviceExternalId)
ServiceProviderAccessDevice	setDeviceIndex(Integer deviceIndex)
ServiceProviderAccessDevice	setDeviceIPEI(String deviceIPEI)
ServiceProviderAccessDevice	setDeviceType(String deviceType)
ServiceProviderAccessDevice	setMacAddress(String macAddress)
ServiceProviderAccessDevice	setNetAddress(String netAddress)
ServiceProviderAccessDevice	setNumberOfAssignedPorts(Integer numberOfAssignedPorts)
ServiceProviderAccessDevice	setNumberOfPorts(UnboundedPositiveInt numberOfPorts)
ServiceProviderAccessDevice	setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)
ServiceProviderAccessDevice	setPhysicalLocation(String physicalLocation)
ServiceProviderAccessDevice	setPort(Integer port)
ServiceProviderAccessDevice	setProtocol(String protocol)
ServiceProviderAccessDevice	setSerialNumber(String serialNumber)
ServiceProviderAccessDevice	setServiceProvider(ServiceProvider serviceProvider)
ServiceProviderAccessDevice	setServiceProviderId(String serviceProviderId)
ServiceProviderAccessDevice	setStatus(AccessDeviceStatus status)
ServiceProviderAccessDevice	setStunServerNetAddress(String stunServerNetAddress)
ServiceProviderAccessDevice	setTransportProtocol(ExtendedTransportProtocol transportProtocol)
ServiceProviderAccessDevice	setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)
ServiceProviderAccessDevice	setUseDeviceCode(Boolean useDeviceCode)
ServiceProviderAccessDevice	setUserName(String userName)
ServiceProviderAccessDevice	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

serviceProviderId

protected String serviceProviderId

deviceExternalId

protected String deviceExternalId

deviceCode

protected String deviceCode

deviceIPEI

protected String deviceIPEI

deviceIndex

protected Integer deviceIndex

useDeviceCode

protected Boolean useDeviceCode

authBearerSubject

protected String authBearerSubject

Constructor Details

ServiceProviderAccessDevice

public ServiceProviderAccessDevice()

Serializable Constructor

ServiceProviderAccessDevice

public ServiceProviderAccessDevice(ServiceProvider serviceProvider,
 String deviceName)

Parameters:

serviceProvider -

deviceName -

Method Details

setServiceProvider

public ServiceProviderAccessDevice setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

Returns a handle on the User's Service Provider

getPopulatedServiceProviderAccessDevice

public static ServiceProviderAccessDevice getPopulatedServiceProviderAccessDevice(ServiceProvider serviceProvider,
 String deviceName)
                                                                           throws BroadWorksObjectException

Retrieves a populated ServiceProviderAccessDevice

Parameters:

serviceProvider -

deviceName -

Throws:

BroadWorksObjectException

getClassName

public String getClassName()

Overrides:

getClassName in class AccessDevice

setDeviceType

public ServiceProviderAccessDevice setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setProtocol

public ServiceProviderAccessDevice setProtocol(String protocol)

getProtocol

public String getProtocol()

setNetAddress

public ServiceProviderAccessDevice setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public ServiceProviderAccessDevice setPort(Integer port)

getPort

public Integer getPort()

setOutboundProxyServerNetAddress

public ServiceProviderAccessDevice setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)

getOutboundProxyServerNetAddress

public String getOutboundProxyServerNetAddress()

setStunServerNetAddress

public ServiceProviderAccessDevice setStunServerNetAddress(String stunServerNetAddress)

getStunServerNetAddress

public String getStunServerNetAddress()

setMacAddress

public ServiceProviderAccessDevice setMacAddress(String macAddress)

getMacAddress

public String getMacAddress()

setSerialNumber

public ServiceProviderAccessDevice setSerialNumber(String serialNumber)

getSerialNumber

public String getSerialNumber()

setDescription

public ServiceProviderAccessDevice setDescription(String description)

getDescription

public String getDescription()

setNumberOfPorts

public ServiceProviderAccessDevice setNumberOfPorts(UnboundedPositiveInt numberOfPorts)

getNumberOfPorts

public UnboundedPositiveInt getNumberOfPorts()

setNumberOfAssignedPorts

public ServiceProviderAccessDevice setNumberOfAssignedPorts(Integer numberOfAssignedPorts)

getNumberOfAssignedPorts

public Integer getNumberOfAssignedPorts()

setStatus

public ServiceProviderAccessDevice setStatus(AccessDeviceStatus status)

getStatus

public AccessDeviceStatus getStatus()

setPhysicalLocation

public ServiceProviderAccessDevice setPhysicalLocation(String physicalLocation)

getPhysicalLocation

public String getPhysicalLocation()

setTransportProtocol

public ServiceProviderAccessDevice setTransportProtocol(ExtendedTransportProtocol transportProtocol)

getTransportProtocol

public ExtendedTransportProtocol getTransportProtocol()

setUseCustomUserNamePassword

public ServiceProviderAccessDevice setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

setUserName

public ServiceProviderAccessDevice setUserName(String userName)

getUserName

public String getUserName()

setVersion

public ServiceProviderAccessDevice setVersion(String version)

getVersion

public String getVersion()

setServiceProviderId

public ServiceProviderAccessDevice setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setDeviceExternalId

public ServiceProviderAccessDevice setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

setDeviceCode

public ServiceProviderAccessDevice setDeviceCode(String deviceCode)

getDeviceCode

public String getDeviceCode()

setDeviceIPEI

public ServiceProviderAccessDevice setDeviceIPEI(String deviceIPEI)

getDeviceIPEI

public String getDeviceIPEI()

setDeviceIndex

public ServiceProviderAccessDevice setDeviceIndex(Integer deviceIndex)

getDeviceIndex

public Integer getDeviceIndex()

setUseDeviceCode

public ServiceProviderAccessDevice setUseDeviceCode(Boolean useDeviceCode)

getUseDeviceCode

public Boolean getUseDeviceCode()

setAuthBearerSubject

public ServiceProviderAccessDevice setAuthBearerSubject(String authBearerSubject)

getAuthBearerSubject

public String getAuthBearerSubject()

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(ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetResponse 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