All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.wso2.bps.samples.processcleanup.CleanupExecutor Maven / Gradle / Ivy

/*
 * Copyright (c) 2012, WSO2 Inc. (http://www.wso2.org) 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.
 */
package org.wso2.bps.samples.processcleanup;

import org.apache.xerces.dom.DeferredElementImpl;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import java.io.*;
import java.sql.*;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * The main class
 */
public class CleanupExecutor {
	private final static Logger log = Logger.getLogger(CleanupExecutor.class.getName());

	private static HashMap> map;
	static String databaseURL = null;
	static String bpsHome = null;
	//DB query builder according to DB type
	private static DBQuery query;

	/**
	 * Get user configurations from processCleanup.properties file
	 *
	 * @param property property
	 * @return property
	 * @throws Exception
	 */
	private static String getProperty(String property) throws Exception {
		Properties prop = new Properties();
		String configPath =
				bpsHome + CleanupConstants.REPOSITORY + File.separator + CleanupConstants.CONF +
				File.separator + CleanupConstants.CLEANUP_PROPERTIES;
		prop.load(new FileInputStream(configPath));
		return prop.getProperty(property);
	}

	/**
	 * Create DB connection
	 *
	 * @return Connection
	 * @throws ParserConfigurationException
	 * @throws IOException
	 * @throws SAXException
	 * @throws ClassNotFoundException
	 * @throws SQLException
	 */
	private static Connection initializeDBConnection()
			throws ParserConfigurationException, IOException, SAXException, ClassNotFoundException,
			       SQLException {
		String databaseUsername = null;
		String databasePassword = null;
		String databaseDriver = null;
		boolean dbConfigFound = false;
        bpsHome = System.getProperty(CleanupConstants.CARBON_HOME);

        if (!(bpsHome.endsWith(File.separator))) {
            bpsHome += File.separator;
        }
        System.out.println("Processcleanuptool startup - BPS HOME DIRECTORY : " + bpsHome);

		String configPath =
				bpsHome + CleanupConstants.REPOSITORY + File.separator + CleanupConstants.CONF +
				File.separator + CleanupConstants.DATASOURCES +
				File.separator + CleanupConstants.BPS_DATASOURCES;
		File elementXmlFile = new File(configPath);
		DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
		dbFactory.setIgnoringComments(true);
		dbFactory.setIgnoringElementContentWhitespace(true);
		DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
		Document document = dBuilder.parse(elementXmlFile);
		document.getDocumentElement().normalize();
		NodeList datasourceList =
				document.getDocumentElement().getElementsByTagName(CleanupConstants.DATASOURCE);
		for (int i = 0; i < datasourceList.getLength(); i++) {
			Node datasource = datasourceList.item(i);
			String dbName =
					((DeferredElementImpl) datasource).getElementsByTagName(CleanupConstants.NAME)
					                                  .item(0).getTextContent();
			if (dbName.equals(CleanupConstants.BPS_DS)) {
				databaseURL =
						document.getDocumentElement().getElementsByTagName(CleanupConstants.URL)
						        .item(i).getTextContent().split(";")[0];
				databaseDriver = document.getDocumentElement()
				                         .getElementsByTagName(CleanupConstants.DRIVER_CLASS_NAME)
				                         .item(i).getTextContent();
				databaseUsername = document.getDocumentElement()
				                           .getElementsByTagName(CleanupConstants.USER_NAME).item(i)
				                           .getTextContent();
				databasePassword = document.getDocumentElement()
				                           .getElementsByTagName(CleanupConstants.PASSWORD).item(i)
				                           .getTextContent();
				dbConfigFound = true;
				break;
			}
		}
		if (!dbConfigFound) {
			log.info("ERROR: DB configurations not found or invalid!");
			System.exit(0);
		}
		Class.forName(databaseDriver);
		return DriverManager.getConnection(databaseURL, databaseUsername, databasePassword);
	}

	/**
	 * Creating the search query filter string according to user configurations
	 *
	 * @return filters
	 * @throws Exception
	 */
	private static String getFilters() throws Exception {
		String filterStates[] = getProperty(CleanupConstants.FILTER_STATES).split(",");
		InstanceStatus status = new InstanceStatus();
		for (String s : filterStates) {
			status.state.remove(s.trim());
		}
		String filters;

		switch (status.state.size()) {
			case 0:
				filters = "";
				break;
			case 1:
				filters = " and s.DU not in \n" +
				          "(select s.DU \n" +
				          "from ODE_PROCESS_INSTANCE a, ODE_PROCESS b, STORE_PROCESS s \n" +
				          "where a.PROCESS_ID = b.ID \n" +
				          "and s.PID = b.PROCESS_ID \n" +
				          "and (";
				filters += " a.INSTANCE_STATE = " + status.state.values().toArray()[0] + "))";
				break;
			default:
				filters = " and s.DU not in \n" +
				          "(select s.DU \n" +
				          "from ODE_PROCESS_INSTANCE a, ODE_PROCESS b, STORE_PROCESS s \n" +
				          "where a.PROCESS_ID = b.ID \n" +
				          "and s.PID = b.PROCESS_ID \n" +
				          "and (a.INSTANCE_STATE = " + status.state.values().toArray()[0];
				for (int i = 1; i < status.state.size(); i++) {
					filters += " or a.INSTANCE_STATE = " + status.state.values().toArray()[i];
				}
				filters += "))";
		}

		return filters;
	}

