co.ecg.alpaca.toolkit.generated

Class ServiceProviderAccessDevice

java.lang.Object

co.ecg.alpaca.toolkit.BroadWorksObject

co.ecg.alpaca.toolkit.generated.AccessDevice

co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice

public class ServiceProviderAccessDevice
extends AccessDevice

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceAddRequest14 Request to add 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.ServiceProviderAccessDeviceFileGetListRequest14sp8 Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileGetListResponse14sp8 Response to ServiceProviderAccessDeviceFileGetListRequest14sp8.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileGetRequest20 Request to get a service provider device profile file.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileGetResponse20 Response to ServiceProviderAccessDeviceFileGetRequest20.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceFileModifyRequest14sp8 Request to modify a specified service provider/enterprise access device file.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest Requests the list of access devices in a service provider.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListResponse Response to ServiceProviderAccessDeviceGetListRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetRequest18sp1 Requests the configuration of a specified service provider access device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetResponse18sp1 Response to ServiceProviderAccessDeviceGetRequest18sp1.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest Requests the list of users on a specified device.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListResponse Response to ServiceProviderAccessDeviceGetUserListRequest.
static class	ServiceProviderAccessDevice.ServiceProviderAccessDeviceModifyRequest14 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.

Field Summary

Fields

Modifier and Type	Field and Description
String	description
String	deviceType
String	macAddress
Integer	mobilityManagerDefaultOriginatingServiceKey
Integer	mobilityManagerDefaultTerminatingServiceKey
String	mobilityManagerProvisioningURL
String	mobilityManagerProvisioningUserName
String	netAddress
Integer	numberOfAssignedPorts
UnboundedPositiveInt	numberOfPorts
String	outboundProxyServerNetAddress
String	physicalLocation
Integer	port
String	protocol
String	serialNumber
AccessDeviceStatus	status
String	stunServerNetAddress
TransportProtocol	transportProtocol
Boolean	useCustomUserNamePassword
String	userName
String	version

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

deviceLevel, deviceName

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

bws, populated

Constructor Summary

Constructors

Constructor and Description
ServiceProviderAccessDevice(ServiceProvider serviceProvider, String deviceName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static ServiceProviderAccessDevice	fromProxy(BroadWorksServer bws, ServiceProviderAccessDeviceProxy proxy) Method to recreate the Object from a proxy version.
String	getDescription()
String	getDeviceType()
String	getMacAddress()
Integer	getMobilityManagerDefaultOriginatingServiceKey()
Integer	getMobilityManagerDefaultTerminatingServiceKey()
String	getMobilityManagerProvisioningURL()
String	getMobilityManagerProvisioningUserName()
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()
ServiceProviderAccessDeviceProxy	getProxy() Method to retrieve the Serializable version of this object
String	getSerialNumber()
ServiceProvider	getServiceProvider() Returns a handle on the User's Service Provider
String	getServiceProviderId()
AccessDeviceStatus	getStatus()
String	getStunServerNetAddress()
TransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
String	getUserName()
String	getVersion()
Response	populate() Method to create and populate the Fields of the Object via the Associated BroadWorks request
void	populate(ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetResponse18sp1 resp) Method to populate the Fields of the Object via the Associated BroadWorks request

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

fromProxy, getDeviceLevel, getDeviceName, getFromNode, getListFromNode, getListFromNode, toString

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

getBroadWorksServer, hasPopulated, setBroadWorksServer

Methods inherited from class java.lang.Object

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

Field Detail

deviceType

public String deviceType

protocol

public String protocol

netAddress

public String netAddress

port

public Integer port

outboundProxyServerNetAddress

public String outboundProxyServerNetAddress

stunServerNetAddress

public String stunServerNetAddress

macAddress

public String macAddress

serialNumber

public String serialNumber

description

public String description

numberOfPorts

public UnboundedPositiveInt numberOfPorts

numberOfAssignedPorts

public Integer numberOfAssignedPorts

status

public AccessDeviceStatus status

physicalLocation

public String physicalLocation

transportProtocol

public TransportProtocol transportProtocol

mobilityManagerProvisioningURL

public String mobilityManagerProvisioningURL

mobilityManagerProvisioningUserName

public String mobilityManagerProvisioningUserName

mobilityManagerDefaultOriginatingServiceKey

public Integer mobilityManagerDefaultOriginatingServiceKey

mobilityManagerDefaultTerminatingServiceKey

public Integer mobilityManagerDefaultTerminatingServiceKey

useCustomUserNamePassword

public Boolean useCustomUserNamePassword

userName

public String userName

version

public String version

Constructor Detail

ServiceProviderAccessDevice

public ServiceProviderAccessDevice(ServiceProvider serviceProvider,
                                   String deviceName)

Parameters:

serviceProvider -

deviceName -

Method Detail

getServiceProviderId

public String getServiceProviderId()

getServiceProvider

public ServiceProvider getServiceProvider()

Returns a handle on the User's Service Provider

getPopulatedServiceProviderAccessDevice

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

Retrieves a populated ServiceProviderAccessDevice

Parameters:

serviceProvider -

deviceName -

Throws:

RequestException

BroadWorksObjectException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getDeviceType

public String getDeviceType()

getProtocol

public String getProtocol()

getNetAddress

public String getNetAddress()

getPort

public Integer getPort()

getOutboundProxyServerNetAddress

public String getOutboundProxyServerNetAddress()

getStunServerNetAddress

public String getStunServerNetAddress()

getMacAddress

public String getMacAddress()

getSerialNumber

public String getSerialNumber()

getDescription

public String getDescription()

getNumberOfPorts

public UnboundedPositiveInt getNumberOfPorts()

getNumberOfAssignedPorts

public Integer getNumberOfAssignedPorts()

getStatus

public AccessDeviceStatus getStatus()

getPhysicalLocation

public String getPhysicalLocation()

getTransportProtocol

public TransportProtocol getTransportProtocol()

getMobilityManagerProvisioningURL

public String getMobilityManagerProvisioningURL()

getMobilityManagerProvisioningUserName

public String getMobilityManagerProvisioningUserName()

getMobilityManagerDefaultOriginatingServiceKey

public Integer getMobilityManagerDefaultOriginatingServiceKey()

getMobilityManagerDefaultTerminatingServiceKey

public Integer getMobilityManagerDefaultTerminatingServiceKey()

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

getUserName

public String getUserName()

getVersion

public String getVersion()

populate

public Response populate()
                  throws RequestException

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

Overrides:

populate in class AccessDevice

Throws:

RequestException

populate

public void populate(ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetResponse18sp1 resp)

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

Parameters:

resp - The response to populate the object

getProxy

public ServiceProviderAccessDeviceProxy getProxy()

Method to retrieve the Serializable version of this object

Overrides:

getProxy in class AccessDevice

Returns:

fromProxy

public static ServiceProviderAccessDevice fromProxy(BroadWorksServer bws,
                                                    ServiceProviderAccessDeviceProxy proxy)

Method to recreate the Object from a proxy version.

Parameters:

bws -

proxy -