Using VigorACS Web Service API - Draytek

2008, September, Using VigorACS Web Service API-1.0 

Using VigorACS Web Service API 

Version 1.0 

1


Summary 

This application note describes the VigorACS Web Service API and how to use it. This document 

applies for VigorACS 0.0.1.0 or later. 

References 

• VigorACS User Guide. 

• VigorACS Quick Start Guide. 

• TR-069 specification. 

• TR-104 specification. 

Revision History 

Issue Date Description 

1 September 30, 2008 Initial release for VigorACS 

0.0.1.0 or later, by Boham Liu. 

2


Table of Content 

1. Introduction .................................................................................................................................... 4 

2. Web Service API ............................................................................................................................. 4 

2.1 Packages ................................................................................................................................ 4 

2.2 Examples ............................................................................................................................... 4 

2.2.1 Network management ............................................................................................... 4 

2.2.1.1 Get network information ............................................................................... 5 

2.2.1.2 Change network configuration ..................................................................... 6 

2.2.2 Devices management ................................................................................................. 8 

2.2.2.1 Get devices count ............................................................................................ 8 

2.2.2.2 Get devices information ................................................................................. 9 

2.2.2.3 Enable Device ............................................................................................... 11 

2.2.3 CPE parameters management ............................................................................... 12 

2.2.3.1 Get RPC methods ......................................................................................... 12 

2.2.3.2 Get CPE parameter names .......................................................................... 13 

2.2.3.3 Get CPE parameter values .......................................................................... 15 

2.2.3.4 Get CPE parameter attributes .................................................................... 16 

2.2.3.5 Set CPE parameter values ........................................................................... 18 

2.2.3.6 Set CPE parameter attributes ..................................................................... 20 

2.2.3.7 addObject (Parameters or other objects defined with multiple instances) 

.................................................................................................................................... 22 

2.2.3.8 deleteObject (Parameters or other objects defined with multiple 

instances) ................................................................................................................... 23 

2.2.4 Provision management ........................................................................................... 26 

2.2.5 Reboot the CPE ....................................................................................................... 29 

3


1. Introduction 

For companies want to integrate their current systems with VigorACS, VigorACS provides 

web service API for this requirement. Users are able to access information or management devices 

through the web service API. This function is convenient and flexible for the companies that wish to 

keep their current systems unchanged and integrate with VigorACS. 

2. Web Service API 

The web service API supports many functions, ex. management of network, retrieving 

parameters, getting RPC methods from CPES, uploading or downloading files, setting parameters 

and attributes...etc. 

2.1 Packages 

There are 3 packages of web service API: obj, property and web services. The obj package 

includes object class that defined and manipulate in web service. The property package includes 

WebServiceProperty class that defined static variables used in web service. The web services 

include services classes that defined various web services. 

2.2 Examples 

To access VigorACS web service, you have to know the information below 1 : 

• Web service URL: 

http://[IP Address of VigorACS]:8080/ACSWebServices/services/ACSWebServices 2 

• User name: The user name used for log in VigorACS. 

• User password: The password used for log in VigorACS. 

2.2.1 Network management 

From this section, VigorACS web service demo codes would be displayed and API would be 

listed with descriptions. 

VigorACS web service API provides network management functions, including get current 

network information, change devices to different networks. 

1 You must know serial number of the device you want to manage, too. 

2 The IP Address is IPv4 IP, as a.b.c.d format, for example: 192.168.1.1 

4


1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

41 

42 

43 

44 

2.2.1.1 Get network information 

An example of getting network information is as below: 