	/**
	 * Registry and DB cleanup process
	 *
	 * @param packageName package name that need to be deleted
	 * @return true if the database cleaning process is success
	 * @throws Exception
	 */
	private static boolean deletePackages(String packageName) throws Exception {
		Connection conn = initializeDBConnection();
		conn.setAutoCommit(false);
		String clientTrustStorePath = getProperty(CleanupConstants.CLIENT_TRUST_STORE_PATH);
		String trustStorePassword = getProperty(CleanupConstants.CLIENT_TRUST_STORE_PASSWORD);
		String trustStoreType = getProperty(CleanupConstants.CLIENT_TRUST_STORE_TYPE);
		System.out.println("Deleting package:" + packageName);
		String regPath = CleanupConstants.REG_PATH;

		//DB cleanup happens if the Registry cleaned successfully
		boolean regCleanSuccess = RegistryCleaner
				.deleteRegistry(regPath, packageName, clientTrustStorePath, trustStorePassword,
				                trustStoreType);

		if (regCleanSuccess) {
			List processList = map.get(packageName);
			try {
				if (getProperty(CleanupConstants.DELETE_INSTANCES).toLowerCase()
				                                                  .equals(CleanupConstants.TRUE)) {
					cleanProcessInstances(processList, conn);
				}
				for (String id : processList) {
					conn.createStatement().execute(query.deleteFromOdeProcess(id));
				}
				conn.createStatement().execute(query.deleteFromStoreDu(packageName));
				conn.createStatement().execute(query.deleteFromStoreProcess(packageName));
				conn.commit();
				System.out.println("Database Cleaning Success!!");
				return true;
			} catch (SQLException e) {
				log.log(Level.SEVERE, e.getMessage(), e);
				conn.rollback();
			} finally {
				if (conn != null) {
					conn.close();
				}
			}
		}
		System.out.println("Cleanup Unsuccessful! (Server Error)");
		return false;
	}

	/**
	 * Clean process instances
	 *
	 * @param processIdList process id list
	 * @param conn          database connection object
	 * @throws Exception
	 */
	private static void cleanProcessInstances(List processIdList, Connection conn)
			throws Exception {
		int i = 0;
		System.out.print("Instance Clean Count : 000000000");
		try {
			Statement stmt = conn.createStatement();
			for (String process : processIdList) {
				String sql = query.getInstancesSearchQuery(process);
				ResultSet rs = stmt.executeQuery(sql);
				while (rs.next()) {
					String id = rs.getString(CleanupConstants.ID);
					conn.createStatement().execute(query.deleteFromOdePartnerLink(id));
					conn.createStatement().execute(query.deleteFromOdeScope(id));
					conn.createStatement().execute(query.deleteFromOdeEvent(id));
					conn.createStatement().execute(query.deleteFromOdeCorsetProp(id));
					conn.createStatement().execute(query.deleteFromOdeCorrelationSet(id));
					conn.createStatement().execute(query.deleteFromOdeXmlDataProp(id));
					conn.createStatement().execute(query.deleteFromOdeXmlData(id));
					conn.createStatement().execute(query.deleteFromOdeMexProp(id));
					conn.createStatement().execute(query.deleteFromOdeMessage(id));
					conn.createStatement().execute(query.deleteFromOdeMessageExchange(id));
					conn.createStatement().execute(query.deleteFromOdeMessageRoute(id));
					conn.createStatement().execute(query.deleteFromOdeProcessInstance(id));
					//printing the status
					System.out.print("\b\b\b\b\b\b\b\b\b");
					System.out.print(String.format("%09d", ++i));
				}
				conn.commit();
			}
			System.out.println();
		} catch (SQLException e) {
			log.log(Level.SEVERE, e.getMessage(), e);
			throw new SQLException(e);
		}
	}

