- reactivates javadoc comments in servicehandler.
- fills some missing parameters in existing javadoc comments.
- removes jenkins-releng javadoc useless warnings on api and ordmodels
generated-sources.
Change-Id: I4fab420479a5c3031c3186158378bef46c6423f6
Co-authored-by: Ahmed Triki <ahmed.triki@orange.com>
Co-authored-by: Martial COULIBALY <martial.coulibaly@gfi.fr>
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
<build>
<plugins>
<plugin>
- <groupId>org.apache.felix</groupId>
- <artifactId>maven-bundle-plugin</artifactId>
- <version>3.0.1</version>
- <extensions>true</extensions>
- <configuration>
- <instructions>
- <Include-Resource>{maven-resources},target/classes/LICENSE,META-INF/git.properties=-target/classes/META-INF/git.properties</Include-Resource>
- <_exportcontents>
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.transportpce.stubrenderer.rev170403.service.implementation.request.input,
- org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.rev170120.service.implementation.request.input,
- org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev161014.internal.link,
- org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev161014.internal.links,*
- </_exportcontents>
- </instructions>
- </configuration>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <version>3.0.1</version>
+ <extensions>true</extensions>
+ <configuration>
+ <instructions>
+ <Include-Resource>{maven-resources},target/classes/LICENSE,META-INF/git.properties=-target/classes/META-INF/git.properties</Include-Resource>
+ <_exportcontents>
+ org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.transportpce.stubrenderer.rev170403.service.implementation.request.input,
+ org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.rev170120.service.implementation.request.input,
+ org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev161014.internal.link,
+ org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev161014.internal.links,*
+ </_exportcontents>
+ </instructions>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourcepath>*/target/generated-sources/mdsal-binding/*</sourcepath>
+ <excludePackageNames>*</excludePackageNames>
+ </configuration>
</plugin>
</plugins>
</build>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourcepath>*/target/generated-sources/mdsal-binding/*</sourcepath>
+ <excludePackageNames>*</excludePackageNames>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+
</project>
/**
* Define the Karaf command method signatures and the Javadoc for each.
* Below method is just an example
+ *
+ * @param testArgument
+ * testArgument
+ *
+ * @return
+ * returns nothing
*/
Object testCommand(Object testArgument);
}
<version>0.2.0-SNAPSHOT</version>
<packaging>bundle</packaging>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourcepath>*/target/generated-sources/mdsal-binding/*</sourcepath>
+ <excludePackageNames>*</excludePackageNames>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourcepath>*/target/generated-sources/mdsal-binding/*</sourcepath>
+ <excludePackageNames>*</excludePackageNames>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+
+
<dependencies>
<dependency>
<groupId>org.opendaylight.netconf</groupId>
</modules>
<!-- DO NOT install or deploy the repo root pom as it's only needed to initiate a build -->
+ <!--
+ Jenkins-releng tests reports more than 600 lines of javadoc warnings on ordmodels
+ and api folders generated-sources for unclear reasons.
+ This behavior was impossible to reproduce locally.
+ The javadoc plugin build section below removes most of those useless warnings.
+ ordmodels/pom.xml and api/pom.xml have been modified similarly with a build and
+ a reporting sections to remove the rest of the warnings.
+ Note that javadoc plugins maven implementation still suffers from several bugs.
+ Tests shows that many configurations options are not correctly supported.
+ (proxy, sourceFilesExclude, etc...).
+ -->
<build>
<plugins>
<plugin>
<skip>true</skip>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourcepath>*/target/generated-sources/mdsal-binding/*</sourcepath>
+ <excludePackageNames>*</excludePackageNames>
+ </configuration>
+ </plugin>
</plugins>
</build>
* Unique Identifier for the node of interest.
* @param logicalConnPoint
* Name of the logical point
+ * @param db
+ * Databroker / MD-SAL data store
*
* @return Result Mapping object if success otherwise null.
*/
/**
* This methods creates an ODU interface on the given termination point.
*
+ * @param supportingOtuInterface
+ * supporting Otu Interface
*
* @return Name of the interface if successful, otherwise return null.
*/
/**
* This methods creates an OTU interface on the given termination point.
*
+ * @param supportOchInterface
+ * support Och Interface
*
* @return Name of the interface if successful, otherwise return null.
*/
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/* Class to check coherency between hard & sof constraints.
+/**
+ * Class to check coherency between hard and soft constraints.
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
*
*/
this.soft = soft;
}
- /*function to check coherency between hard & soft constraints.
+ /**
+ * function to check coherency between hard and soft constraints.
* @return <code> true </code> if coherent
* <code> false </code> else
*/
import com.google.common.util.concurrent.FutureCallback;
import org.slf4j.Logger;
-/*
- * Class to log future logging from datastore actions (write & modify & delete..).
+/**
+ * Class to log future logging from datastore actions (write, modify and delete..).
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
*/
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
- * class for Mapping and Sending PCE requests : - path-computation-request -
- * cancel-resource-reserve.
+/**
+ * Class for Mapping and Sending PCE requests :
+ * - path-computation-request
+ * - cancelCresource-reserve.
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
*
*/
private String error;
private final ListeningExecutorService executor = MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(5));
- /*
+ /**
* MappingAndSendingPCRequest Class constructor for RPC serviceReconfigure.
*
* @param rpcRegistry
setError("");
}
- /*
+ /**
* MappingAndSendingPCRequest Class constructor for RPC
* serviceFeasibilityCheck.
*
setError("");
}
- /*
+ /**
* MappingAndSendingPCRequest Class constructor for RPC serviceCreate.
*
* @param rpcRegistry
setError("");
}
- /*
+ /**
* MappingAndSendingPCRequest Class constructor for modify Service in ODL
* Datastore.
*
setError("");
}
- /*
+ /**
* Build pathComputationRequestInput or cancelResourceReserveInput with
* input parameters (serviceReconfigureInput or serviceFeasibilityCheckInput.
*
.setServiceHandlerHeader(serviceHandlerHeader.build()).build();
}
- /* Send cancelResourceReserve request to PCE.
+ /**
+ * Send cancelResourceReserve request to PCE.
*
* @return CancelResourceReserveOutput data response from PCE
*/
this.error = error;
}
- /*Send pathComputationRequest request to PCE.
+ /**
+ * Send pathComputationRequest request to PCE.
*
* @return PathComputationRequestOutput data response from PCE
*/
-/*
+/**
* Class for Mapping and Sending
* Service Implemention requests :
* - service implementation
private final ListeningExecutorService executor = MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(5));
- /*
+ /**
* MappingAndSendingSIRequest class constructor
* for RPC serviceCreate.
*
.build();
}
- /*
+ /**
* MappingAndSendingSIRequest class constructor
* for RPC serviceReconfigure.
*
}
- /*
+ /**
* MappingAndSendingSIRequest class constructor
* for RPC serviceDelete.
*
LOG.info("ServiceImplementationRequestInput : " + serviceImplementationRequestInput.toString());
}
- /*
+ /**
* Create RxDirection with Port
* information.
*
return result;
}
- /*
+ /**
* Send serviceImplementation request to Render.
*
* @return ServiceImplementationRequestOutput data response from Renderer
}
- /*
+ /**
* Send serviceDelete request to Render.
*
* @return ServiceDeleteOutput data response from Renderer
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
+/**
* Class for mapping
* Hard/soft constraint from Service 1.2
* to servicePath 1.4.
private org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface
.routing.constraints.rev170426.routing.constraints.sp.SoftConstraints servicePathSoftConstraints;
-
- /*
+ /**
* MappingConstraints class constructor
* for hard/soft from service 1.2.
*
setServiceSoftConstraints(soft);
}
- /*
+ /**
* MappingConstraints class constructor
* for hard/soft from servicePath 1.4.
*
setServicePathSoftConstraints(soft);
}
- /*
+ /**
* map hard/soft constraints from Service 1.2
* to ServicePath 1.4.
*/
import java.util.Map;
-/*
+/**
* Enum class to identify ServiceAEnd / serviceZEnd.
*
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
VALUE_MAP = b.build();
}
- /*
+ /**
* Get integer value.
*
* @return integer value.
return value;
}
- /*
+ /**
* Get Endpoint value.
*
* @param valueArg
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
+/**
* Class for checking service sdnc-request-header compliancy.
*
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
/* Response message from procedure. */
private String message;
- /*
+ /**
* ServicehandlerCompliancyCheck class constructor.
*
* @param sdncRequestHeader
this.setMessage("");
}
- /*
+ /**
* ServicehandlerCompliancyCheck class constructor.
*
* @param sdncRequestHeader
this.setMessage("");
}
- /*
+ /**
* ServicehandlerCompliancyCheck class constructor.
*
* @param serviceName
this.setMessage("");
}
- /*
+ /**
* ServicehandlerCompliancyCheck class constructor.
*
* @param serviceName
this.setMessage("");
}
- /*
+ /**
* Check if a String is not null and not equal to void.
*
* @param value
}
- /*
+ /**
* Check Compliancy of Service request.
*
* @param contype
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
+/**
* Class for checking missing info on Tx/Rx for A/Z end.
*
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
/* type serviceEndpoint : serviceAEnd / serviceZEnd. */
private String service = null;
- /*
+ /**
* ServicehandlerTxRxCheck class constructor.
*
* @param endPoint
}
}
- /*
+ /**
* Check if a String is not null and not equal to ''.
*
* @param value
}
- /*
+ /**
* check if Port info is compliant.
*
* @param port
}
- /*
+ /**
* Check if lgx info is compliant.
*
* @param lgx
return result;
}
- /*
+ /**
* Check if Tx/Rx Direction complaincy info.
*
* @param txDirection
return result;
}
- /*
+ /**
* Check Compliancy of Service TxRx info.
*
* @return true if String ok false if not
import org.slf4j.LoggerFactory;
-/*
- * Class to implement ServicehandlerService & ServicehandlerListener.
+/**
+ * Class to implement ServicehandlerService and ServicehandlerListener.
*
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
*
LOG.info("checking Service Compliancy ...");
/*
- * Upon receipt of service-create RPC, service header and sdnc-request
- * header compliancy are verified.
+ * Upon receipt of service
+ * -create RPC, service header and sdnc
+ * -request header compliancy are verified.
*/
compliancyCheck = new ServicehandlerCompliancyCheck(input.getSdncRequestHeader(), input.getServiceName(),
input.getConnectionType(), RpcActions.ServiceCreate);
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
+/**
* Class to register
* Servicehandler Service and Notification.
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
this.notificationPublishService = notificationPublishService;
}
- /*
+ /**
* Method called when the blueprint container is created.
*/
public void init() {
rpcRegistration = rpcRegistry.addRpcImplementation(ServicehandlerService.class, consumer);
}
- /*
+ /**
* Method called when the blueprint container is destroyed.
*/
public void close() {
import org.slf4j.LoggerFactory;
-/*
+/**
* Class to check RPCs Compliancy.
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
*
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
+/**
* Class for Sending
* PCE requests :
* - path-computation-request
import org.slf4j.LoggerFactory;
-/*
+/**
* Class to implement
* StubpceService
* StubpceListener.
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
+/**
* Class to register
- * Stubpce Service & Notification.
+ * Stubpce Service and Notification.
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
*
*/
this.notificationPublishService = notificationPublishService;
}
- /*
+ /**
* Method called when the blueprint container is created.
*/
public void init() {
rpcRegistration = rpcRegistry.addRpcImplementation(StubpceService.class, consumer);
}
- /*
+ /**
* Method called when the blueprint container is destroyed.
*/
public void close() {
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
- *Class for Sending
- * Renderer requests :
+/**
+ * Class for Sending Renderer requests :
* - Service-implementation-request
* - Service-delete-request.
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
import org.slf4j.LoggerFactory;
-/*
+/**
* Class to implement StubrendererService.
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
*
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/*
- *Class to register Stubrenderer Service & Notification.
+/**
+ * Class to register Stubrenderer Service and Notification.
* @author Martial Coulibaly ( martial.coulibaly@gfi.com ) on behalf of Orange
*
*/
this.notificationPublishService = notificationPublishService;
}
- /*
+ /**
* Method called when the blueprint container is created.
*/
public void init() {
rpcRegistration = rpcRegistry.addRpcImplementation(StubrendererService.class, consumer);
}
- /*
+ /**
* Method called when the blueprint container is destroyed.
*/
public void close() {
Code Review / transportpce.git / commitdiff