public void getNetworks(String url) throws Exception { 

System.out.println("**************************"); 

System.out.println("into getNetworks..."); 

tw.com.draytek.acs.webservicse.execute.ACSWebServicesSoapBindingStub 

binding; 

try { 

binding = (tw.com.draytek.acs.webservicse.execute. 

ACSWebServicesSoapBindingStub) 

new tw.com.draytek.acs.webservicse.execute. 

ACSWebServicesServiceLocator().getACSWebServices(new java. 

net.URL(url)); 

} catch (javax.xml.rpc.ServiceException jre) { 

if (jre.getLinkedCause() != null) { 

jre.getLinkedCause().printStackTrace(); 

} 

throw new junit.framework.AssertionFailedError( 

"JAX-RPC ServiceException caught: " + jre); 

} 

try { 

// Time out after a minute 

binding.setTimeout(60000); 

// Test operation 

GetNetworksObj getNetworksObj = new GetNetworksObj(); 

getNetworksObj.setUsername(username); 

getNetworksObj.setPassword(password); 

tw.com.draytek.acs.obj.NetworkList networkList = null; 

networkList = binding.getNetworks(getNetworksObj); 

tw.com.draytek.acs.obj.Network networks[] = networkList. 

getNetworkList(); 

for (int i = 0; i < networks.length; i++) { 

networks[i].getId(); 

networks[i].getName(); 

System.out.println("i=" + i + ",id=" + 

networks[i].getId() + ",name=" + 

networks[i].getName() + ",parentId=" + 

networks[i].getParent_id()); 

} 

} catch (Exception e) { 

e.printStackTrace(); 

} 

5


As mentioned above, you need information of web service URL, user name and user password of 

VigorACS to use the web service. The API class used in this sample described as following: 

API Class and method 

tw.com.draytek.acs.webservicse.execute.A 

CSWebServicesSoapBindingStub 

Description 

Build a Stub binding to client(line4) 


CSWebServicesServiceLocator 

Locate and get the web service(line9~10) 

GetNetworksObj 

Operations object of getting network 

configurations by input user name and 

password(line25~27) 

Return all network configuration on 

VigorACS, the returned object is 

binding.getNetworks(getNetworksObj) 

tw.com.draytek.acs.obj.NetworkList(line29 

~30) 

tw.com.draytek.acs.obj.Network 

The network object(line31) 

The process of get network information is as following: 

• Build stub binding of web services. 

• Locate and find web services by URL. 

• Define operation, input user name and password of VigorACS. 

• Manipulate network objects to get information. 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

2.2.1.2 Change network configuration 

An example of change network configuration is as below: 

public void changeNetwork(String url) throws Exception { 


System.out.println("into changeNetwork..."); 


binding; 

try { 









} 



} 

6


19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

try { 




ChangeNetworkObj changeNetworkObj = new ChangeNetworkObj(); 

changeNetworkObj.setUsername(username); 

changeNetworkObj.setPassword(password); 

changeNetworkObj.setSerialnumber(serialnumber); 

changeNetworkObj.setNetworkId(2); 

int value; 

value = binding.changeNetwork(changeNetworkObj); 

System.out.println("value=" + value); 



} 

The client stub binding and web service finding process is same as section 2.2.1.1. If you have 

question about that please reference section 2.2.1.1. 

For changing devices or networks to specific network, you should know the serial number of 

this device, the id of the network you want to assign the device. Surely, the user name and user 

password is necessary. 


ChangeNetworkObj 

changeNetworkObj.setSerialnumber(serial 

number) 

changeNetworkObj.setNetworkId(2) 

binding.changeNetwork(changeNetworkO 

bj) 

Description 

Operations object of changing network 

configurations.(line 23) 

Set serial number of the device that you 

want to change its network.(line26) 

Set network id for the device that you want 

to change.(line27) 

This method return value of the changing 

network result, 0 means change 

successfully, -1 means authentication fail, 

and -2 means change fails.(line30) 

7


1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

2.2.2 Devices management 

VigorACS supports device management through web service. Users can get devices 

information, for example, get how many devices are managed by VigorACS, what are those 

devices, or enable specific devices. 

2.2.2.1 Get devices count 

How do you know how many devices are managed by VigorACS through web service? An 

example is as following: 

public void getDeviceCount(String url) throws Exception { 


System.out.println("into GetDeviceCount..."); 


binding; 

try { 









} 



} 

try { 




GetDeviceCountObj getDeviceCountObj = new GetDeviceCountObj(); 

getDeviceCountObj.setUsername(username); 

getDeviceCountObj.setPassword(password); 

//status: 0: all device, 1: admin device, 2: home device 

getDeviceCountObj.setStatus(WebServiceProperty.DEVICE_TYPE_ALL); 

int value; 

value = binding.getDeviceCount(getDeviceCountObj); 




} 

} 

8


The binding and finding web services has discussed in section 2.1.1.1(line4~18). Web service API 

and method is described as following: 


GetDeviceCountObj 

getDeviceCountObj.setStatus(WebServiceP 

roperty.DEVICE_TYPE_ALL) 

binding.getDeviceCount(getDeviceCountO 

bj) 

Description 

Operations object for getting devices 

count.(line25) 

This method get devices count at different 

criteria, the argument is 0 or 1, or 2. Set 

argument to 0 means retrieve all devices 

