diff options
Diffstat (limited to 'api-active-standby-management')
3 files changed, 102 insertions, 33 deletions
diff --git a/api-active-standby-management/checkstyle-suppressions.xml b/api-active-standby-management/checkstyle-suppressions.xml new file mode 100644 index 00000000..b6fa7eff --- /dev/null +++ b/api-active-standby-management/checkstyle-suppressions.xml @@ -0,0 +1,30 @@ +<?xml version="1.0"?> +<!-- + ============LICENSE_START======================================================= + Copyright (C) 2018 AT&T Technologies. All rights reserved. + ================================================================================ + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + SPDX-License-Identifier: Apache-2.0 + ============LICENSE_END========================================================= +--> + +<!DOCTYPE suppressions PUBLIC + "-//Puppy Crawl//DTD Suppressions 1.0//EN" + "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd"> + +<suppressions> + <suppress checks="AbbreviationAsWordInName" + files="ActiveStandbyFeatureAPI.java" + lines="1-9999"/> +</suppressions> diff --git a/api-active-standby-management/pom.xml b/api-active-standby-management/pom.xml index eec22ee4..665ef777 100644 --- a/api-active-standby-management/pom.xml +++ b/api-active-standby-management/pom.xml @@ -46,4 +46,45 @@ <scope>provided</scope> </dependency> </dependencies> + + <build> + <plugins> + <plugin> + <artifactId>maven-checkstyle-plugin</artifactId> + <executions> + <execution> + <id>onap-java-style</id> + <goals> + <goal>check</goal> + </goals> + <phase>process-sources</phase> + <configuration> + <!-- Use Google Java Style Guide: https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml + with minor changes --> + <configLocation>onap-checkstyle/onap-java-style.xml</configLocation> + <!-- <sourceDirectory> is needed so that checkstyle ignores the generated sources directory --> + <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory> + <includeResources>true</includeResources> + <includeTestSourceDirectory>true</includeTestSourceDirectory> + <includeTestResources>true</includeTestResources> + <excludes> + </excludes> + <suppressionsLocation>${project.baseUri}checkstyle-suppressions.xml</suppressionsLocation> + <consoleOutput>true</consoleOutput> + <failsOnViolation>true</failsOnViolation> + <violationSeverity>warning</violationSeverity> + </configuration> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.onap.oparent</groupId> + <artifactId>checkstyle</artifactId> + <version>${oparent.version}</version> + <scope>compile</scope> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project> diff --git a/api-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeatureAPI.java b/api-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeatureAPI.java index ef02c617..ac1f1ce5 100644 --- a/api-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeatureAPI.java +++ b/api-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeatureAPI.java @@ -2,7 +2,7 @@ * ============LICENSE_START======================================================= * api-active-standby-management * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,40 +24,38 @@ import org.onap.policy.drools.utils.OrderedService; import org.onap.policy.drools.utils.OrderedServiceImpl; /** - * This interface provides a way to invoke optional features at various - * points in the code. At appropriate points in the - * application, the code iterates through this list, invoking these optional - * methods. + * This interface provides a way to invoke optional features at various points in the code. At + * appropriate points in the application, the code iterates through this list, invoking these + * optional methods. */ -public interface ActiveStandbyFeatureAPI extends OrderedService -{ - /** - * 'FeatureAPI.impl.getList()' returns an ordered list of objects - * implementing the 'FeatureAPI' interface. - */ - public static OrderedServiceImpl<ActiveStandbyFeatureAPI> impl = - new OrderedServiceImpl<>(ActiveStandbyFeatureAPI.class); +public interface ActiveStandbyFeatureAPI extends OrderedService { + /** + * 'FeatureAPI.impl.getList()' returns an ordered list of objects implementing the 'FeatureAPI' + * interface. + */ + public static OrderedServiceImpl<ActiveStandbyFeatureAPI> impl = + new OrderedServiceImpl<>(ActiveStandbyFeatureAPI.class); - /** - * This method returns the resourceName (PDP ID) for the Drools-PDP that is - * currently designated as active. - * - * @return String (resourceName) - */ - public String getPdpdNowActive(); + /** + * Returns the resourceName (PDP ID) for the Drools-PDP that is + * currently designated as active. + * + * @return String (resourceName) + */ + public String getPdpdNowActive(); - /** - * This method returns the resourceName (PDP ID) for the Drools-PDP that was - * previously designated as active. - * - * @return String (resourceName) - */ - public String getPdpdLastActive(); - - /** - * This method returns the resourceName associated with this instance of the feature - * @return String (resourceName) - */ - public String getResourceName(); + /** + * Returns the resourceName (PDP ID) for the Drools-PDP that is + * previously designated as active. + * + * @return String (resourceName) + */ + public String getPdpdLastActive(); + /** + * Returns the resourceName associated with this instance of the feature. + * + * @return String (resourceName) + */ + public String getResourceName(); } |