Governance Artifact Search Sample

This sample demonstrates how to search governance artifacts using attributes and get the paginated results. GenericArtifactManager can be used to search governance artifacts. 

1. The following is the complete code for the sample.

   SearchClient.java

   /*
   *  Copyright (c) 2005-2010, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
   *
   *  WSO2 Inc. licenses this file to you 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.
   */
   package org.wso2.carbon.registry.search.client;
   import org.apache.axis2.context.ConfigurationContext;
   import org.apache.axis2.context.ConfigurationContextFactory;
   import org.wso2.carbon.base.ServerConfiguration;
   import org.wso2.carbon.governance.api.generic.GenericArtifactManager;
   import org.wso2.carbon.governance.api.generic.dataobjects.GenericArtifact;
   import org.wso2.carbon.governance.api.util.GovernanceUtils;
   import org.wso2.carbon.governance.client.WSRegistrySearchClient;
   import org.wso2.carbon.registry.core.Registry;
   import org.wso2.carbon.registry.core.exceptions.RegistryException;
   import org.wso2.carbon.registry.core.pagination.PaginationContext;
   import org.wso2.carbon.registry.core.session.UserRegistry;
   import org.wso2.carbon.registry.ws.client.registry.WSRegistryServiceClient;
   import javax.xml.namespace.QName;
   import java.io.File;
   import java.util.ArrayList;
   import java.util.HashMap;
   import java.util.List;
   import java.util.Map;
   
   public class SearchClient {
       private static ConfigurationContext configContext = null;
       private static final String CARBON_HOME = ".." + File.separator + ".." +
               File.separator + ".." + File.separator + ".." + File.separator;
       private static final String axis2Repo = CARBON_HOME + File.separator + "repository" +
               File.separator + "deployment" + File.separator + "client";
       private static final String axis2Conf =
               ServerConfiguration.getInstance().getFirstProperty("Axis2Config.clientAxis2XmlLocation");
       private static final String username = "admin";
       private static final String password = "admin";
       private static final String serverURL = "https://localhost:9443/services/";
   
       private static WSRegistryServiceClient initialize() throws Exception {
           System.setProperty("javax.net.ssl.trustStore", CARBON_HOME + File.separator + "repository" +
                   File.separator + "resources" + File.separator + "security" + File.separator +
                   "wso2carbon.jks");
           System.setProperty("javax.net.ssl.trustStorePassword", "wso2carbon");
           System.setProperty("javax.net.ssl.trustStoreType", "JKS");
           System.setProperty("carbon.repo.write.mode", "true");
           configContext = ConfigurationContextFactory.createConfigurationContextFromFileSystem(
                   axis2Repo, axis2Conf);
   
           return new WSRegistryServiceClient(serverURL, username, password, configContext);
       }
   
       public static void main(String[] args) throws Exception {
           try {
               final Registry registry = initialize();
               Registry gov = GovernanceUtils.getGovernanceUserRegistry(registry, "admin");
               // Should be load the governance artifact.
               GovernanceUtils.loadGovernanceArtifacts((UserRegistry) gov);
               addServices(gov);
               //Initialize the pagination context.
               //Top five services, sortBy name , and sort order descending.
               PaginationContext.init(0, 5, "DES", "overview_name", 100);
               WSRegistrySearchClient wsRegistrySearchClient =
                       new WSRegistrySearchClient(serverURL, username, password, configContext);
               //This should be execute to initialize the AttributeSearchService.
               wsRegistrySearchClient.init();
               //Initialize the GenericArtifactManager
               GenericArtifactManager artifactManager =
                       new GenericArtifactManager(gov, "service");
               Map<String, List<String>> listMap = new HashMap<String, List<String>>();
               //Create the search attribute map
               listMap.put("lcName", new ArrayList<String>() {{
                   add("ServiceLifeCycle");
               }});
               listMap.put("lcState", new ArrayList<String>() {{
                   add("Development");
               }});
               //Find the results.
               System.out.println("\n\nSearch services having ServiceLifeCycle and development state ...\n");
               System.out.println("Get top five services ..\n");
               System.out.println("Sort by  service name ..\n");
               System.out.println("Sort order descending ..\n\n");
               GenericArtifact[] genericArtifacts = artifactManager.findGenericArtifacts(listMap);
               if (genericArtifacts.length == 0) {
                   System.out.println("No results found ..");
               }
               System.out.println("\nResults found ... \n");
               for (GenericArtifact artifact : genericArtifacts) {
                   System.out.println(artifact.getPath());
               }
           } finally {
               PaginationContext.destroy();
           }
           System.exit(1);
       }
       private static void addServices(Registry govRegistry) throws RegistryException {
           GenericArtifactManager artifactManager = new GenericArtifactManager(govRegistry, "service");
           System.out.println("#############################################\n");
           for (int i = 1; i < 10; i++) {
               System.out.println("Adding FlightService" + i + " ....");
               GenericArtifact artifact = artifactManager.newGovernanceArtifact(new QName("ns", "FlightService" + i));
               artifactManager.addGenericArtifact(artifact);
           }
           //Services need to be index before search.
           try {
               System.out.println("\n.....Waiting to index services .....!");
               Thread.sleep(2 * 60 * 1000);
           } catch (InterruptedException e) {
               e.printStackTrace();
           }
       }
   }