count, 1 means retrieve devices count 

under admin privilege, 2 means retrieve 

devices count at Table View.(line30) 

This method return value of the getting 

devices count result, 0 means get 

successfully, -1 means authentication fail, 

and -2 means change fails.(line30) 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

2.2.2.2 Get devices information 

How do you know what devices are managed by VigorACS through web service? 

An example is as following. 

public void getDevices(String url) throws Exception { 


System.out.println("into GetDevice..."); 


binding; 

try { 









} 



} 

try { 




9


27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

41 

42 

43 

44 

45 

46 

47 

48 

49 

GetDevicesObj getDevicesObj = new GetDevicesObj(); 

getDevicesObj.setUsername(username); 

getDevicesObj.setPassword(password); 

//status: 0: all device, 1: admin device, 2: home device 

getDevicesObj.setStatus(WebServiceProperty.DEVICE_TYPE_ALL); 

getDevicesObj.setFromIndex(0); 

getDevicesObj.setToIndex(1); 

tw.com.draytek.acs.obj.DeviceList deviceList = null; 

deviceList = binding.getDevices(getDevicesObj); 

tw.com.draytek.acs.obj.Device[] value = deviceList.getDeviceList(); 

for (int i = 0; i < value.length; i++) { 

System.out.println("i=" + i + ",serialnumber=" + 

value[i].getSerialNumber() + ",ip=" + 

value[i].getIp() + ",deviceName=" + 

value[i].getDevice_name()); 

} 



} 

} 

If you have any question about stub binding and web service finding, please reference section 

2.1.1.1. 

Web service API and method is described as following: 


GetDevicesObj 

getDevicesObj.setStatus(WebServicePrope 

rty.DEVICE_TYPE_ALL) 

getDevicesObj.setFromIndex() 

getDevicesObj.setToIndex() 

tw.com.draytek.acs.obj.DeviceList 

binding.getDevices(getDevicesObj) 

tw.com.draytek.acs.obj.Device 

Description 

Operations object for get devices 

information.(line27) 

This method get devices count at different 

criteria, the argument is 0 or 1, or 2. Set 

argument to 0 means retrieve all devices 

information, 1 means retrieve devices 

information under admin privilege, 2 

means retrieve devices information at 

Table View.(line32) 

Devices index that begins. The start index 

is 0. 

Devices index that ends. You should not 

assign a integer greater than devices count- 

1 

A list object of devices. 

This method return the device object list, 

defined as 

tw.com.draytek.acs.obj.DeviceList 

Object of the device information. 

10


1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

2.2.2.3 Enable Device 

The enabled devices would be managed by VigorACS. How to enable devices through web 

service? An example is as following: 

public void enableDevice(String url) throws Exception { 


System.out.println("into EnableDevice..."); 


binding; 

try { 









} 



} 

try { 




EnableDeviceObj enableDeviceObj = new EnableDeviceObj(); 

enableDeviceObj.setUsername(username); 

enableDeviceObj.setPassword(password); 

enableDeviceObj.setSerialnumber(serialnumber); 

//status: 0: disable device, 1: enable device, 2: delete device 

enableDeviceObj.setStatus(WebServiceProperty.DISABLE_DEVICE); 

int value; 

value = binding.enableDevice(enableDeviceObj); 




} 

Web service API and method is described as following. 


EnableDeviceObj 

enableDeviceObj.setSerialnumber(serialnu 

mber) 

Description 

Operations object for enable a device. 

This method set the serial number of the 

device you want to enable to manage. 

11


enableDeviceObj.setStatus(WebServicePro 

perty.DISABLE_DEVICE) 

binding.enableDevice(enableDeviceObj) 

Set the status of the device. There are 3 

status, 0 means disable the device, 1 means 

enable the device and 2 means delete the 

device. 

Return values for the enable device result. 

0 means success,-1 means authentication 

fail and -2 means fail. 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

2.2.3 CPE parameters management 

VigorACS web service API support management of CPE parameters, for example: get all 

RPC methods of TR069 support by the specific CPE, get and set parameter values or parameter 

attributes. 

2.2.3.1 Get RPC methods 

How to know which RPC method is supported by a specific CPE? Knowing those methods 

would useful for TR069 parameters settings. The web service API provides functions to access 

CPEs and retrieve those RPC methods. 

An example is as following: 

public void getRPCMethods(String url) throws Exception { 


System.out.println("into GetRPCMethods..."); 


binding; 

try { 









} 



} 

try { 




GetRPCMethodsObj getRPCMethodsObj = new GetRPCMethodsObj(); 

getRPCMethodsObj.setUsername(username); 

12


27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

getRPCMethodsObj.setPassword(password); 

getRPCMethodsObj.setSerialnumber(serialnumber); 

java.lang.String[] value = null; 

value = binding.getRPCMethods(getRPCMethodsObj); 


System.out.println("i=" + i + ", value=" + value[i]); 

} 



} 

} 

The web service API and method is described as following: 


GetRPCMethodsObj 

getRPCMethodsObj.setSerialnumber(serial 

number) 

binding.getRPCMethods(getRPCMethods 

Obj) 

2.2.3.2 Get CPE parameter names 

13 

Description 

Operations object for getting RPC methods 

of specific CPE. 

This method sets serial numbers of the 

CPE that you want get its RPC methods. 

This method returns an array of String, 

containing RPC method names. 

The web service API allows users to get TR069 parameters and parameter status (writable or 

not writable) of to specific CPE. An example of get CPE parameters is as following: 

public void getParameterNames(String url) throws Exception { 


System.out.println("into GetParameterNames..."); 


binding; 

try { 









} 



} 

try { 


binding.setTimeout(60000);


24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

41 

42 

43 

44 

45 

46 

47 


GetParameterNamesObj getParameterNames = new GetParameterNamesObj(); 

getParameterNames.setUsername(username); 

getParameterNames.setPassword(password); 

getParameterNames.setSerialnumber(serialnumber); 

getParameterNames.setNextLevel(true); 

getParameterNames.setParameterPath( 

"InternetGatewayDevice.LANDeviceNumberOfEntries"); 

tw.com.draytek.acs.obj.ParameterInfoStructList structList = null; 

structList = binding.getParameterNames(getParameterNames); 

tw.com.draytek.acs.obj.ParameterInfoStruct[] value = structList. 

getParameterInfoStructList(); 


System.out.println("i=" + i + ",Name=" + value[i].getName()); 

System.out.println("i=" + i + ",Writable=" + 

value[i].isWritable()); 

} 



} 

} 

The web service API and method described as following: 


GetParameterNamesObj 

getParameterNames.setSerialnumber(serial 

number) 

getParameterNames.setNextLevel(true) 

getParameterNames.setParameterPath("Int 

ernetGatewayDevice.LANDeviceNumber 

OfEntries") 

Description 

Operations object for getting TR069 

parameter names and parameter status from 

a specific CPE. 

Set serial number of the CPE that you want 

to retrieve its parameter names and status. 

The parameter value of this method is true 

or false, or empty. If the parameter value is 

set false, the method returns all parameter 

names that with path start from the given 

parameter path string. If the parameter 

value is set true, the method returns 

parameter names one level below the given 

parameter path string. If the parameter 

value is empty, the method returns all 

accessible parameter names. 

The parameter value is string of TR069 

parameter name and its path. 

14


tw.com.draytek.acs.obj.ParameterInforStru 

ctList 

tw.com.draytek.acs.obj.ParameterInforStru 

ct 

A list of parameters information. 

Containing parameter names and 

information and returned by 


CSWebServicesSoapBindingStub object 

with getParameterNames method 

Object contains parameter name and 

information. 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

2.2.3.3 Get CPE parameter values 

How to get CPE parameter values through VigorACS web service API? An example is as 

following: 

public void getParameterValues(String url) throws Exception { 


System.out.println("into GetParameterValues..."); 


binding; 

try { 









} 



} 

try { 




String parameterNames[] = { 

"InternetGatewayDevice.ManagementServer.PeriodicInformInterval", 

"InternetGatewayDevice.ManagementServer.PeriodicInformEnable"}; 

tw.com.draytek.acs.obj.GetParameterValuesObj getParameterValues = new 

tw.com.draytek.acs.obj.GetParameterValuesObj(); 

getParameterValues.setSerialnumber(serialnumber); 

getParameterValues.setUsername(username); 

getParameterValues.setPassword(password); 

15


34 

35 

36 

37 

38 

39 

40 

41 

42 

43 

44 

45 

46 

47 

48 

49 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

getParameterValues.setParameterNames(parameterNames); 

tw.com.draytek.acs.obj.ParameterValueStructList structList; 

structList = binding.getParameterValues(getParameterValues); 

tw.com.draytek.acs.obj.ParameterValueStruct[] value = structList. 

getParameterValueStructList(); 


System.out.println("i=" + i); 

System.out.println("name=" + value[i].getName()); 

System.out.println("value=" + value[i].getValue()); 

} 



} 

} 