	/**
	 * Using the search query gets all deletable package list
	 *
	 * @param name package name
	 * @return hash map
	 * @throws Exception
	 */
	private static HashMap> getDeletablePackageList(String name)
			throws Exception {
		Statement stmt = initializeDBConnection().createStatement();
		String filters = getFilters();
		String sql;
		if (name != null) {
			sql = query.getSearchByNameQuery(filters, name);
		} else {
			sql = query.getSearchQuery(filters);
		}

		ResultSet rs = stmt.executeQuery(sql);
		HashMap> map = new HashMap>();

		while (rs.next()) {
			if (map.get(rs.getString(CleanupConstants.DEPLOYMENT_UNIT)) == null) {
				List list = new ArrayList();
				list.add(rs.getString(CleanupConstants.ID));
				map.put(rs.getString(CleanupConstants.DEPLOYMENT_UNIT), list);
			} else {
				map.get(rs.getString(CleanupConstants.DEPLOYMENT_UNIT))
				   .add(rs.getString(CleanupConstants.ID));
			}
		}

		String[] keys = map.keySet().toArray(new String[] {});
		for (int i = 0; i < map.size(); i++) {
			//Display the options
			String id = String.format("%9d", i + 1);
			//Add the list of processes retrieved from DB into a list
			System.out.println(String.format("%-10s | %s", id, keys[i]));
		}

		return map;
	}

	/**
	 * Get user inputs and validate
	 *
	 * @param minOption minimum value that can be entered on console
	 * @param maxOption maximum value that can be entered
	 * @param message   message
	 * @return list of options entered by the user
	 * @throws Exception
	 */
	private static int[] getValidUserInput(int minOption, int maxOption, String message)
			throws Exception {
		boolean valid = false;
		int[] userInputs = new int[1];
		//Get user inputs
		BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
		do {
			System.out.println("\n" + message);
			String input = br.readLine();
			try {
				//Creates the list of options entered by user
				if (input.contains(",") && !input.contains(",,")) {
					String optionsArray[] = input.split(",");
					userInputs = new int[optionsArray.length];
					for (int i = 0; i < optionsArray.length; i++) {
						userInputs[i] = Integer.parseInt(optionsArray[i]);
						if (userInputs[i] > minOption && userInputs[i] < maxOption) {
							valid = true;
						} else {
							System.out.println("Invalid Input!");
							valid = false;
							break;
						}
					}
				} else {
					userInputs[0] = Integer.parseInt(input);
					if (userInputs[0] >= minOption && userInputs[0] <= maxOption) {
						valid = true;
					} else {
						System.out.println("Invalid Input!");
					}
				}

			} catch (Exception e) {
				log.log(Level.SEVERE, e.getMessage(), e);
			}
		} while (!valid);
		return userInputs;
	}

	/**
	 * main method
	 *
	 * @param args
	 * @throws Exception
	 */
	public static void main(String[] args) throws Exception {
		initializeDBConnection();
		query = new DBQuery(databaseURL, bpsHome);
		TimeZone.setDefault(TimeZone.getTimeZone(getProperty(CleanupConstants.TIME_ZONE)));
		System.out.println("\n=============ATTENTION=================\n" +
		                   "This tool deletes selected process versions and optionally all corresponding process instances.\n" +
		                   "Hence take backups of DB before executing this tool.\n" +
		                   "Also read configuration information from the docs before running the tool.\n" +
		                   "=======================================");

		System.out.println("\nInsert option number to list non-active BPEL packages");
		System.out.println("1. List All");
		System.out.println("2. Search and List by Process Name");
		System.out.println("3. Exit");

		int userInput[] = getValidUserInput(1, 3, CleanupConstants.ENTER_OPTION_NUMBER);
		String name = null;
		switch (userInput[0]) {
			case 3:
				System.exit(0);
				break;
			case 2:
				System.out.println("Please Enter Process Name:");
				BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
				name = br.readLine().trim();
			default:
				System.out.println("Initialize JDBC Connection\n");
				try {
					//listing out the deletable process list in the console
					System.out.println("List of Non-Active BPEL Packages\n");
					System.out.println(String.format(" %-9s | %s", "Option #", "Package Name"));
					System.out.println("==========================================");
					map = getDeletablePackageList(name);
					String[] list = map.keySet().toArray(new String[] {});
					int deleteAllOption = list.length + 1;

					switch (list.length) {
						case 0:
							System.out.println("*** No Packages Found ***");
							System.out.println("==========================================");
							break;
						case 1:
							System.out.println("==========================================");
							break;
						default:
							System.out.println("==========================================");
							String id = String.format("%9d", deleteAllOption);
							System.out.println(String.format("%-10s | %s", id, "Delete All"));
							break;
					}
					String id = String.format("%9d", 0);
					System.out.println(String.format("%-10s | %s", id, "Exit"));

					//Get user input with multiple packages to delete at once
					int options[] = getValidUserInput(0, deleteAllOption,
					                                  CleanupConstants.OPTION_NUMBERS_TO_DELETE);

					if (options[0] == 0) {
						//if entered 0 system exits
						System.exit(0);
					} else if (options[0] == deleteAllOption) {
						//Delete all option
						for (String packageName : list) {
							deletePackages(packageName);
						}
					} else {
						//Delete several packages
						for (int op : options) {
							deletePackages(list[op - 1]);
						}
					}

				} catch (Exception e) {
					log.log(Level.SEVERE, e.getMessage(), e);
				}
				break;
		}
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy