* Create new OpenROADM node in all OpenROADM topologies.
*
* @param nodeId
- * unique node ID of new OpenROADM node
+ * unique node ID of new OpenROADM node
* @param nodeVersion
- * OpenROADM node version
+ * OpenROADM node version
*/
void createOpenRoadmNode(String nodeId, String nodeVersion);
* Delete OpenROADM node mapping and topologies.
*
* @param nodeId
- * unique node ID of OpenROADM node.
+ * unique node ID of OpenROADM node.
*
*/
void deleteOpenRoadmnode(String nodeId);
* Set/update connection status of OpenROADM node.
*
* @param nodeId
- * unique node ID of new OpenROADM node
+ * unique node ID of new OpenROADM node
* @param connectionStatus
- * connection status of the node
+ * connection status of the node
*/
void setOpenRoadmNodeStatus(String nodeId, NetconfNodeConnectionStatus.ConnectionStatus connectionStatus);
* create new otn link in otn-topology.
*
* @param nodeA
- * OpenROADM node ID for link termination point A
+ * OpenROADM node ID for link termination point A
* @param tpA
- * OpenROADM tp id on nodeA for link termination point A
+ * OpenROADM tp id on nodeA for link termination point A
* @param nodeZ
- * OpenROADM node ID for link termination point Z
+ * OpenROADM node ID for link termination point Z
* @param tpZ
- * OpenROADM tp id on nodeZ for link termination point Z
+ * OpenROADM tp id on nodeZ for link termination point Z
* @param linkType
- * OtnLinkType, as OTU4, ODTU, etc
+ * OtnLinkType, as OTU4, ODTU, etc
*/
void createOtnLinks(String nodeA, String tpA, String nodeZ, String tpZ, OtnLinkType linkType);
* delete otn links from otn-topology.
*
* @param nodeA
- * OpenROADM node ID for link termination point A
+ * OpenROADM node ID for link termination point A
* @param tpA
- * OpenROADM tp id on nodeA for link termination point A
+ * OpenROADM tp id on nodeA for link termination point A
* @param nodeZ
- * OpenROADM node ID for link termination point Z
+ * OpenROADM node ID for link termination point Z
* @param tpZ
- * OpenROADM tp id on nodeZ for link termination point Z
+ * OpenROADM tp id on nodeZ for link termination point Z
* @param linkType
- * OtnLinkType, as OTU4, ODTU, etc
+ * OtnLinkType, as OTU4, ODTU, etc
*/
void deleteOtnLinks(String nodeA, String tpA, String nodeZ, String tpZ, OtnLinkType linkType);
* update otn links from otn-topology.
*
* @param nodeTps
- * List containing a string composed of the netconf nodeId , and the
+ * List containing a string composed of the netconf nodeId , and the
* termination point supporting the service
* @param serviceRate
- * Service rate may be 1G, 10G or 100G
+ * Service rate may be 1G, 10G or 100G
* @param tribPortNb
- * Trib port number allocated by the service
+ * Trib port number allocated by the service
* @param tribSoltNb
- * First trib slot number allocated by the service
+ * First trib slot number allocated by the service
* @param isDeletion
- * True indicates if the low-order otn service must be deleted
+ * True indicates if the low-order otn service must be deleted
*/
void updateOtnLinks(List<String> nodeTps, String serviceRate, Short tribPortNb, Short tribSoltNb,
boolean isDeletion);
* Remove wavelength from available and add it to used wavelength list.
*
* @param pathDescription
- * path description containing a-to-z and z-to-a path
+ * path description containing a-to-z and z-to-a path
*/
void useWavelengths(PathDescription pathDescription);
* Remove wavelength from used and add it to available wavelength list.
*
* @param pathDescription
- * path description containing a-to-z and z-to-a path
+ * path description containing a-to-z and z-to-a path
*/
void freeWavelengths(PathDescription pathDescription);
* Check if any previously added task requires rollback.
* Rollback is necessary if just single task requires rollback.
* @return
- * true if any of added tasks requires rollback. false if none of added tasks requires rollback.
+ * true if any of added tasks requires rollback. false if none of added tasks requires rollback.
*/
public boolean isRollbackNecessary() {
for (RollbackTask task: this.tasks) {
* It does not matter if any of the tasks requires rollback.
* All previously added tasks will be rolled back and removed from this processor.
* @return
- * number of tasks rolled back
+ * number of tasks rolled back
*/
@SuppressWarnings("checkstyle:IllegalCatch")
public int rollbackAll() {
* Rollback all tasks in case any task has failed.
* If rollback is necessary, all previously added tasks will be rolled back and removed from this processor.
* @return
- * number of tasks rolled back
+ * number of tasks rolled back
*/
public int rollbackAllIfNecessary() {
if (!isRollbackNecessary()) {
* get service by name.
*
* @param serviceName
- * unique name of the service
+ * unique name of the service
* @return Optional of Services
*/
Optional<Services> getService(String serviceName);
* get temp service by common-id.
*
* @param commonId
- * unique common-id of the service
+ * unique common-id of the service
* @return Optional of Services
*/
Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev190531.temp.service.list
* deleteService service by name.
*
* @param serviceName
- * unique name of the service
+ * unique name of the service
* @return result of Delete operation
*/
OperationResult deleteService(String serviceName);
* deleteService service by common-id.
*
* @param commonId
- * unique common-id of the service
+ * unique common-id of the service
* @return result of Delete operation
*/
OperationResult deleteTempService(String commonId);
* modifyService service attributes.
*
* @param serviceName
- * unique name of the service
+ * unique name of the service
* @param operationalState
- * operational state of service
+ * operational state of service
* @param administrativeState
- * administrative state of service
+ * administrative state of service
* @return result of modifyService operation
*/
OperationResult modifyService(String serviceName, State operationalState, AdminStates administrativeState);
* create new servicePath entry.
*
* @param serviceInput
- * ServiceInput data for creation of service
+ * ServiceInput data for creation of service
* @param outputFromPce
- * output from pce request which is used as input for creating of service.
+ * output from pce request which is used as input for creating of service.
* @return result of createServicePath operation
*/
OperationResult createServicePath(ServiceInput serviceInput, PathComputationRequestOutput outputFromPce);
* deleteServicePath by name.
*
* @param serviceName
- * unique name of the service
+ * unique name of the service
* @return result of Delete operation
*/
OperationResult deleteServicePath(String serviceName);
* This method exists only for backwards compatibility. It will be deleted once refactoring is done.
*
* @param serviceName
- * unique name of the service
+ * unique name of the service
* @param input ServiceCreateInput data
* @param output PathComputationRequestOutput data
* @param choice 0:modify, 1:delete, 2:write