tw.com.draytek.acs.obj.GetParameterValue 

sObj 

getParameterValues.setSerialnumber(serial 

number) 

getParameterValues.setParameterNames(pa 

rameterNames) 

tw.com.draytek.acs.obj.ParameterValueStru 

ctList 

tw.com.draytek.acs.obj.ParameterValueStru 

ct 

2.2.3.4 Get CPE parameter attributes 

Description 

Operations object for getting CPE TR069 

parameter values. 

This method sets serial number of the CPE 

that you want to retrieve its parameter 

values. 

The argument of this method is a string 

array, containing parameter names 

A list of parameter names and values 

information, return by getParameterValues 

method of 



Object contains name and value of each 

requested parameter. 

The web service API allows users get CPE parameter attribute. An example is as following: 

public void getParameterAttributes(String url) throws Exception { 


System.out.println("into GetParameterAttributes..."); 


binding; 

try { 







16

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

41 

42 

43 

44 

45 

46 

47 

48 

49 

50 

51 

52 

53 

54 

} 




} 



} 

try { 




String parameterNames[] = { 

"InternetGatewayDevice.ManagementServer.PeriodicInformInterval", 

"InternetGatewayDevice.ManagementServer.PeriodicInformEnable"}; 

GetParameterAttributesObj getParameterAttributesObj = new 

GetParameterAttributesObj(); 

getParameterAttributesObj.setSerialnumber(serialnumber); 

getParameterAttributesObj.setUsername(username); 

getParameterAttributesObj.setPassword(password); 

getParameterAttributesObj.setParameterNames(parameterNames); 

tw.com.draytek.acs.obj.ParameterAttributeStructList structList; 

structList = binding.getParameterAttributes( 

getParameterAttributesObj); 

tw.com.draytek.acs.obj.ParameterAttributeStruct[] value = 

structList.getParameterAttributeStructList(); 


System.out.println("i=" + i); 

System.out.println("name=" + value[i].getName()); 

System.out.println("Notification=" + value[i].getNotification()); 

String accessList[] = value[i].getAccessList(); 

for (int j = 0; j < accessList.length; j++) { 

System.out.println("j=" + j); 

System.out.println("Notification=" + accessList[j]); 

} 

} 



} 



GetParameterAttributesObj 

Description 

Operations object for getting CPE TR069 

parameter attributes. 

17


getParameterAttributesObj.setSerialnumbe 

r(serial number) 

getParameterAttributesObj.setParameterNa 

mes(parameterNames) 

tw.com.draytek.acs.obj.ParameterAttribute 

StructList 

tw.com.draytek.acs.obj.ParameterAttribute 

Struct 

This method sets serial number of the CPE 

that you want to retrieve its parameter 

attributes. 

The argument of this method is a string 

array, containing parameter names 

A list of parameter names and values 

information, return by 

getParameterAttributes method of 



Object contains name and value of each 

requested parameter attribute. 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

2.2.3.5 Set CPE parameter values 

The web service API allows users to set parameter values to CPEs. An example is as 

following: 

public void setParameterValues(String url) throws Exception { 


System.out.println("into setParametervalues..."); 


binding; 

try { 









} 



} 

try { 




ArrayList requestList = new ArrayList(); 

tw.com.draytek.acs.obj.ParameterValueStruct 

requestParameter; 

requestParameter = new tw.com.draytek.acs.obj. 

ParameterValueStruct(); 

18

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

41 

42 

43 

44 

45 

46 

47 

48 

49 

50 

51 

52 

53 

54 

55 

56 

57 

58 

59 

60 

} 


requestParameter.setName( 

"InternetGatewayDevice.ManagementServer.PeriodicInformInterval"); 

requestParameter.setValue("86488"); 

requestList.add(requestParameter); 


ParameterValueStruct(); 


"InternetGatewayDevice.ManagementServer.PeriodicInformEnable"); 

requestParameter.setValue("true"); 


SetParameterValuesObj setParameterValues = new 

SetParameterValuesObj(); 

setParameterValues.setSerialnumber(serialnumber); 

setParameterValues.setUsername(username); 

setParameterValues.setPassword(password); 

setParameterValues.setParameterKey("WebService Test"); 

