com.ibm.tivoli.nm.collectors.impl.calixrest

Class CalixRestHandler

java.lang.Object

com.ibm.tivoli.nm.collectors.impl.calixrest.CalixRestHandler

public class CalixRestHandler
extends java.lang.Object

Handler class for making REST API calls to Calix EMS using Java 17 HttpClient

Constructor Summary

Constructors

Constructor and Description
CalixRestHandler(CalixRestPropertyHelper propertyHelper) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	fetchEmsData(java.lang.String fileName, java.lang.String requestUri) Get data from Calix EMS by handling pagination
java.lang.String	fetchEmsData(java.lang.String fileName, java.lang.String requestURI, int offset, int limit) Fetches EMS data for the given URI
java.util.List<CalixBridgeTable>	getAllBridgeTableData(java.lang.String deviceName) Get all Bridge Port for a device from Calix EMS by handling pagination
java.util.List<CalixDevice>	getAllDevices() Get all devices from Calix EMS by handling pagination
java.util.concurrent.CompletableFuture<java.util.List<CalixDevice>>	getAllDevicesAsync() Get all devices from Calix EMS asynchronously by handling pagination
java.util.Map<java.lang.String,java.lang.Object>	getAllEntityData(java.lang.String deviceName) Get shelf, slot, and ONT slot data for a specific device from Calix EMS
java.util.List<CalixLag>	getAllLAGData(java.lang.String deviceName) Get all LAG for a device from Calix EMS by handling pagination
java.util.List<CalixOnt>	getAllOntData() Get all ONT data from Calix EMS by handling pagination
java.util.List<CalixOntPort>	getAllOntPorts(java.lang.String deviceName, java.lang.String ontName) Get all ONT Ports for a device from Calix EMS by handling pagination
java.util.Map<java.lang.String,java.util.List<CalixPort>>	getAllPortData(java.lang.String deviceName, java.util.List<CalixShelf> shelfList) Get all port data for a specific device from Calix EMS
java.util.List<CalixPort>	getAllPorts(java.lang.String deviceName, java.lang.String shelfId, java.lang.String slotId) Get all Ports for a device from Calix EMS by handling pagination
java.util.List<CalixShelf>	getAllShelfs(java.lang.String deviceName) Get all shelfs for a device from Calix EMS by handling pagination
java.util.List<CalixDeviceWithSlots>	getAllSlots(java.lang.String deviceName) Get all slots for a device from Calix EMS by handling pagination
java.util.List<CalixE2WanModule>	getAllWANModules(java.lang.String deviceName) Get all WAN Modules for a device from Calix EMS by handling pagination
java.util.List<CalixBridgeTable>	getBridgeTableData(java.lang.String deviceName, int offset, int limit) Get Bridge Table data for a specific device from Calix EMS
java.util.List<CalixDevice>	getDevices(int offset, int limit) Get devices from Calix EMS
java.util.concurrent.CompletableFuture<java.util.List<CalixDevice>>	getDevicesAsync(int offset, int limit) Get devices asynchronously from Calix EMS
java.util.List<CalixLag>	getLagData(java.lang.String deviceName, int offset, int limit) Get LAG data for a specific device from Calix EMS
java.util.List<CalixOnt>	getOntData(int offset, int limit) Get ONT data from Calix EMS
java.util.List<CalixOntPort>	getOntPortData(java.lang.String deviceName, java.lang.String ontName, int offset, int limit) Get ONT ports data for a specific ONT device for given OLT from Calix EMS
CalixOntSlot	getOntSlotData(java.lang.String deviceName, int offset, int limit) Get ONT slot data for a specific device from Calix EMS
java.util.List<CalixPort>	getPortData(java.lang.String deviceName, java.lang.String shelfId, java.lang.String slotId, int offset, int limit) Get port data for a specific device, shelf, and slot from Calix EMS
java.util.List<CalixShelf>	getShelfData(java.lang.String deviceName, int offset, int limit) Get shelf data for a specific device from Calix EMS
CalixDeviceWithSlots	getSlotData(java.lang.String deviceName, int offset, int limit) Get slot data for a specific device from Calix EMS
java.util.List<CalixE2WanModule>	getWANModuleData(java.lang.String deviceName, int offset, int limit) Get E2 WAN data for a specific device from Calix EMS
boolean	initialise() Method to Initialize this WebSocketTransport instance.
java.lang.String	readDataFromFile(java.lang.String fileName) Reads node data from server

Methods inherited from class java.lang.Object

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

Constructor Detail

CalixRestHandler

public CalixRestHandler(CalixRestPropertyHelper propertyHelper)
                 throws java.lang.Exception

Constructor

Parameters:

propertyHelper - The property helper for accessing configuration

Throws:

java.lang.Exception

Method Detail

initialise

public boolean initialise()
                   throws java.lang.Exception

Method to Initialize this WebSocketTransport instance. Which helpful for sending API call using httpClient object

Returns:

boolean - true, if it successfully initialized else false.

Throws:

java.lang.Exception

getDevices

public java.util.List<CalixDevice> getDevices(int offset,
                                              int limit)

Get devices from Calix EMS

Parameters:

offset - The offset for pagination

limit - The limit for pagination

Returns:

List of CalixDevice object

getDevicesAsync

public java.util.concurrent.CompletableFuture<java.util.List<CalixDevice>> getDevicesAsync(int offset,
                                                                                           int limit)

Get devices asynchronously from Calix EMS

Parameters:

offset - The offset for pagination

limit - The limit for pagination

Returns:

CompletableFuture with List of CalixDevice objects

getAllDevices

public java.util.List<CalixDevice> getAllDevices()

Get all devices from Calix EMS by handling pagination

Returns:

List of all CalixDevice objects

getAllDevicesAsync

public java.util.concurrent.CompletableFuture<java.util.List<CalixDevice>> getAllDevicesAsync()

Get all devices from Calix EMS asynchronously by handling pagination

Returns:

CompletableFuture with List of all CalixDevice objects

getAllShelfs

public java.util.List<CalixShelf> getAllShelfs(java.lang.String deviceName)

Get all shelfs for a device from Calix EMS by handling pagination

Parameters:

deviceName - - name of the device

Returns:

List of all CalixShelf objects

getShelfData

public java.util.List<CalixShelf> getShelfData(java.lang.String deviceName,
                                               int offset,
                                               int limit)

Get shelf data for a specific device from Calix EMS

Parameters:

deviceName - The device name

offset - offset number for the next page

limit - limit for the results

Returns:

List of CalixShelf objects

getAllSlots

public java.util.List<CalixDeviceWithSlots> getAllSlots(java.lang.String deviceName)

Get all slots for a device from Calix EMS by handling pagination

Parameters:

deviceName - - name of the device

Returns:

List of all CalixDeviceWithSlots objects

getSlotData

public CalixDeviceWithSlots getSlotData(java.lang.String deviceName,
                                        int offset,
                                        int limit)

Get slot data for a specific device from Calix EMS

Parameters:

deviceName - The device name

offset - offset number for the next page

limit - limit for the results

Returns:

CalixDeviceWithSlots object

getOntSlotData

public CalixOntSlot getOntSlotData(java.lang.String deviceName,
                                   int offset,
                                   int limit)

Get ONT slot data for a specific device from Calix EMS

Parameters:

deviceName - The device name

offset - offset number for the next page

limit - limit for the results

Returns:

CalixOntSlot object

getAllEntityData

public java.util.Map<java.lang.String,java.lang.Object> getAllEntityData(java.lang.String deviceName)

Get shelf, slot, and ONT slot data for a specific device from Calix EMS

Parameters:

deviceName - The device name

Returns:

Map containing shelf, slot, and ONT slot data

getAllPorts

public java.util.List<CalixPort> getAllPorts(java.lang.String deviceName,
                                             java.lang.String shelfId,
                                             java.lang.String slotId)

Get all Ports for a device from Calix EMS by handling pagination

Parameters:

deviceName - - name of the device

shelfId - - shelfId number

slotId - - slotId Number

Returns:

List of all CalixShelf objects

getAllBridgeTableData

public java.util.List<CalixBridgeTable> getAllBridgeTableData(java.lang.String deviceName)

Get all Bridge Port for a device from Calix EMS by handling pagination

Parameters:

deviceName - - name of the device

Returns:

List of all CalixShelf objects

getAllLAGData

public java.util.List<CalixLag> getAllLAGData(java.lang.String deviceName)

Get all LAG for a device from Calix EMS by handling pagination

Parameters:

deviceName - - name of the device

Returns:

List of all CalixShelf objects

getAllWANModules

public java.util.List<CalixE2WanModule> getAllWANModules(java.lang.String deviceName)

Get all WAN Modules for a device from Calix EMS by handling pagination

Parameters:

deviceName - - name of the device

Returns:

List of all CalixShelf objects

getAllOntPorts

public java.util.List<CalixOntPort> getAllOntPorts(java.lang.String deviceName,
                                                   java.lang.String ontName)

Get all ONT Ports for a device from Calix EMS by handling pagination

Parameters:

deviceName - - name of the device

ontName - - name of the ONT

Returns:

List of all CalixOntPort objects

getPortData

public java.util.List<CalixPort> getPortData(java.lang.String deviceName,
                                             java.lang.String shelfId,
                                             java.lang.String slotId,
                                             int offset,
                                             int limit)

Get port data for a specific device, shelf, and slot from Calix EMS

Parameters:

deviceName - The device name

shelfId - The shelf ID

slotId - The slot ID

offset - offset number for the next page

limit - limit for the results

Returns:

List of CalixPort objects

getBridgeTableData

public java.util.List<CalixBridgeTable> getBridgeTableData(java.lang.String deviceName,
                                                           int offset,
                                                           int limit)

Get Bridge Table data for a specific device from Calix EMS

Parameters:

deviceName - The device name

offset - offset number for the next page

limit - limit for the results

Returns:

List of CalixBridgeTable objects

getLagData

public java.util.List<CalixLag> getLagData(java.lang.String deviceName,
                                           int offset,
                                           int limit)

Get LAG data for a specific device from Calix EMS

Parameters:

deviceName - The device name

offset - offset number for the next page

limit - limit for the results

Returns:

List of CalixLag objects

getWANModuleData

public java.util.List<CalixE2WanModule> getWANModuleData(java.lang.String deviceName,
                                                         int offset,
                                                         int limit)

Get E2 WAN data for a specific device from Calix EMS

Parameters:

deviceName - The device name

offset - offset number for the next page

limit - limit for the results

Returns:

List of CalixE2WanModule objects

getOntPortData

public java.util.List<CalixOntPort> getOntPortData(java.lang.String deviceName,
                                                   java.lang.String ontName,
                                                   int offset,
                                                   int limit)

Get ONT ports data for a specific ONT device for given OLT from Calix EMS

Parameters:

deviceName - The device name

ontName - for a given ONT

offset - offset number for the next page

limit - limit for the results

Returns:

List of CalixOntPort objects

getAllPortData

public java.util.Map<java.lang.String,java.util.List<CalixPort>> getAllPortData(java.lang.String deviceName,
                                                                                java.util.List<CalixShelf> shelfList)

Get all port data for a specific device from Calix EMS

Parameters:

deviceName - The device name

shelfList - list of shelfs for which ports need to fetch

Returns:

Map containing port data for each shelf/slot combination

getOntData

public java.util.List<CalixOnt> getOntData(int offset,
                                           int limit)

Get ONT data from Calix EMS

Parameters:

offset - The offset for pagination

limit - The limit for pagination

Returns:

List of CalixOnt objects

getAllOntData

public java.util.List<CalixOnt> getAllOntData()

Get all ONT data from Calix EMS by handling pagination

Returns:

List of all CalixOnt objects

fetchEmsData

public java.lang.String fetchEmsData(java.lang.String fileName,
                                     java.lang.String requestUri)

Get data from Calix EMS by handling pagination

Returns:

String API response as Json String

fetchEmsData

public java.lang.String fetchEmsData(java.lang.String fileName,
                                     java.lang.String requestURI,
                                     int offset,
                                     int limit)

Fetches EMS data for the given URI

Parameters:

fileName -

requestURI -

offset -

limit -

Returns:

Json response String

readDataFromFile

public java.lang.String readDataFromFile(java.lang.String fileName)

Reads node data from server