[3235] | 1 | /*
|
---|
| 2 | * MessageRouter.java
|
---|
| 3 | * Copyright (C) 2002 New Zealand Digital Library, http://www.nzdl.org
|
---|
| 4 | *
|
---|
| 5 | * This program is free software; you can redistribute it and/or modify
|
---|
| 6 | * it under the terms of the GNU General Public License as published by
|
---|
| 7 | * the Free Software Foundation; either version 2 of the License, or
|
---|
| 8 | * (at your option) any later version.
|
---|
| 9 | *
|
---|
| 10 | * This program is distributed in the hope that it will be useful,
|
---|
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 13 | * GNU General Public License for more details.
|
---|
| 14 | *
|
---|
| 15 | * You should have received a copy of the GNU General Public License
|
---|
| 16 | * along with this program; if not, write to the Free Software
|
---|
| 17 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
| 18 | */
|
---|
[3229] | 19 | package org.greenstone.gsdl3.core;
|
---|
| 20 |
|
---|
| 21 | import org.greenstone.gsdl3.util.*;
|
---|
| 22 | import org.greenstone.gsdl3.service.*;
|
---|
| 23 | import org.greenstone.gsdl3.comms.*;
|
---|
| 24 | import org.greenstone.gsdl3.collection.*;
|
---|
| 25 |
|
---|
| 26 | // XML classes
|
---|
[14210] | 27 | import org.w3c.dom.Node;
|
---|
| 28 | import org.w3c.dom.NodeList;
|
---|
| 29 | import org.w3c.dom.Document;
|
---|
| 30 | import org.w3c.dom.Element;
|
---|
[3229] | 31 | import org.xml.sax.InputSource;
|
---|
| 32 | import javax.xml.parsers.*;
|
---|
| 33 |
|
---|
| 34 | // other java classes
|
---|
| 35 | import java.io.File;
|
---|
| 36 | import java.io.Reader;
|
---|
| 37 | import java.io.StringReader;
|
---|
[5226] | 38 | import java.net.Authenticator;
|
---|
[14210] | 39 | import java.net.PasswordAuthentication;
|
---|
[10292] | 40 | import java.util.HashMap;
|
---|
| 41 | import java.util.Iterator;
|
---|
| 42 | import java.util.Properties;
|
---|
[3229] | 43 |
|
---|
[13124] | 44 | import org.apache.log4j.*;
|
---|
| 45 |
|
---|
[3229] | 46 | /**
|
---|
[14210] | 47 | * The hub of a Greenstone system.
|
---|
[3229] | 48 | *
|
---|
[14210] | 49 | * Accepts XML requests (via process method of ModuleInterface) and routes them to the appropriate collection or
|
---|
[3229] | 50 | * service or external entity.
|
---|
| 51 | *
|
---|
[14210] | 52 | * contains a map of module objects - may be services, collections, comms
|
---|
[3229] | 53 | * objects talking to other MessageRouters etc.
|
---|
| 54 | *
|
---|
[3235] | 55 | *
|
---|
| 56 | * @author <a href="mailto:[email protected]">Katherine Don</a>
|
---|
| 57 | * @version $Revision: 15191 $
|
---|
[3229] | 58 | * @see ModuleInterface
|
---|
| 59 | * @see Collection
|
---|
[3644] | 60 | * @see ServiceRack
|
---|
[3229] | 61 | * @see Communicator
|
---|
| 62 | *
|
---|
[15191] | 63 | * Since some service classes are moved into a separate directory in order for them to be checked out from a different repository,
|
---|
[14399] | 64 | * we modify the configureServices method to search some of the classes in other place if they are not found in the service directory.
|
---|
[15191] | 65 | */
|
---|
[3229] | 66 | public class MessageRouter implements ModuleInterface {
|
---|
[14210] | 67 |
|
---|
| 68 | static Logger logger = Logger.getLogger(org.greenstone.gsdl3.core.MessageRouter.class.getName());
|
---|
| 69 |
|
---|
| 70 | /** the (directory) name of the site */
|
---|
| 71 | protected String site_name = null;
|
---|
| 72 | /** site home - the home directory for the site */
|
---|
| 73 | protected String site_home=null;
|
---|
| 74 | /** the http address for this site */
|
---|
| 75 | protected String site_http_address=null;
|
---|
| 76 |
|
---|
[15191] | 77 |
|
---|
[14534] | 78 | protected String library_name = null;
|
---|
| 79 |
|
---|
[14210] | 80 | /** map of names to Module objects */
|
---|
| 81 | protected HashMap module_map=null;
|
---|
| 82 |
|
---|
| 83 | /** container Document to create XML Nodes */
|
---|
| 84 | protected Document doc=null;
|
---|
| 85 | /** the full description of this site */
|
---|
| 86 |
|
---|
| 87 | // should these things be separated into local and remote??
|
---|
| 88 |
|
---|
| 89 | /** the original xml config element */
|
---|
| 90 | public Element config_info = null;
|
---|
| 91 |
|
---|
| 92 | /** list of collections that can be reached */
|
---|
| 93 | protected Element collection_list = null;
|
---|
[15191] | 94 | /** list of collections that are loaded but are private */
|
---|
| 95 | protected Element private_collection_list = null;
|
---|
| 96 |
|
---|
| 97 |
|
---|
[14210] | 98 | /** list of collections that are public and OAI-supportive */
|
---|
| 99 | protected Element oai_collection_list = null;
|
---|
[3229] | 100 |
|
---|
[14210] | 101 | /** list of service clusters that can be reached */
|
---|
| 102 | protected Element cluster_list = null;
|
---|
| 103 | /** list of single services that can be reached */
|
---|
| 104 | protected Element service_list = null;
|
---|
| 105 | /** list of sites that can be reached */
|
---|
| 106 | protected Element site_list = null;
|
---|
| 107 |
|
---|
| 108 |
|
---|
| 109 | /** a converter class to parse XML and create Docs */
|
---|
| 110 | protected XMLConverter converter=null;
|
---|
| 111 |
|
---|
| 112 | //***************************************************************
|
---|
| 113 | // public methods
|
---|
| 114 | //***************************************************************
|
---|
| 115 |
|
---|
| 116 | /** constructor */
|
---|
| 117 | public MessageRouter() {
|
---|
| 118 | this.converter = new XMLConverter();
|
---|
| 119 | this.doc = this.converter.newDOM();
|
---|
| 120 | }
|
---|
| 121 |
|
---|
| 122 | public void cleanUp() {
|
---|
[15191] | 123 | cleanUpModuleMapEntire();
|
---|
[14210] | 124 | }
|
---|
| 125 |
|
---|
| 126 | /** site_name must be set before configure is called */
|
---|
| 127 | public void setSiteName(String site_name) {
|
---|
| 128 | this.site_name = site_name;
|
---|
| 129 | }
|
---|
| 130 | public String getSiteName() {
|
---|
| 131 | return this.site_name;
|
---|
| 132 | }
|
---|
| 133 |
|
---|
[15191] | 134 | /** library_name must be set before configure is called */
|
---|
[14534] | 135 | public void setLibraryName(String library_name) {
|
---|
| 136 | this.library_name = library_name;
|
---|
| 137 | }
|
---|
| 138 | public String getLibraryName() {
|
---|
| 139 | return this.library_name;
|
---|
| 140 | }
|
---|
| 141 |
|
---|
[14210] | 142 | /**
|
---|
| 143 | * configures the system
|
---|
| 144 | *
|
---|
| 145 | * looks in site_home/collect for collections, reads config file
|
---|
| 146 | * site_home/siteConfig.xml
|
---|
| 147 | *
|
---|
| 148 | */
|
---|
| 149 | public boolean configure() {
|
---|
[4000] | 150 |
|
---|
[15191] | 151 | logger.info("configuring the Message Router");
|
---|
[10292] | 152 |
|
---|
[14210] | 153 | if (this.site_name==null) {
|
---|
| 154 | logger.error(" You must set site_name before calling configure");
|
---|
| 155 | return false;
|
---|
[3229] | 156 | }
|
---|
[14210] | 157 | this.site_home = GSFile.siteHome(GlobalProperties.getGSDL3Home(), this.site_name);
|
---|
| 158 | this.site_http_address = GlobalProperties.getGSDL3WebAddress()+"/sites/"+this.site_name;
|
---|
| 159 |
|
---|
| 160 | // are we behind a firewall?? - is there a better place to set up the proxy?
|
---|
| 161 | String host = GlobalProperties.getProperty("proxy.host");
|
---|
| 162 | String port = GlobalProperties.getProperty("proxy.port");
|
---|
| 163 | final String user = GlobalProperties.getProperty("proxy.user");
|
---|
| 164 | final String passwd = GlobalProperties.getProperty("proxy.password");
|
---|
| 165 |
|
---|
| 166 | if (host != null && !host.equals("") && port !=null && !port.equals("")) {
|
---|
| 167 | System.setProperty("http.proxyType", "4");
|
---|
| 168 | System.setProperty("http.proxyHost", host);
|
---|
| 169 | System.setProperty("http.proxyPort", port);
|
---|
| 170 | System.setProperty("http.proxySet", "true");
|
---|
| 171 | // have we got a user/password?
|
---|
| 172 | if (user != null && !user.equals("") && passwd != null && !passwd.equals("")) {
|
---|
| 173 | try {
|
---|
| 174 | // set up the authenticator
|
---|
| 175 | Authenticator.setDefault(new Authenticator(){
|
---|
[15191] | 176 | protected PasswordAuthentication getPasswordAuthentication(){
|
---|
| 177 | return new PasswordAuthentication(user, new String(passwd).toCharArray());
|
---|
| 178 | }
|
---|
| 179 | });
|
---|
[14210] | 180 |
|
---|
| 181 | } catch (Exception e) {
|
---|
| 182 | logger.error("MessageRouter Error: couldn't set up an authenticator the proxy");
|
---|
| 183 |
|
---|
| 184 | }
|
---|
| 185 | }
|
---|
[9874] | 186 | }
|
---|
[14210] | 187 |
|
---|
| 188 | this.module_map = new HashMap();
|
---|
| 189 |
|
---|
[15191] | 190 | // This stuff may be done at a reconfigure also
|
---|
| 191 | return configureLocalSite();
|
---|
| 192 |
|
---|
[14210] | 193 | }
|
---|
| 194 |
|
---|
| 195 |
|
---|
| 196 | /**
|
---|
| 197 | * Process an XML request - as a String
|
---|
| 198 | *
|
---|
| 199 | * @param xml_in the request to process
|
---|
| 200 | * @return the response - contains any error messages
|
---|
| 201 | * @see String
|
---|
| 202 | */
|
---|
| 203 | public String process(String xml_in) {
|
---|
| 204 |
|
---|
| 205 | Document doc = this.converter.getDOM(xml_in);
|
---|
| 206 |
|
---|
| 207 | Element result = process(doc.getDocumentElement());
|
---|
| 208 | return this.converter.getString(result);
|
---|
| 209 | }
|
---|
| 210 |
|
---|
| 211 | /**
|
---|
| 212 | * Process an XML request - as a DOM Element
|
---|
| 213 | *
|
---|
| 214 | * @param xml_in the message to process - should be <message>
|
---|
| 215 | * @return the response - contains any error messages
|
---|
| 216 | * @see Element
|
---|
| 217 | */
|
---|
| 218 | public Element process(Element message) {
|
---|
| 219 |
|
---|
| 220 | // check that its a correct message tag
|
---|
| 221 | if (!message.getTagName().equals(GSXML.MESSAGE_ELEM)) {
|
---|
| 222 | logger.error(" Invalid message. GSDL message should start with <"+GSXML.MESSAGE_ELEM+">, instead it starts with:"+message.getTagName()+".");
|
---|
| 223 | return null;
|
---|
[3229] | 224 | }
|
---|
| 225 |
|
---|
[14210] | 226 | NodeList requests = message.getElementsByTagName(GSXML.REQUEST_ELEM);
|
---|
| 227 |
|
---|
| 228 | Element mainResult = this.doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
| 229 |
|
---|
| 230 | // empty request
|
---|
| 231 | if (requests.getLength()==0) {
|
---|
| 232 | logger.error("empty request");
|
---|
| 233 | return mainResult;
|
---|
[3229] | 234 | }
|
---|
[14210] | 235 |
|
---|
| 236 | Document message_doc = message.getOwnerDocument();
|
---|
| 237 |
|
---|
| 238 | // for now, just process each request one by one, and append the results to mainResult
|
---|
| 239 | // Note: if you add an element to another node in the same document, it
|
---|
| 240 | // gets removed from where it was. This changes the node list - you cant iterate over the node list in a normal manner if you are moving elements out of it
|
---|
| 241 | int num_requests = requests.getLength();
|
---|
| 242 | for (int i=0; i< num_requests; i++) {
|
---|
| 243 | Node result=null;
|
---|
| 244 | Element req = (Element)requests.item(i);
|
---|
| 245 | if (req == null) {
|
---|
| 246 | logger.error("request "+i+" is null");
|
---|
| 247 | continue;
|
---|
| 248 | }
|
---|
| 249 | String path = req.getAttribute(GSXML.TO_ATT); // returns "" if no att of this name
|
---|
| 250 | if (path.equals("")) {
|
---|
| 251 | // its a message for the message router
|
---|
| 252 | String type_att = req.getAttribute(GSXML.TYPE_ATT);
|
---|
| 253 | if (type_att.equals(GSXML.REQUEST_TYPE_MESSAGING)) {
|
---|
| 254 | // its a messaging request - modifies the requests/responses
|
---|
| 255 | result = modifyMessages(req, message, mainResult);
|
---|
| 256 | } else {
|
---|
| 257 | // standard request
|
---|
| 258 | result = processMessage(req);
|
---|
| 259 | }
|
---|
[3229] | 260 |
|
---|
[14210] | 261 | mainResult.appendChild(this.doc.importNode(result, true));
|
---|
| 262 | } else {
|
---|
[15191] | 263 | // The message needs to go to another module. The same message can
|
---|
| 264 | // be passed to multiple modules - they will be in a comma
|
---|
| 265 | // separated list in the 'to' attribute
|
---|
[14210] | 266 | String [] modules = path.split(",");
|
---|
| 267 |
|
---|
| 268 | for (int j=0; j<modules.length; j++) {
|
---|
| 269 | // why can't we do this outside the loop??
|
---|
| 270 | Element mess = this.doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
| 271 | Element copied_request = (Element)this.doc.importNode(req, true);
|
---|
| 272 | mess.appendChild(copied_request);
|
---|
| 273 |
|
---|
| 274 | String this_mod = modules[j];
|
---|
| 275 | // find the module to pass it on to
|
---|
| 276 | // need to put the request into a message element
|
---|
| 277 | String obj = GSPath.getFirstLink(this_mod);
|
---|
| 278 |
|
---|
| 279 | if (this.module_map.containsKey(obj)) {
|
---|
| 280 | copied_request.setAttribute(GSXML.TO_ATT, this_mod);
|
---|
| 281 | result = ((ModuleInterface)this.module_map.get(obj)).process(mess);
|
---|
| 282 | if (result !=null ) {
|
---|
| 283 | // append the contents of the message to the mainResult - there will only be one response at this stage
|
---|
| 284 | Node res = GSXML.getChildByTagName(result, GSXML.RESPONSE_ELEM);
|
---|
| 285 | if (res != null){
|
---|
| 286 | mainResult.appendChild(this.doc.importNode(res, true));
|
---|
[14399] | 287 |
|
---|
[14210] | 288 | }
|
---|
| 289 | } else {
|
---|
| 290 | // add in a place holder response
|
---|
| 291 | Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
|
---|
| 292 | response.setAttribute(GSXML.FROM_ATT, this_mod);
|
---|
| 293 | mainResult.appendChild(response);
|
---|
| 294 | logger.error("MessageRouter Error: request had null result!");
|
---|
| 295 | }
|
---|
| 296 |
|
---|
| 297 | } else {
|
---|
| 298 | logger.error("MessageRouter Error: request has illegal module name in:\n"+this.converter.getString(req));
|
---|
| 299 | }
|
---|
| 300 | }
|
---|
| 301 | }
|
---|
| 302 |
|
---|
| 303 | } // for each request
|
---|
| 304 |
|
---|
| 305 | logger.debug("MR returned response");
|
---|
| 306 | logger.debug(this.converter.getString(mainResult));
|
---|
| 307 |
|
---|
| 308 | return mainResult;
|
---|
| 309 | }
|
---|
[15191] | 310 | public Element getCollectionList() {
|
---|
| 311 | return collection_list;
|
---|
| 312 | }
|
---|
[14210] | 313 | // ********************************************************************
|
---|
[15191] | 314 | // auxiliary configure and cleanup methods
|
---|
[14210] | 315 | // *******************************************************************
|
---|
| 316 |
|
---|
[15191] | 317 | /** Calls clean up on all modules referenced in the module_map and
|
---|
| 318 | removes them . */
|
---|
| 319 | protected void cleanUpModuleMapEntire() {
|
---|
| 320 | if (this.module_map != null) {
|
---|
| 321 | Iterator i = this.module_map.values().iterator();
|
---|
| 322 | while (i.hasNext()) {
|
---|
| 323 | ((ModuleInterface)i.next()).cleanUp();
|
---|
| 324 | i.remove();
|
---|
| 325 | }
|
---|
| 326 | }
|
---|
| 327 | }
|
---|
| 328 |
|
---|
| 329 | /**
|
---|
| 330 | Goes through the children of list, and for each local/site-specific
|
---|
| 331 | name attribute, calls cleanUp on the module and removes it from the
|
---|
| 332 | module_map and removes it from the list
|
---|
| 333 | */
|
---|
| 334 | protected void cleanUpModuleMapSubset(Element list, String remote_site) {
|
---|
| 335 | logger.error(this.converter.getString(list));
|
---|
| 336 | NodeList elements = list.getChildNodes(); // we are assuming no extraneous nodes
|
---|
| 337 | for(int i=elements.getLength()-1; i>=0; i--) {
|
---|
| 338 | Element item = (Element)elements.item(i);
|
---|
| 339 | String name = item.getAttribute(GSXML.NAME_ATT);
|
---|
| 340 | String potential_site_name = GSPath.getFirstLink(name);
|
---|
| 341 | if (remote_site != null) {
|
---|
| 342 | if (remote_site.equals(potential_site_name)) {
|
---|
| 343 | list.removeChild(item);
|
---|
| 344 | }
|
---|
| 345 | } else {
|
---|
| 346 | if (name.equals(potential_site_name)) {// there was no site
|
---|
| 347 | list.removeChild(item);
|
---|
| 348 | ModuleInterface m = (ModuleInterface)this.module_map.remove(name);
|
---|
| 349 | m.cleanUp(); // clean up any open files/connections etc
|
---|
| 350 | m=null;
|
---|
| 351 | }
|
---|
| 352 | }
|
---|
| 353 | }
|
---|
| 354 |
|
---|
| 355 | logger.error(this.converter.getString(list));
|
---|
| 356 |
|
---|
| 357 | }
|
---|
| 358 |
|
---|
| 359 | /** removes all site modules from module_map, and any stored info about this sites collections and services */
|
---|
| 360 | protected void cleanUpAllExternalSiteInfo() {
|
---|
| 361 |
|
---|
| 362 | NodeList site_nodes = this.site_list.getChildNodes();
|
---|
| 363 | for(int i=site_nodes.getLength()-1; i>=0; i--) {
|
---|
| 364 | Element item = (Element)site_nodes.item(i);
|
---|
| 365 | String name = item.getAttribute(GSXML.NAME_ATT);
|
---|
| 366 | // will remove the node from site_list
|
---|
| 367 | deactivateModule(GSXML.SITE_ELEM, name);
|
---|
| 368 | }
|
---|
| 369 |
|
---|
| 370 | }
|
---|
| 371 | /** read thru own site config file - create services and connect to sites
|
---|
| 372 | */
|
---|
| 373 | protected boolean configureLocalSite() {
|
---|
| 374 |
|
---|
| 375 | // this may be a reconfigure, so clean up the old moduleMap
|
---|
| 376 | cleanUpModuleMapEntire();
|
---|
| 377 |
|
---|
| 378 | File configFile = new File(GSFile.siteConfigFile(this.site_home));
|
---|
[14210] | 379 |
|
---|
[15191] | 380 | if (!configFile.exists() ) {
|
---|
| 381 | logger.error(" site config file: "+configFile.getPath()+" not found!");
|
---|
| 382 | return false;
|
---|
| 383 | }
|
---|
| 384 |
|
---|
| 385 | Document config_doc = this.converter.getDOM(configFile);
|
---|
| 386 | if (config_doc == null) {
|
---|
| 387 | logger.error(" couldn't parse site config file: "+configFile.getPath());
|
---|
| 388 | return false;
|
---|
| 389 | }
|
---|
| 390 |
|
---|
| 391 | this.config_info = config_doc.getDocumentElement();
|
---|
| 392 |
|
---|
| 393 | // load up the services: serviceRackList
|
---|
[14210] | 394 | this.service_list = this.doc.createElement(GSXML.SERVICE_ELEM+GSXML.LIST_MODIFIER);
|
---|
[15191] | 395 | Element service_rack_list_elem = (Element)GSXML.getChildByTagName(config_info, GSXML.SERVICE_CLASS_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 396 | configureServices(service_rack_list_elem);
|
---|
[14210] | 397 |
|
---|
[15191] | 398 | // load up the service clusters
|
---|
| 399 | this.cluster_list = this.doc.createElement(GSXML.CLUSTER_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 400 | Element cluster_list_elem = (Element)GSXML.getChildByTagName(config_info, GSXML.CLUSTER_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 401 | configureClusters(cluster_list_elem);
|
---|
| 402 |
|
---|
| 403 | // load up the collections
|
---|
| 404 | this.collection_list = this.doc.createElement(GSXML.COLLECTION_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 405 | this.private_collection_list = this.doc.createElement(GSXML.COLLECTION_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 406 | this.oai_collection_list = this.doc.createElement(GSXML.COLLECTION_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 407 | configureCollections();
|
---|
| 408 |
|
---|
| 409 | // load up the external sites - this also adds their services/clusters/collections to the other lists - so must be done last
|
---|
| 410 | this.site_list = this.doc.createElement(GSXML.SITE_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 411 | Element site_list_elem = (Element)GSXML.getChildByTagName(config_info, GSXML.SITE_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 412 | configureExternalSites(site_list_elem);
|
---|
| 413 |
|
---|
| 414 | return true;
|
---|
| 415 |
|
---|
| 416 | }
|
---|
| 417 |
|
---|
| 418 | protected boolean configureServices(Element service_rack_list) {
|
---|
| 419 |
|
---|
| 420 |
|
---|
[14210] | 421 | // load up the individual services
|
---|
| 422 | logger.info("loading service modules...");
|
---|
| 423 |
|
---|
| 424 | if (service_rack_list == null) {
|
---|
| 425 | logger.info("... none to be loaded");
|
---|
| 426 | return true;
|
---|
[4096] | 427 | }
|
---|
| 428 |
|
---|
[14210] | 429 | NodeList service_racks = service_rack_list.getElementsByTagName(GSXML.SERVICE_CLASS_ELEM);
|
---|
| 430 | if (service_racks.getLength()==0) {
|
---|
| 431 | logger.info("... none to be loaded");
|
---|
| 432 | return true;
|
---|
[4096] | 433 | }
|
---|
| 434 |
|
---|
[14210] | 435 | Element service_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
| 436 | Element service_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, "", "", "");
|
---|
| 437 | service_message.appendChild(service_request);
|
---|
| 438 |
|
---|
| 439 | for(int i=0; i<service_racks.getLength(); i++) {
|
---|
| 440 | Element n = (Element)service_racks.item(i);
|
---|
| 441 | String service_name = n.getAttribute(GSXML.NAME_ATT);
|
---|
| 442 | logger.info("..."+service_name);
|
---|
[14399] | 443 |
|
---|
| 444 | Class service_class = null;
|
---|
[14210] | 445 | try {
|
---|
[15191] | 446 | service_class = Class.forName("org.greenstone.gsdl3.service."+service_name);
|
---|
[14399] | 447 | } catch(ClassNotFoundException e) {
|
---|
| 448 |
|
---|
[15191] | 449 | try {
|
---|
| 450 | //try the service_name alone in case the package name is already specified
|
---|
| 451 | service_class = Class.forName(service_name);
|
---|
[14399] | 452 |
|
---|
[15191] | 453 | }catch(ClassNotFoundException ae) {
|
---|
| 454 | logger.info(ae.getMessage());
|
---|
| 455 | }
|
---|
[14399] | 456 | }
|
---|
| 457 | try {
|
---|
| 458 |
|
---|
| 459 | ServiceRack s = (ServiceRack)service_class.newInstance();
|
---|
[14534] | 460 | s.setSiteHome(this.site_home);
|
---|
[14210] | 461 | s.setSiteAddress(this.site_http_address);
|
---|
[14534] | 462 | s.setLibraryName(this.library_name);
|
---|
[14210] | 463 | s.setMessageRouter(this);
|
---|
| 464 | // pass the XML node to the service for service configuration
|
---|
[15191] | 465 | if (!s.configure(n, null)) {
|
---|
| 466 | logger.error ("couldn't configure ServiceRack "+service_name);
|
---|
| 467 | continue;
|
---|
| 468 | }
|
---|
[14210] | 469 |
|
---|
| 470 | // find out the supported services for this service module
|
---|
| 471 | Element service_response = (Element) s.process(service_message);
|
---|
| 472 | NodeList services = service_response.getElementsByTagName(GSXML.SERVICE_ELEM);
|
---|
| 473 | if (services.getLength()==0) {
|
---|
| 474 | logger.error("MessageRouter configure error: serviceRack "+service_name+" has no services!");
|
---|
| 475 | } else {
|
---|
| 476 | for (int j=0; j<services.getLength();j++) {
|
---|
| 477 | String service = ((Element)services.item(j)).getAttribute(GSXML.NAME_ATT);
|
---|
| 478 | this.module_map.put(service, s);
|
---|
| 479 |
|
---|
| 480 | // add short info to service_list_ XML
|
---|
| 481 | this.service_list.appendChild(this.doc.importNode(services.item(j), true));
|
---|
| 482 | }
|
---|
| 483 | }
|
---|
| 484 | } catch (Exception e ) {
|
---|
| 485 | logger.error("MessageRouter configure exception: in ServiceRack class specification: "+ e.getMessage());
|
---|
| 486 | e.printStackTrace();
|
---|
| 487 | }
|
---|
| 488 | } // for each service module
|
---|
| 489 | return true;
|
---|
| 490 | }
|
---|
| 491 |
|
---|
| 492 | protected boolean configureClusters(Element config_cluster_list) {
|
---|
| 493 |
|
---|
| 494 | // load up the service clusters
|
---|
| 495 | logger.info("loading service clusters ...");
|
---|
| 496 | if (config_cluster_list == null) {
|
---|
| 497 | logger.info("... none to be loaded");
|
---|
| 498 | return true;
|
---|
[4096] | 499 | }
|
---|
[14210] | 500 | NodeList service_clusters = config_cluster_list.getElementsByTagName(GSXML.CLUSTER_ELEM);
|
---|
| 501 | if (service_clusters.getLength()==0) {
|
---|
| 502 | logger.info("... none to be loaded");
|
---|
| 503 | return true;
|
---|
[10292] | 504 | }
|
---|
| 505 |
|
---|
[14210] | 506 | for (int i=0; i<service_clusters.getLength(); i++) {
|
---|
| 507 | Element cluster = (Element)service_clusters.item(i);
|
---|
| 508 | String name = cluster.getAttribute(GSXML.NAME_ATT);
|
---|
| 509 | logger.info("..."+name);
|
---|
| 510 | ServiceCluster sc = new ServiceCluster();
|
---|
| 511 | sc.setSiteHome(this.site_home);
|
---|
| 512 | sc.setSiteAddress(this.site_http_address);
|
---|
| 513 | sc.setClusterName(name);
|
---|
| 514 | sc.setMessageRouter(this);
|
---|
[15191] | 515 | if (!sc.configure(cluster)) {
|
---|
| 516 | logger.error ("couldn't configure ServiceCluster "+name);
|
---|
| 517 | continue;
|
---|
| 518 | }
|
---|
| 519 |
|
---|
[14210] | 520 | this.module_map.put(name, sc); // this replaces the old one if there was one already present
|
---|
| 521 | //add short info to cluster list
|
---|
| 522 | Element e = this.doc.createElement(GSXML.CLUSTER_ELEM);
|
---|
| 523 | e.setAttribute(GSXML.NAME_ATT, name);
|
---|
| 524 | this.cluster_list.appendChild(e);
|
---|
| 525 |
|
---|
[3229] | 526 | }
|
---|
[14210] | 527 | return true;
|
---|
| 528 | }
|
---|
| 529 |
|
---|
[15191] | 530 | /** looks through the collect directory and activates any collections it finds. If this is a reconfigure, clean up must be done first before calling this */
|
---|
[14210] | 531 | protected boolean configureCollections() {
|
---|
[3512] | 532 |
|
---|
[14210] | 533 | // read thru the collect directory and activate all the valid collections
|
---|
| 534 | File collectDir = new File(GSFile.collectDir(this.site_home));
|
---|
| 535 | if (collectDir.exists()) {
|
---|
| 536 | logger.info("Reading thru directory "+collectDir.getPath()+" to find collections.");
|
---|
| 537 | File[] contents = collectDir.listFiles();
|
---|
| 538 | for (int i=0; i<contents.length;i++) {
|
---|
| 539 | if(contents[i].isDirectory()) {
|
---|
| 540 |
|
---|
| 541 | String colName = contents[i].getName();
|
---|
[14262] | 542 | if (!colName.startsWith("CVS") && !colName.startsWith(".svn")) {
|
---|
[14210] | 543 | activateCollectionByName(colName);
|
---|
| 544 | }
|
---|
| 545 | }
|
---|
| 546 | }
|
---|
| 547 | } // collectDir
|
---|
| 548 | return true;
|
---|
| 549 | }
|
---|
| 550 |
|
---|
[15191] | 551 | /** creates and configures a new collection
|
---|
| 552 | if this is done for a reconfigure, the collection should be deactivated first.
|
---|
| 553 | *
|
---|
| 554 | *@param col_name the name of the collection
|
---|
| 555 | *@return true if collection created ok
|
---|
| 556 | */
|
---|
| 557 | protected boolean activateCollectionByName(String col_name) {
|
---|
[14210] | 558 |
|
---|
[15191] | 559 | logger.info("Activating collection: "+col_name+".");
|
---|
| 560 |
|
---|
| 561 | // Look for the etc/collectionInit.xml file, and see what sort of Collection to load
|
---|
| 562 | Collection c = null;
|
---|
| 563 | File init_file = new File(GSFile.collectionInitFile(this.site_home, col_name));
|
---|
| 564 |
|
---|
| 565 | if (init_file.exists()) {
|
---|
| 566 | Document init_doc = this.converter.getDOM(init_file);
|
---|
| 567 | if (init_doc != null) {
|
---|
| 568 | Element init_elem = init_doc.getDocumentElement();
|
---|
| 569 | if (init_elem != null) {
|
---|
| 570 | String coll_class_name = init_elem.getAttribute("class");
|
---|
| 571 | if (!coll_class_name.equals("")) {
|
---|
| 572 | try {
|
---|
| 573 | c = (Collection)Class.forName("org.greenstone.gsdl3.collection."+coll_class_name).newInstance();
|
---|
| 574 | } catch (Exception e) {
|
---|
| 575 | logger.info(" couldn't create a new collection, type "+coll_class_name+", defaulting to class Collection");
|
---|
| 576 | }
|
---|
| 577 | }
|
---|
| 578 | }
|
---|
| 579 | }
|
---|
| 580 | }
|
---|
| 581 | if (c==null) { // we haven't found another classname to use
|
---|
| 582 | c = new Collection();
|
---|
| 583 | }
|
---|
| 584 |
|
---|
| 585 | c.setCollectionName(col_name);
|
---|
| 586 | c.setSiteHome(this.site_home);
|
---|
| 587 | c.setSiteAddress(this.site_http_address);
|
---|
| 588 | c.setMessageRouter(this);
|
---|
| 589 | if (c.configure()) {
|
---|
| 590 | logger.info("have just configured collection " + col_name);
|
---|
| 591 | // add to list of collections
|
---|
| 592 | this.module_map.put(col_name, c);
|
---|
| 593 | Element e = this.doc.createElement(GSXML.COLLECTION_ELEM);
|
---|
| 594 | e.setAttribute(GSXML.NAME_ATT, col_name);
|
---|
| 595 |
|
---|
| 596 | if(c.isPublic()) {
|
---|
| 597 | // only public collections will appear on the home page
|
---|
| 598 | // add short description_ to collection_list_
|
---|
| 599 | this.collection_list.appendChild(e);
|
---|
| 600 |
|
---|
| 601 | if (c.hasOAI()) {
|
---|
| 602 | Element ane = this.doc.createElement(GSXML.COLLECTION_ELEM);
|
---|
| 603 | //The collection name is returned as site_name:coll_name, which is in fact the set specification
|
---|
| 604 | ane.setAttribute(GSXML.NAME_ATT, site_name + ":" + col_name);
|
---|
| 605 | ane.setAttribute(OAIXML.LASTMODIFIED, "" + c.getLastmodified());
|
---|
| 606 |
|
---|
| 607 | this.oai_collection_list.appendChild(ane);
|
---|
| 608 | //logger.info(GSXML.xmlNodeToString(oai_collection_list));
|
---|
| 609 | }
|
---|
| 610 |
|
---|
| 611 | } else {
|
---|
| 612 | this.private_collection_list.appendChild(e);
|
---|
| 613 | }
|
---|
| 614 | return true;
|
---|
| 615 | } else {
|
---|
| 616 | logger.error("Couldn't configure collection: "+
|
---|
| 617 | col_name+".");
|
---|
| 618 | return false;
|
---|
| 619 | }
|
---|
| 620 | }
|
---|
| 621 |
|
---|
| 622 |
|
---|
| 623 | /** Goes through the siteList and activates each site found. If this is done for a reconfigure, a clean up must be done first ****HOW??? */
|
---|
| 624 | protected boolean configureExternalSites(Element config_site_list) {
|
---|
| 625 |
|
---|
[14210] | 626 | // load up the sites
|
---|
| 627 | logger.info("loading external sites...");
|
---|
| 628 | if (config_site_list ==null ) {
|
---|
| 629 | logger.info("...none found");
|
---|
| 630 | return true;
|
---|
[3229] | 631 | }
|
---|
[14210] | 632 |
|
---|
| 633 | NodeList sites = config_site_list.getElementsByTagName(GSXML.SITE_ELEM);
|
---|
| 634 | if (sites.getLength()==0) {
|
---|
| 635 | logger.info("...none found");
|
---|
| 636 | return true;
|
---|
[3229] | 637 | }
|
---|
[14210] | 638 |
|
---|
| 639 | // this is a name to identify the current site in the Communicator
|
---|
| 640 | String local_site_name = config_site_list.getAttribute(GSXML.LOCAL_SITE_NAME_ATT);
|
---|
| 641 | if (local_site_name.equals("")) {
|
---|
| 642 | local_site_name = site_name;
|
---|
[9914] | 643 | }
|
---|
| 644 |
|
---|
[14210] | 645 | for (int i=0; i<sites.getLength(); i++) {
|
---|
| 646 | Element s = (Element)sites.item(i);
|
---|
| 647 | activateSite(s, local_site_name);
|
---|
[4096] | 648 | }
|
---|
[14210] | 649 | return true;
|
---|
| 650 | }
|
---|
| 651 |
|
---|
[15191] | 652 | protected boolean activateSiteByName(String site_name) {
|
---|
| 653 | logger.info("Activating site: "+site_name+".");
|
---|
| 654 |
|
---|
| 655 | File configFile = new File(GSFile.siteConfigFile(this.site_home));
|
---|
| 656 |
|
---|
| 657 | if (!configFile.exists() ) {
|
---|
| 658 | logger.error(" site config file: "+configFile.getPath()+" not found!");
|
---|
| 659 | return false;
|
---|
| 660 | }
|
---|
| 661 | Document config_doc = this.converter.getDOM(configFile);
|
---|
| 662 | if (config_doc == null) {
|
---|
| 663 | logger.error(" couldn't parse site config file: "+configFile.getPath());
|
---|
| 664 | return false;
|
---|
| 665 | }
|
---|
| 666 | Element config_elem = config_doc.getDocumentElement();
|
---|
| 667 |
|
---|
| 668 | Element config_site_list = (Element)GSXML.getChildByTagName(config_elem, GSXML.SITE_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 669 | if (config_site_list ==null ) {
|
---|
| 670 | logger.error("activateSite, no sites found");
|
---|
| 671 | return false;
|
---|
| 672 | }
|
---|
| 673 | // this is a name to identify the current site in the Communicator
|
---|
| 674 | String local_site_name = config_site_list.getAttribute("localSiteName");
|
---|
| 675 | if (local_site_name.equals("")) {
|
---|
| 676 | local_site_name = site_name;
|
---|
| 677 | }
|
---|
| 678 |
|
---|
| 679 | Element this_site_elem = GSXML.getNamedElement(config_site_list, GSXML.SITE_ELEM, GSXML.NAME_ATT, site_name);
|
---|
| 680 | if (this_site_elem == null) {
|
---|
| 681 | logger.error("activateSite, site "+site_name+" not found");
|
---|
| 682 | return false;
|
---|
| 683 | }
|
---|
| 684 |
|
---|
| 685 | return activateSite(this_site_elem, local_site_name);
|
---|
| 686 | }
|
---|
| 687 |
|
---|
[14210] | 688 | protected boolean activateSite(Element site_elem, String local_site_name) {
|
---|
[15191] | 689 |
|
---|
[14210] | 690 | Communicator comm=null;
|
---|
| 691 | String type = site_elem.getAttribute(GSXML.TYPE_ATT);
|
---|
| 692 | String name = site_elem.getAttribute(GSXML.NAME_ATT);
|
---|
| 693 | if (type.equals(GSXML.COMM_TYPE_SOAP_JAVA)) {
|
---|
[15191] | 694 | logger.info("activating SOAP site "+name);
|
---|
[14210] | 695 | comm = new SOAPCommunicator();
|
---|
| 696 | if (comm.configure(site_elem)) {
|
---|
| 697 | comm.setLocalSiteName(local_site_name);
|
---|
| 698 |
|
---|
| 699 | // add to map of modules
|
---|
| 700 | this.module_map.put(name, comm);
|
---|
| 701 | this.site_list.appendChild(this.doc.importNode(site_elem, true));
|
---|
| 702 | // need to get collection list and service
|
---|
| 703 | // list from here- if the site isn't up yet, the site will
|
---|
| 704 | // have to be added later
|
---|
| 705 | if (!getRemoteSiteInfo(comm, name)) {
|
---|
[15191] | 706 | logger.error(" couldn't get info from site");
|
---|
[14210] | 707 | }
|
---|
| 708 | } else {
|
---|
[15191] | 709 | logger.error(" couldn't configure site");
|
---|
[14210] | 710 | return false;
|
---|
| 711 | }
|
---|
| 712 |
|
---|
| 713 | } else {
|
---|
| 714 | System.err.print(" cant talk to server of type:"+type + ", so not making a connection to "+name);
|
---|
| 715 | return false;
|
---|
| 716 | }
|
---|
| 717 | return true;
|
---|
| 718 | }
|
---|
| 719 |
|
---|
| 720 | /** get site info from external site
|
---|
| 721 | *
|
---|
| 722 | * @param comm - the communicator object for the external site
|
---|
| 723 | * @param site_name - the name of the external site
|
---|
| 724 | * @return true if successful
|
---|
| 725 | */
|
---|
| 726 | protected boolean getRemoteSiteInfo(Communicator comm, String site_name) {
|
---|
[9874] | 727 |
|
---|
[14210] | 728 | logger.info(" getting info from site:"+site_name);
|
---|
| 729 |
|
---|
| 730 | Element info_request = this.doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
| 731 | Element req = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, "", "", "");
|
---|
| 732 | info_request.appendChild(req);
|
---|
| 733 |
|
---|
| 734 | // process the message
|
---|
| 735 | Element info_response = comm.process(info_request);
|
---|
| 736 | if (info_response == null) {
|
---|
| 737 | return false;
|
---|
[4105] | 738 | }
|
---|
[14210] | 739 | // collection info
|
---|
| 740 | NodeList colls = info_response.getElementsByTagName(GSXML.COLLECTION_ELEM);
|
---|
| 741 | if (colls.getLength()>0) {
|
---|
| 742 | for (int i=0; i<colls.getLength(); i++) {
|
---|
| 743 | Element e = (Element)colls.item(i);
|
---|
| 744 | String col_name = e.getAttribute(GSXML.NAME_ATT);
|
---|
| 745 | // add the info to own coll list - may want to keep
|
---|
| 746 | // this separate in future - so can distinguish own and
|
---|
| 747 | // other collections ??
|
---|
| 748 | e.setAttribute(GSXML.NAME_ATT, GSPath.prependLink(col_name, site_name));
|
---|
| 749 | this.collection_list.appendChild(this.doc.importNode(e, true));
|
---|
| 750 | }
|
---|
| 751 | }
|
---|
[4105] | 752 |
|
---|
[14210] | 753 | // service info
|
---|
| 754 | NodeList services = info_response.getElementsByTagName(GSXML.SERVICE_ELEM);
|
---|
| 755 | if (services.getLength()>0) {
|
---|
| 756 | for (int i=0; i<services.getLength(); i++) {
|
---|
| 757 | Element e = (Element)services.item(i);
|
---|
| 758 | String serv_name = e.getAttribute(GSXML.NAME_ATT);
|
---|
| 759 | e.setAttribute(GSXML.NAME_ATT, GSPath.prependLink(serv_name, site_name));
|
---|
| 760 | this.service_list.appendChild(this.doc.importNode(e, true));
|
---|
| 761 | }
|
---|
[4096] | 762 | }
|
---|
[14210] | 763 |
|
---|
| 764 | // serviceCluster info
|
---|
| 765 | NodeList clusters = info_response.getElementsByTagName(GSXML.CLUSTER_ELEM);
|
---|
| 766 | if (clusters.getLength()>0) {
|
---|
| 767 | for (int i=0; i<clusters.getLength(); i++) {
|
---|
| 768 | Element e = (Element)clusters.item(i);
|
---|
| 769 | String clus_name = e.getAttribute(GSXML.NAME_ATT);
|
---|
| 770 | e.setAttribute(GSXML.NAME_ATT, GSPath.prependLink(clus_name, site_name));
|
---|
| 771 | this.cluster_list.appendChild(this.doc.importNode(e, true));
|
---|
| 772 | }
|
---|
[4096] | 773 | }
|
---|
[14210] | 774 | return true;
|
---|
| 775 | }
|
---|
| 776 |
|
---|
| 777 |
|
---|
[15191] | 778 |
|
---|
| 779 | protected boolean activateServiceClusterByName(String cluster_name) {
|
---|
| 780 | return false;
|
---|
| 781 |
|
---|
| 782 | }
|
---|
| 783 |
|
---|
| 784 | protected boolean activateServiceRackByName(String module_name) {
|
---|
| 785 | return false;
|
---|
| 786 | }
|
---|
| 787 |
|
---|
| 788 | protected boolean deactivateModule(String type, String name) {
|
---|
| 789 |
|
---|
| 790 | logger.info("deactivating "+ type+" module: "+name);
|
---|
| 791 | if (this.module_map.containsKey(name)) {
|
---|
| 792 |
|
---|
| 793 | logger.info("found the module");
|
---|
| 794 | ModuleInterface m = (ModuleInterface)this.module_map.remove(name);
|
---|
| 795 | // also remove the xml bit from description list
|
---|
| 796 | if (type.equals(GSXML.COLLECTION_ELEM)) {
|
---|
| 797 | if (((Collection)m).isPublic()) {
|
---|
| 798 | Element this_col = GSXML.getNamedElement(this.collection_list, GSXML.COLLECTION_ELEM, GSXML.NAME_ATT, name);
|
---|
| 799 | if (this_col != null) {
|
---|
| 800 | this.collection_list.removeChild(this_col);
|
---|
| 801 | }
|
---|
| 802 | if (((Collection)m).hasOAI()) {
|
---|
| 803 | this_col = GSXML.getNamedElement(this.oai_collection_list, GSXML.COLLECTION_ELEM, GSXML.NAME_ATT, name);
|
---|
| 804 | if (this_col != null) {
|
---|
| 805 | this.oai_collection_list.removeChild(this_col);
|
---|
| 806 | }
|
---|
| 807 | }
|
---|
| 808 | } else {
|
---|
| 809 | // a private collection
|
---|
| 810 | Element this_col = GSXML.getNamedElement(this.private_collection_list, GSXML.COLLECTION_ELEM, GSXML.NAME_ATT, name);
|
---|
| 811 | if (this_col != null) {
|
---|
| 812 | this.private_collection_list.removeChild(this_col);
|
---|
| 813 | }
|
---|
| 814 | }
|
---|
| 815 | } else if (type.equals(GSXML.SERVICE_ELEM)) {
|
---|
| 816 | Element this_service = GSXML.getNamedElement(this.service_list, GSXML.SERVICE_ELEM, GSXML.NAME_ATT, name);
|
---|
| 817 | if (this_service != null) {
|
---|
| 818 | this.service_list.removeChild(this_service);
|
---|
| 819 | }
|
---|
| 820 | } else if (type.equals(GSXML.CLUSTER_ELEM)) {
|
---|
| 821 | Element this_cluster = GSXML.getNamedElement(this.cluster_list, GSXML.CLUSTER_ELEM, GSXML.NAME_ATT, name);
|
---|
| 822 | if (this_cluster != null) {
|
---|
| 823 | this.cluster_list.removeChild(this_cluster);
|
---|
| 824 | }
|
---|
| 825 | } else if (type.equals(GSXML.SITE_ELEM)) {
|
---|
| 826 | Element this_site = GSXML.getNamedElement(this.site_list, GSXML.SITE_ELEM, GSXML.NAME_ATT, name);
|
---|
| 827 | if (this_site != null) {
|
---|
| 828 | this.site_list.removeChild(this_site);
|
---|
| 829 |
|
---|
| 830 | // also remove this sites colls, services, clusters etc
|
---|
| 831 | cleanUpModuleMapSubset(this.collection_list, name);
|
---|
| 832 | cleanUpModuleMapSubset(this.cluster_list, name);
|
---|
| 833 | cleanUpModuleMapSubset(this.service_list, name);
|
---|
| 834 |
|
---|
| 835 | // can remote collections be in the oai_coll list, or private coll list ??
|
---|
| 836 | }
|
---|
| 837 | } else {
|
---|
| 838 | logger.error("invalid module type: "+type+", can't remove info about this module");
|
---|
| 839 | }
|
---|
| 840 |
|
---|
| 841 | m.cleanUp(); // clean up any open files/connections etc - can cause trouble on windows
|
---|
| 842 | m=null;
|
---|
| 843 | return true;
|
---|
| 844 | }
|
---|
| 845 | // else not deactivated
|
---|
| 846 | logger.error(name+" module not found");
|
---|
| 847 | return false;
|
---|
| 848 |
|
---|
| 849 | }
|
---|
| 850 |
|
---|
[14210] | 851 | //*****************************************************************
|
---|
| 852 | // auxiliary process methods
|
---|
| 853 | //*****************************************************************
|
---|
| 854 |
|
---|
| 855 | /** handles requests made to the MessageRouter itself
|
---|
| 856 | *
|
---|
| 857 | * @param req - the request Element- <request>
|
---|
| 858 | * @return the result Element - should be <response>
|
---|
| 859 | */
|
---|
| 860 | protected Element processMessage(Element req) {
|
---|
| 861 |
|
---|
| 862 | // message for self, should be type=describe/configure at this stage
|
---|
| 863 | String type = req.getAttribute(GSXML.TYPE_ATT);
|
---|
| 864 | Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
|
---|
| 865 | response.setAttribute(GSXML.FROM_ATT, "");
|
---|
| 866 | if (type.equals(GSXML.REQUEST_TYPE_DESCRIBE)) {
|
---|
| 867 | response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_DESCRIBE);
|
---|
| 868 | // check the param list
|
---|
| 869 | Element param_list = (Element) GSXML.getChildByTagName(req, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
|
---|
| 870 | if (param_list == null) {
|
---|
| 871 | response.appendChild(this.collection_list);
|
---|
| 872 | response.appendChild(this.cluster_list);
|
---|
| 873 | response.appendChild(this.site_list);
|
---|
| 874 | response.appendChild(this.service_list);
|
---|
| 875 | return response;
|
---|
| 876 | }
|
---|
| 877 | NodeList params = param_list.getElementsByTagName(GSXML.PARAM_ELEM);
|
---|
| 878 |
|
---|
| 879 | // go through the param list and see what components are wanted
|
---|
| 880 | for (int i=0; i<params.getLength(); i++) {
|
---|
| 881 |
|
---|
| 882 | Element param = (Element)params.item(i);
|
---|
| 883 | // Identify the structure information desired
|
---|
| 884 | if (param.getAttribute(GSXML.NAME_ATT).equals(GSXML.SUBSET_PARAM)) {
|
---|
| 885 | String info = param.getAttribute(GSXML.VALUE_ATT);
|
---|
| 886 | if (info.equals(GSXML.COLLECTION_ELEM+GSXML.LIST_MODIFIER)) {
|
---|
| 887 | response.appendChild(this.collection_list);
|
---|
| 888 |
|
---|
| 889 | } else if (info.equals(GSXML.CLUSTER_ELEM+GSXML.LIST_MODIFIER)) {
|
---|
| 890 | response.appendChild(this.cluster_list);
|
---|
| 891 |
|
---|
| 892 | } else if (info.equals(GSXML.SERVICE_ELEM+GSXML.LIST_MODIFIER)) {
|
---|
| 893 | response.appendChild(this.service_list);
|
---|
| 894 | } else if (info.equals(GSXML.SITE_ELEM+GSXML.LIST_MODIFIER)) {
|
---|
| 895 | response.appendChild(this.site_list);
|
---|
| 896 | }
|
---|
| 897 | }
|
---|
| 898 | }
|
---|
| 899 | return response;
|
---|
| 900 |
|
---|
[3485] | 901 | }
|
---|
[15191] | 902 |
|
---|
| 903 | if (type.equals(OAIXML.OAI_SET_LIST)) {
|
---|
| 904 | logger.info("oaiSetList request received");
|
---|
| 905 | //this is the oai receptionist asking for a list of oai-support collections
|
---|
| 906 | response.setAttribute(GSXML.TYPE_ATT, OAIXML.OAI_SET_LIST );
|
---|
| 907 | response.appendChild(this.oai_collection_list);
|
---|
| 908 | return response;
|
---|
| 909 | }
|
---|
| 910 |
|
---|
| 911 |
|
---|
[14210] | 912 | if (type.equals(GSXML.REQUEST_TYPE_SYSTEM)) {
|
---|
| 913 |
|
---|
| 914 | // a list of system requests - should put any error messages
|
---|
| 915 | // or success messages into response
|
---|
| 916 | NodeList commands = req.getElementsByTagName(GSXML.SYSTEM_ELEM);
|
---|
| 917 | Element site_config_elem = null;
|
---|
| 918 | boolean success = false;
|
---|
| 919 |
|
---|
| 920 | for (int i=0; i<commands.getLength(); i++) {
|
---|
| 921 | // all the commands should be Elements
|
---|
| 922 | Element elem = (Element)commands.item(i);
|
---|
| 923 | String action = elem.getAttribute(GSXML.TYPE_ATT);
|
---|
| 924 | if (action.equals(GSXML.SYSTEM_TYPE_CONFIGURE)) {
|
---|
| 925 | String subset = elem.getAttribute(GSXML.SYSTEM_SUBSET_ATT);
|
---|
| 926 | if (subset.equals("")) {
|
---|
| 927 | // need to reconfigure the MR
|
---|
[15191] | 928 | this.configureLocalSite();
|
---|
[14210] | 929 | Element s = GSXML.createTextElement(this.doc, GSXML.STATUS_ELEM, "MessageRouter reconfigured successfully");
|
---|
| 930 | response.appendChild(s);
|
---|
| 931 |
|
---|
| 932 | } else {
|
---|
| 933 | // else it a specific request
|
---|
| 934 | if (subset.equals(GSXML.COLLECTION_ELEM+GSXML.LIST_MODIFIER)) {
|
---|
[15191] | 935 | // get rid of all the old collection stuff (not counting remote ones) before activating all the new ones
|
---|
| 936 | cleanUpModuleMapSubset(this.collection_list, null);
|
---|
| 937 | cleanUpModuleMapSubset(this.private_collection_list, null);
|
---|
[14210] | 938 | success = configureCollections();
|
---|
| 939 | } else {
|
---|
| 940 |
|
---|
| 941 | // need the site config file
|
---|
| 942 | if (site_config_elem==null) {
|
---|
| 943 |
|
---|
| 944 | File configFile = new File(GSFile.siteConfigFile(this.site_home));
|
---|
| 945 | if (!configFile.exists() ) {
|
---|
| 946 | logger.error(" site config file: "+configFile.getPath()+" not found!");
|
---|
| 947 | continue;
|
---|
| 948 | }
|
---|
| 949 | Document site_config_doc = this.converter.getDOM(configFile);
|
---|
| 950 | if (site_config_doc == null) {
|
---|
| 951 | logger.error(" couldn't parse site config file: "+configFile.getPath());
|
---|
| 952 | continue;
|
---|
| 953 | }
|
---|
| 954 | site_config_elem = site_config_doc.getDocumentElement();
|
---|
| 955 | }
|
---|
| 956 | if (subset.equals(GSXML.SERVICE_ELEM+GSXML.LIST_MODIFIER)) {
|
---|
| 957 | Element service_rack_list = (Element)GSXML.getChildByTagName(site_config_elem, GSXML.SERVICE_CLASS_ELEM+GSXML.LIST_MODIFIER);
|
---|
[15191] | 958 | cleanUpModuleMapSubset(this.service_list, null);
|
---|
[14210] | 959 | success = configureServices(service_rack_list);
|
---|
| 960 | } else if (subset.equals(GSXML.CLUSTER_ELEM+GSXML.LIST_MODIFIER)) {
|
---|
| 961 | Element cluster_list = (Element)GSXML.getChildByTagName(site_config_elem, GSXML.CLUSTER_ELEM+GSXML.LIST_MODIFIER);
|
---|
[15191] | 962 | cleanUpModuleMapSubset(this.cluster_list, null);
|
---|
[14210] | 963 | success = configureClusters(cluster_list);
|
---|
| 964 | } else if (subset.equals(GSXML.SITE_ELEM+GSXML.LIST_MODIFIER)) {
|
---|
| 965 | Element site_list = (Element)GSXML.getChildByTagName(site_config_elem, GSXML.SITE_ELEM+GSXML.LIST_MODIFIER);
|
---|
[15191] | 966 | cleanUpAllExternalSiteInfo();
|
---|
| 967 | success = configureExternalSites(site_list);
|
---|
[14210] | 968 | }
|
---|
| 969 | }
|
---|
| 970 | String message=null;
|
---|
| 971 | if (success) {
|
---|
| 972 | message = subset + "reconfigured successfully";
|
---|
| 973 | } else {
|
---|
| 974 | message = "Error in reconfiguring "+subset;
|
---|
| 975 | }
|
---|
| 976 | Element s = GSXML.createTextElement(this.doc, GSXML.STATUS_ELEM, message);
|
---|
| 977 | response.appendChild(s);
|
---|
| 978 | }
|
---|
| 979 |
|
---|
| 980 |
|
---|
| 981 | } else {
|
---|
| 982 | String module_name = elem.getAttribute(GSXML.SYSTEM_MODULE_NAME_ATT);
|
---|
| 983 | String module_type = elem.getAttribute(GSXML.SYSTEM_MODULE_TYPE_ATT);
|
---|
| 984 |
|
---|
| 985 | if (action.equals(GSXML.SYSTEM_TYPE_DEACTIVATE)) {
|
---|
[15191] | 986 | success = deactivateModule(module_type, module_name);
|
---|
| 987 | if (success) {
|
---|
| 988 | Element s = GSXML.createTextElement(this.doc, GSXML.STATUS_ELEM, module_type+": "+module_name+" deactivated");
|
---|
| 989 | response.appendChild(s);
|
---|
| 990 | } else {
|
---|
| 991 | Element s = GSXML.createTextElement(this.doc, GSXML.STATUS_ELEM, module_type+": "+module_name+" could not be deactivated");
|
---|
| 992 | response.appendChild(s);
|
---|
| 993 | }
|
---|
| 994 |
|
---|
[14210] | 995 | } else if (action.equals(GSXML.SYSTEM_TYPE_ACTIVATE)) {
|
---|
[15191] | 996 | // we need to deactivate the module first, in case this is a
|
---|
| 997 | // reconfigure
|
---|
| 998 | deactivateModule(module_type, module_name);
|
---|
[14210] | 999 | if (module_type.equals(GSXML.COLLECTION_ELEM)) {
|
---|
| 1000 | success = activateCollectionByName(module_name);
|
---|
| 1001 | } else if (module_type.equals(GSXML.SITE_ELEM)) {
|
---|
| 1002 | success = activateSiteByName(module_name);
|
---|
| 1003 | } else if (module_type.equals(GSXML.CLUSTER_ELEM)) {
|
---|
| 1004 | success = activateServiceClusterByName(module_name);
|
---|
| 1005 | }
|
---|
| 1006 | if (success) {
|
---|
| 1007 | Element s = GSXML.createTextElement(this.doc, GSXML.STATUS_ELEM, module_type+": "+module_name+" activated");
|
---|
| 1008 | response.appendChild(s);
|
---|
| 1009 | } else {
|
---|
| 1010 | Element s = GSXML.createTextElement(this.doc, GSXML.STATUS_ELEM, module_type+": "+module_name+" could not be activated");
|
---|
| 1011 | response.appendChild(s);
|
---|
| 1012 | }
|
---|
| 1013 | }
|
---|
| 1014 | } // else not a configure action
|
---|
| 1015 | } // for all commands
|
---|
| 1016 | return response;
|
---|
| 1017 |
|
---|
| 1018 |
|
---|
| 1019 | } // system type request
|
---|
| 1020 |
|
---|
| 1021 | // if get here something has gone wrong
|
---|
| 1022 | logger.error(" cant process request:");
|
---|
| 1023 | logger.error(this.converter.getString(req));
|
---|
| 1024 | return null;
|
---|
| 1025 |
|
---|
| 1026 | }
|
---|
[15191] | 1027 |
|
---|
| 1028 | //* Used to copy nodes from one message to another. E.g. copy a response node to the next request. Not sure if this is actually used anywhere yet... */
|
---|
| 1029 |
|
---|
[14210] | 1030 | protected Element modifyMessages(Element request, Element message, Element result) {
|
---|
| 1031 | Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
|
---|
| 1032 | response.setAttribute(GSXML.FROM_ATT, "");
|
---|
| 1033 | response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_MESSAGING);
|
---|
| 1034 |
|
---|
| 1035 | NodeList commands = request.getElementsByTagName("command");
|
---|
| 1036 | if (commands == null) {
|
---|
| 1037 | logger.error("no commands, "+converter.getPrettyString(request));
|
---|
| 1038 | return response;
|
---|
[4105] | 1039 | }
|
---|
[14210] | 1040 | for (int i=0; i<commands.getLength(); i++) {
|
---|
| 1041 | Element action = (Element)commands.item(i);
|
---|
| 1042 | String type = action.getAttribute(GSXML.TYPE_ATT);
|
---|
| 1043 | if (type.equals("copyNode")) {
|
---|
| 1044 | // copies the from node as a child of to node
|
---|
| 1045 | String from_path = action.getAttribute("from");
|
---|
| 1046 | String to_path = action.getAttribute("to");
|
---|
| 1047 | Element from_node = null;
|
---|
| 1048 | String from_node_root = GSPath.getFirstLink(from_path);
|
---|
| 1049 | if (from_node_root.startsWith(GSXML.REQUEST_ELEM)) {
|
---|
| 1050 | from_node = message;
|
---|
| 1051 | } else if (from_node_root.startsWith(GSXML.RESPONSE_ELEM)) {
|
---|
| 1052 | from_node = result;
|
---|
| 1053 | }
|
---|
| 1054 | if (from_node == null) {
|
---|
| 1055 | continue;
|
---|
| 1056 | }
|
---|
| 1057 | Element to_node = null;
|
---|
| 1058 | String to_node_root = GSPath.getFirstLink(to_path);
|
---|
| 1059 | if (to_node_root.startsWith(GSXML.REQUEST_ELEM)) {
|
---|
| 1060 | to_node = message;
|
---|
| 1061 | } else if (to_node_root.startsWith(GSXML.RESPONSE_ELEM)) {
|
---|
| 1062 | to_node = result;
|
---|
| 1063 | }
|
---|
| 1064 | if (to_node == null) {
|
---|
| 1065 | continue;
|
---|
| 1066 | }
|
---|
| 1067 | // now we know what node to copy where
|
---|
| 1068 | Node orig_node = GSXML.getNodeByPathIndexed(from_node, from_path);
|
---|
| 1069 | if (orig_node == null) {
|
---|
| 1070 | continue;
|
---|
| 1071 | }
|
---|
| 1072 | Node new_parent = GSXML.getNodeByPathIndexed(to_node, to_path);
|
---|
| 1073 | if (new_parent == null) {
|
---|
| 1074 | continue;
|
---|
| 1075 |
|
---|
| 1076 | }
|
---|
| 1077 | new_parent.appendChild(to_node.getOwnerDocument().importNode(orig_node, true));
|
---|
| 1078 | }
|
---|
| 1079 |
|
---|
| 1080 | else if (type.equals("copyChildren")) {
|
---|
| 1081 |
|
---|
| 1082 | }
|
---|
| 1083 | } // for each command
|
---|
| 1084 | return response;
|
---|
| 1085 | }
|
---|
| 1086 |
|
---|
| 1087 | // ****************************************************
|
---|
| 1088 | // other methods
|
---|
| 1089 | // ****************************************************
|
---|
| 1090 |
|
---|
[15191] | 1091 |
|
---|
[14210] | 1092 |
|
---|
[3229] | 1093 | }
|
---|
[3485] | 1094 |
|
---|
| 1095 |
|
---|