setParameterValues.setParameterList((tw.com.draytek.acs.obj. 

ParameterValueStruct[]) 

requestList.toArray(new 

tw.com.draytek.acs.obj.ParameterValueStruct[0])); 

int value; 

value = binding.setParameterValues(setParameterValues); 




} 

For this case, you should assign the value and parameter name in 

tw.com.draytek.acs.obj.ParameterValueStruct class objects, and then set those objects with 

SetParameterValuesObj class objects. The web service API is described as following: 


SetParameterValuesObj 

setParameterValues.setSerialnumber(serial 

number) 

setParameterValues.setParameterKey("") 

setParameterValues.setParameterList() 

Description 

Object for setting CPE parameter values. 

This method set serial number of the CPE 

that you want to set its parameter values. 

The argument of this method is a string. 

The parameter key is set for distinguishing 

the parameters set at different time. Thus 

the argument string should be unique. This 

method allows the argument be an empty 

string and left to the discretion of 

VigorACS. 

The argument of this method is a 

tw.com.draytek.acs.obj. 

ParameterValueStruct object array 

19


binding.setParameterValues() 

(line55) This method returns 0 or 1 to 

indicate the result of setting parameter 

values. 0 means parameter has been set and 

applied with new values. 1 means the 

parameter values has been validated but 

not applied yet. (For example, the 

parameter value changes require CPE 

rebooting to applied) 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

2.2.3.6 Set CPE parameter attributes 

The web service API provides functions to modify parameter attributes, an example is as 

following: 

public void setParameterAttributes(String url) throws Exception { 


System.out.println("into SetParameterAttributes..."); 


binding; 

try { 









} 



} 

try { 




ArrayList requestList = new ArrayList(); 

tw.com.draytek.acs.obj.SetParameterAttributesStruct 

requestParameter; 


SetParameterAttributesStruct(); 

requestParameter.setAccessList(new String[] {"Subscriber"}); 

requestParameter.setAccessListChange(true); 


"InternetGatewayDevice.ManagementServer.PeriodicInformInterval"); 

requestParameter.setNotification(0); 

requestParameter.setNotificationChange(true); 

20

36 

37 

38 

39 

40 

41 

42 

43 

44 

45 

46 

47 

48 

49 

50 

51 

52 

53 

54 

55 

56 

57 

58 

59 

60 

61 

62 

63 

64 

65 

66 

67 

} 




SetParameterAttributesStruct(); 

requestParameter.setAccessList(new String[] {"Subscriber"}); 

requestParameter.setAccessListChange(true); 


"InternetGatewayDevice.ManagementServer.PeriodicInformEnable"); 

requestParameter.setNotification(0); 

requestParameter.setNotificationChange(true); 


SetParameterAttributesObj setParameterAttributesObj = new 

SetParameterAttributesObj(); 

setParameterAttributesObj.setSerialnumber(serialnumber); 

setParameterAttributesObj.setUsername(username); 

setParameterAttributesObj.setPassword(password); 

setParameterAttributesObj.setParameterList((tw.com.draytek.acs.obj. 

SetParameterAttributesStruct[]) 

requestList.toArray(new 

tw.com.draytek.acs.obj. 

SetParameterAttributesStruct[ 

0])); 

int value; 

value = binding.setParameterAttributes(setParameterAttributesObj); 




} 

The web service API is described as following: 


tw.com.draytek.acs.obj.SetParameterAttrib 

utesStruct 

requestParameter.setAccessList(new 

String[] {"Subscriber"}) 

requestParameter.setAccessListChange(tru 

e) 

Description 

Object class for assign parameter 

attributes. Parameter attributes information 

is stored. 

The write access to the specified 

parameters is granted. At present, only 

“Sbuscriber” is defined. 

The argument of the method is Boolean. If 

the argument set true, the value of 

AccessList replaces the current access list 

for this parameter. If false, no change is 

made to the access list. 

21


requestParameter.setNotification(0) 

requestParameter.setNotificationChange(tr 

ue) 

SetParameterAttributesObj 

Indicates whether the CPE will include 

changed values of the specified parameters 

in the inform message. The specified 

parameter value changes when the CPE 

initiate a session. The argument is default 

set to 0 (Notification off), the CPE change 

specified parameters without informing 


The argument is a Boolean. If the argument 

is set true, the value of notification replaces 

the current notification setting for this 

parameter or group of parameters. If false, 

no change is made. 

Operations object for setting parameter 

attributes. 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

