Skip to content

Commit

Permalink
Merge pull request #4 in SUITE/sdk-client-tools-protex from ~APITCHAI…
Browse files Browse the repository at this point in the history 
…/sdk-client-tools-protex:dev/PROTEX-21965-AddSDKClientExampleForRemovingSubProjects to release/BDS_7_5_x

PROTEX-21965: Merge the dev branch created for adding new client example.

* commit '01f18e3bca43050e8031d66f11a2b72d3964c0fd':
  PROTEX-21965:Wrap the sdk method calls with try catch
  PROTEX-21965: Add Sdk client example for removing subprojects from all projects
  • Loading branch information
Abinaya Pitchai committed Oct 27, 2016
2 parents 6dd917a + 01f18e3 commit 28b6dc1
Showing 1 changed file with 208 additions and 0 deletions.
208 changes: 208 additions & 0 deletions ...java/com/blackducksoftware/sdk/protex/client/examples/SampleRemoveSubProjectsFromBom.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
package com.blackducksoftware.sdk.protex.client.examples;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;

import com.blackducksoftware.sdk.fault.SdkFault;
import com.blackducksoftware.sdk.protex.client.util.ProtexServerProxy;
import com.blackducksoftware.sdk.protex.common.BomRefreshMode;
import com.blackducksoftware.sdk.protex.common.ComponentType;
import com.blackducksoftware.sdk.protex.common.SortType;
import com.blackducksoftware.sdk.protex.project.ProjectApi;
import com.blackducksoftware.sdk.protex.project.ProjectInfo;
import com.blackducksoftware.sdk.protex.project.ProjectInfoColumn;
import com.blackducksoftware.sdk.protex.project.ProjectInfoPageFilter;
import com.blackducksoftware.sdk.protex.project.bom.BomApi;
import com.blackducksoftware.sdk.protex.project.bom.BomComponent;
import com.blackducksoftware.sdk.protex.project.codetree.CodeTreeNode;
import com.blackducksoftware.sdk.protex.project.codetree.identification.CodeMatchIdentification;
import com.blackducksoftware.sdk.protex.project.codetree.identification.CodeTreeIdentificationInfo;
import com.blackducksoftware.sdk.protex.project.codetree.identification.DeclaredIdentification;
import com.blackducksoftware.sdk.protex.project.codetree.identification.DependencyIdentification;
import com.blackducksoftware.sdk.protex.project.codetree.identification.Identification;
import com.blackducksoftware.sdk.protex.project.codetree.identification.IdentificationApi;
import com.blackducksoftware.sdk.protex.project.codetree.identification.IdentificationMode;
import com.blackducksoftware.sdk.protex.project.codetree.identification.IdentificationType;
import com.blackducksoftware.sdk.protex.project.codetree.identification.StringSearchIdentification;

/**
* This is a sample sdk client example created per request from PROTEX-21896.
*
* This sdk example traverses through a list of projects, finds the sub-projects inside the project and reset the
* identifications of that sub project if any identifications are present. If identifications for that subproject are
* not present removes the subproject from the bom component.
*
* @author apitchai
*
*/
public class SampleRemoveSubProjectsFromBom extends BDProtexSample {

private static ProjectApi projectApi = null;

private static IdentificationApi identificationApi = null;

private static BomApi bomApi = null;

/**
* Output usage information for this sample
*/
private static void usage() {
String className = SampleRemoveSubProjectsFromBom.class.getSimpleName();

List<String> parameters = new ArrayList<String>(getDefaultUsageParameters());
parameters.add("<projects filter first index>");
parameters.add("<projects filter last index>");

List<String> paramDescriptions = new ArrayList<String>(getDefaultUsageParameterDetails());
paramDescriptions
.add(formatUsageDetail("projects page filter first index",
"The first index of the project page filter in integer i.e. 0"));
paramDescriptions
.add(formatUsageDetail("projects page filter last index",
"The last index of the project page filter in integer i.e. 20"));
outputUsageDetails(className, parameters, paramDescriptions);

}

public static void main(String[] args) throws Exception {
// check and save parameters
if (args.length < 5) {
System.err.println("Not enough parameters!");
usage();
System.exit(-1);
}

String serverUri = args[0];
String username = args[1];
String password = args[2];
String firstIndex = args[3];
String lastIndex = args[4];

Long connectionTimeout = 240 * 1000L;

ProtexServerProxy myProtexServer = null;

try {
try {
myProtexServer = new ProtexServerProxy(serverUri, username, password, connectionTimeout);

projectApi = myProtexServer.getProjectApi();
identificationApi = myProtexServer.getIdentificationApi();
bomApi = myProtexServer.getBomApi();

} catch (RuntimeException e) {
System.err.println("Connection to server '" + serverUri + "' failed: " + e.getMessage());
throw e;
}

// Get the list of projects whose subprojects needs to be removed from BOM
ProjectInfoPageFilter projectPageFilter = new ProjectInfoPageFilter();
projectPageFilter.setFirstRowIndex(Integer.parseInt(firstIndex));
projectPageFilter.setLastRowIndex(Integer.parseInt(lastIndex));
projectPageFilter.setSortedColumn(ProjectInfoColumn.PROJECT_ID);
projectPageFilter.setSortType(SortType.ALPHABETICAL_CASE_INSENSITIVE);
projectPageFilter.setSortAscending(true);

List<ProjectInfo> projectsInfo = new LinkedList<ProjectInfo>();
try {
projectsInfo = projectApi.suggestProjects("", projectPageFilter);
} catch (SdkFault e) {
System.err.println("suggestProjects() failed" + e.getMessage());
throw new RuntimeException(e);
}

for (ProjectInfo pInfo : projectsInfo) {
String projectId = pInfo.getProjectId();

// Getting all the bom components of this project and filtering out the just the subprojects
List<BomComponent> allBomComponents = new LinkedList<BomComponent>();
try {
allBomComponents = bomApi.getBomComponents(projectId);
} catch (SdkFault e) {
System.err.println("getBomComponents() failed" + e.getMessage());
throw new RuntimeException(e);
}

List<BomComponent> subProjects = new LinkedList<BomComponent>();
for (BomComponent bComponent : allBomComponents) {
if (bComponent.getComponentType().equals(ComponentType.PROJECT)
&& !bComponent.getComponentKey().getComponentId().equals(projectId)) {
subProjects.add(bComponent);
}
}

List<IdentificationType> idTypes = Arrays.asList(IdentificationType.CODE_MATCH, IdentificationType.DECLARATION,
IdentificationType.DEPENDENCY,
IdentificationType.STRING_SEARCH);
List<IdentificationMode> idModes = Arrays.asList(IdentificationMode.MANUAL, IdentificationMode.RAPID_ID);

// Finding the identifications of the subprojects and resetting the identifications.
// If no identifications are present, removing the subproject from bom component.
for (BomComponent bComponent : subProjects) {
List<CodeTreeNode> idNodes = null;
try {
idNodes = bomApi.getFilesIdentifiedTo(projectId, bComponent.getComponentKey(), idTypes, idModes);
} catch (SdkFault e) {
System.err.println("getFilesIdentifiedTo() failed" + e.getMessage());
throw new RuntimeException(e);
}

if (idNodes == null || idNodes.isEmpty()) {
try {
bomApi.removeBomComponent(projectId, bComponent.getComponentKey(), true, BomRefreshMode.ASYNCHRONOUS);
} catch (SdkFault e) {
System.err.println("removeBomComponent() failed" + e.getMessage());
throw new RuntimeException(e);
}
} else {
List<CodeTreeIdentificationInfo> idsInfo = new LinkedList<CodeTreeIdentificationInfo>();
try {
idsInfo = identificationApi.getEffectiveIdentifications(projectId, idNodes);
} catch (SdkFault e) {
System.err.println("getEffectiveIdentifications() failed" + e.getMessage());
throw new RuntimeException(e);
}

for (CodeTreeIdentificationInfo idInfo : idsInfo) {
for (Identification identification : idInfo.getIdentifications()) {
try {
if (identification instanceof CodeMatchIdentification) {
CodeMatchIdentification codeMatchIdentification = (CodeMatchIdentification) identification;
identificationApi.removeCodeMatchIdentification(projectId, codeMatchIdentification, BomRefreshMode.ASYNCHRONOUS);
} else if (identification instanceof DeclaredIdentification) {
DeclaredIdentification declaredIdentification = (DeclaredIdentification) identification;
identificationApi.removeDeclaredIdentification(projectId, declaredIdentification, BomRefreshMode.ASYNCHRONOUS);
} else if (identification instanceof StringSearchIdentification) {
StringSearchIdentification stringSearchIdentification = (StringSearchIdentification) identification;
identificationApi.removeStringSearchIdentification(projectId, stringSearchIdentification,
BomRefreshMode.ASYNCHRONOUS);
} else if (identification instanceof DependencyIdentification) {
DependencyIdentification dependencyIdentification = (DependencyIdentification) identification;
identificationApi.removeDependencyIdentification(projectId, dependencyIdentification, BomRefreshMode.ASYNCHRONOUS);
}
} catch (SdkFault e) {
System.err.println("remove Identification failed" + e.getMessage());
throw new RuntimeException(e);
}
}
}
}
}
System.out.println("Remove subproject identification for \"" + projectId + "\" finished.");
}

} catch (Exception e) {
System.err.println("Sample RemoveSubProjects failed");
e.printStackTrace(System.err);
System.exit(-1);
} finally {
// This is optional - it causes the proxy to overwrite the stored password with null characters, increasing
// security
if (myProtexServer != null) {
myProtexServer.close();
}
}
}
}

0 comments on commit 28b6dc1

Please sign in to comment.