2. The following code segment initializes the pagination context and sets the number of results returned to 5

   //Initialize the pagination context.
   //Top five services, sortBy name , and sort order descending.
   PaginationContext.init(0, 5, "DES", "overview_name", 100);

3. In order to search using the "GenericArtifactManager" it needs to constructed by specifying the media type of the artifacts that need to be searched. Here the search is done for services hence the "GenericArtifactManager" is constructed by giving the short name for services. If a different media type needs to be searched the corresponding short name should be specified when constructing the "GenericArtifactManager". For example, if APIs needs to be searched "api" should be used instead of "service".

   GenericArtifactManager artifactManager = new GenericArtifactManager(gov, "service");

   In order to search an filter criteria needs to be specified. This is provided in a form of a HashMap with a String key and List of Strings as values for each key. The searching criteria can be specified by the following values.

   lcName -  The name of the lifecycle 
   lcState - The state of the lifecycle associated with the artifact

     Map<String, List<String>> listMap = new HashMap<String, List<String>>();
     //Create the search attribute map
     listMap.put("lcName", new ArrayList<String>() {{
          add("ServiceLifeCycle");
     }});
     listMap.put("lcState", new ArrayList<String>() {{
          add("Development");
     }});

   It is also possible to search by attributes by specifying the key as "tableName_attributeName". For example, in services a search can be done on the service name by adding the following criteria. 

    Map<String, List<String>> listMap = new HashMap<String, List<String>>();
     //Create the search attribute map
     listMap.put("overview_name", new ArrayList<String>() {{
          add("FlightService1");
     }});

4. The set of artifacts that match the specified criteria is obtained by the following line of code.

   GenericArtifact[] genericArtifacts = artifactManager.findGenericArtifacts(listMap);

5. To run the sample, go to the G-REG_HOME/bin and run the “ant” command. 
   

6. Open the command line window and navigate to the G-REG_HOME/bin.

   Linux: sh wso2server.sh
   Windows: wso2server.bat

   Note: Before you execute step 7 you have to keep the server on for five minutes to start the indexing process.

7. Open a command window and navigate to G-REG_HOME/samples/search-client/src/org.wso2.carbon.registry.search.client and run the “ant” command. Now the sample executes and shows the result on the console.
   
   1. Add ten services (e.g. FlightService1, FlightService2 … FlightService10).
   2. Wait for two minutes to index the services.

   3. Now search the service artifacts according to the following search criteria:

      * The service should have ServiceLifeCycle and be in Development state.
      * Sort the result by name, and in descending order.
      * Get only the top five results.