2.2.3.7 addObject (Parameters or other objects defined with multiple instances) 

The web service allows users to create a new instance of a multi-instance object – a 

collection of Parameters and/or other objects for which multiple instances are defined. An example 

is as following: 

public void addObject(String url) throws Exception { 


System.out.println("into AddObject..."); 


binding; 

try { 









} 



} 

try { 




String objectName = 

"InternetGatewayDevice.WANDevice.1.WANConnectionDevice."; 

AddObjectObj addObjectObj = new 

22

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

41 

42 

43 

} 


AddObjectObj(); 

addObjectObj.setSerialnumber(serialnumber); 

addObjectObj.setUsername(username); 

addObjectObj.setPassword(password); 

addObjectObj.setParameterKey("WebServiceAddObject"); 

addObjectObj.setObjectName(objectName); 

tw.com.draytek.acs.obj.AddObjectResponse value; 

value = binding.addObject(addObjectObj); 

System.out.println("objectName=" + objectName); 

System.out.println("InstanceNumber=" + value.getInstanceNumber()); 

System.out.println("Status=" + value.getStatus()); 



} 

The web service API and method are as following: 


AddObjectObj 

addObjectObj.setSerialnumber(serialnumb 

er) 

addObjectObj.setParameterKey("WebServi 

ceAddObject") 

addObjectObj.setObjectName(objectName 

) 

value.getStatus() 

Description 

Object for adding new multi-instanced 

object. 


that you want to add new multi-instanced 

objects. 








Set name of the newly added multiinstanced 

object. 

The status indicates result of adding object, 

0Object has been created, 1Object 

creation has been validated and committed, 

but not yet applied (for example, if reboot 

is required). 

2.2.3.8 deleteObject (Parameters or other objects defined with multiple 

instances) 

The web service allows users to delete multi-instance objects – a collection of Parameters 

and/or other objects for which multiple instances are defined. An example is as following: 

1 

public void deleteObject(String url) throws Exception { 

23

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

41 

42 

} 



System.out.println("into DeleteObject..."); 


binding; 

try { 









} 



} 

try { 




String objectName = 

"InternetGatewayDevice.WANDevice.1.WANConnectionDevice.3."; 

DeleteObjectObj deleteObjectObj = new 

DeleteObjectObj(); 

deleteObjectObj.setSerialnumber(serialnumber); 

deleteObjectObj.setUsername(username); 

deleteObjectObj.setPassword(password); 

deleteObjectObj.setParameterKey("WebServiceDeleteObject"); 

deleteObjectObj.setObjectName(objectName); 

int value; 

value = binding.deleteObject(deleteObjectObj); 

System.out.println("objectName=" + objectName); 




} 

24




Description 

DeleteObjectObj 

Object for deleting multi-instanced objects. 


deleteObjectObj.setSerialnumber(serialnu 

that you want to delete multi-instanced 

mber) 

objects. 

deleteObjectObj.setParameterKey("WebSe 

rviceDeleteObject") 

deleteObjectObj.setObjectName(objectNa 

me) 

value 








Set name of the newly added multiinstanced 

object. 

The value indicates result of deleting 

object, 0Object has been deleted, 

1Object deletion has been validated and 

committed, but not yet applied (for 

example, if reboot is required). 

25


2.2.4 Provision management 

VigorACS web service API allows users to download files to specified CPEs, for example: 

firmware upgrade image, web content or vendor configuration file. 


1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

39 

40 

41 

42 

43 

public void download(String url) throws Exception { 


System.out.println("into Download..."); 


binding; 

try { 









} 



} 

try { 




DownloadObj downloadObj = new 

DownloadObj(); 

downloadObj.setSerialnumber(serialnumber); 

downloadObj.setUsername(username); 

downloadObj.setPassword(password); 

downloadObj.setCommandKey("WebServiceDownload"); 

downloadObj.setDelaySeconds(0); 

downloadObj.setDownload_username("acs"); 

downloadObj.setDownload_password("password"); 

downloadObj.setFailureURL("FailureURL"); 

downloadObj.setFileSize(2789432); 

downloadObj.setFileType("1 Firmware Upgrade Image"); 

downloadObj.setSuccessURL("SuccessURL"); 

downloadObj.setTargetFileName("TargerFileName"); 

downloadObj.setURL( 

"http://172.17.3.111:8080/ACSServer/FileServlet?fileName=v2k7v001.all"); 

tw.com.draytek.acs.obj.DownloadResponse value; 

value = binding.download(downloadObj); 

26

44 

45 

46 

47 

48 

49 

50 

} 


System.out.println("CompleteTime=" + value.getCompleteTime()); 

System.out.println("StartTime=" + value.getStartTime()); 

System.out.println("Status=" + value.getStatus()); 



} 

The web service API and method are described as following: 


downloadObj.setURL("http://172.17.3.111: 

8080/ACSServer/FileServlet?fileName=v2 

k7v001.all") 

DownloadObj 

downloadObj.setCommandKey("WebServi 

ceDownload") 

downloadObj.setDelaySeconds(0) 

downloadObj.setDownload_username("acs 

") 

downloadObj.setDownload_password("pas 

sword") 

downloadObj.setFileSize() 

Description 

Specified the source file location. 

Operations object for the download task. 


The string the CPE uses to refer to a 

particular download. The value of the 

CommandKey is entirely at the discretion 

of the ACS and may be an empty string. 

The argument has different meanings for 

Unicast and Multicast downloads. For 

Unicast downloads it is the number of 

second before the CPE will initiate the 

download. For Multicast downloads the 

CPE will initiate the download 

immediately and it is the number of 

seconds available for initiating, performing 

and applying the download. 

This method set user name used by the 

CPE to authenticate with the file server. 

The argument could be empty string if no 

authentication is required. 

This method set password used by the CPE 

to authenticate with the file server. The 

argument could be empty string if no 

authentication is required. 

This method set the size of the file to be 

downloaded in bytes. The argument is 

intended as a hint to the CPE, which the 

CPE may use to determine if it has 

sufficient space for the file to be 

downloaded. If the argument is set to 0, the 

CPE would attempt to proceed with the 

download under the presumption that 

sufficient space is available. 

27


downloadObj.setFileType("1 Firmware 

Upgrade Image") 

downloadObj.setTargetFileName("TargerFi 

leName") 

downloadObj.setSuccessURL("SuccessUR 

L") 

downloadObj.setFailureURL("FailureURL 

") 

tw.com.draytek.acs.obj.DownloadResponse 

The argument is a string defined with the 

following values: 

“1 firmware Upgrade Image” 

“2 Web Content” 

“3 Vendor Configuration File” 

The name of the file to be used on the 

target file system. This argument may be 

left empty if the target file name can be 

extracted from the downloaded file itself or 

from the URL argument. 

The CPE should redirect the user’s browser 

to if the download completes successfully. 

The CPE should redirect the user’s browser 

to if the download not completes 

successfully. 

Object class to instantiate object containing 

the download result information. 

There are 3 field of the object. 

Status indicates the download result, 

returns 0 if download has completed and 

been applied, or returns 1 if download has 

not been completed and applied. (For 

example: the CPE need to reboot to apply 

the changes). 

StartTime: the date and time download 

was started in UTC. 

CompleteTime: the date and time the 

download was fully completed and applied 

in UTC. 

28


1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

18 

19 

20 

21 

22 

23 

24 

25 

26 

27 

28 

29 

30 

31 

32 

33 

34 

35 

36 

37 

38 

2.2.5 Reboot the CPE 

The web service allows users to reboot the CPEs. Some CPEs don’t need to reboot after 

configuration, so this function should not used to reboot after CPE configured. 


public void reboot(String url) throws Exception { 


System.out.println("into Reboot..."); 


binding; 

try { 









} 



} 

try { 




RebootObj rebootObj = new 

RebootObj(); 

rebootObj.setSerialnumber(serialnumber); 

rebootObj.setUsername(username); 

rebootObj.setPassword(password); 

rebootObj.setCommandKey("WebServiceReboot"); 

int value; 

value = binding.reboot(rebootObj); 




} 

} 



RebootObj rebootObj 

Description 

Operations object for rebooting the CPEs. 

29


rebootObj.setSerialnumber(serialnumber) 

rebootObj.setCommandKey("WebServiceR 

eboot") 

binding.reboot(rebootObj) 

Set serial number for the CPE you want to 

reboot. 


The string to return in the CommandKey 

element of the informStruct when the CPE 

reboots and calls the inform method. 

The value of the CommandKey is entirely 

at the discretion of the ACS and MAY be 

an empty string. 

This method returns 0, -1 and -2 as the 

reboot result. 0 means reboot successfully. 

-1 means authenticate fail. -2 means fail. 

30

Using VigorACS Web Service API - Draytek

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?