opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/jmx/TransactionJMXRegistrator.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.config.manager.impl.jmx;
   9
  10 import java.io.Closeable;
  11 import java.util.Set;
  12 import javax.management.InstanceAlreadyExistsException;
  13 import javax.management.ObjectName;
  14 import javax.management.QueryExp;
  15 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
  16 import org.opendaylight.controller.config.manager.impl.jmx.InternalJMXRegistrator.InternalJMXRegistration;
  17
  18 /**
  19  * Contains constraints on passed {@link ObjectName} parameters. Only allow (un)
  20  * registration of ObjectNames that have expected transaction name.
  21  */
  22 public class TransactionJMXRegistrator implements Closeable {
  23     private final InternalJMXRegistrator childJMXRegistrator;
  24     private final String transactionName;
  25
  26     TransactionJMXRegistrator(InternalJMXRegistrator internalJMXRegistrator,
  27                               String transactionName) {
  28         this.childJMXRegistrator = internalJMXRegistrator.createChild();
  29         this.transactionName = transactionName;
  30     }
  31
  32     public static class TransactionJMXRegistration implements AutoCloseable {
  33         private final InternalJMXRegistration registration;
  34
  35         TransactionJMXRegistration(InternalJMXRegistration registration) {
  36             this.registration = registration;
  37         }
  38
  39         @Override
  40         public void close() {
  41             registration.close();
  42         }
  43     }
  44
  45     public TransactionJMXRegistration registerMBean(Object object, ObjectName on)
  46             throws InstanceAlreadyExistsException {
  47         if (!transactionName.equals(ObjectNameUtil.getTransactionName(on))) {
  48             throw new IllegalArgumentException(
  49                     "Transaction name mismatch between expected "
  50                             + transactionName + " " + "and " + on);
  51         }
  52         ObjectNameUtil.checkType(on, ObjectNameUtil.TYPE_CONFIG_TRANSACTION);
  53         return new TransactionJMXRegistration(
  54                 childJMXRegistrator.registerMBean(object, on));
  55     }
  56
  57     public Set<ObjectName> queryNames(ObjectName name, QueryExp query) {
  58         return childJMXRegistrator.queryNames(name, query);
  59     }
  60
  61     public TransactionModuleJMXRegistrator createTransactionModuleJMXRegistrator() {
  62         return new TransactionModuleJMXRegistrator(childJMXRegistrator,
  63                 transactionName);
  64     }
  65
  66     @Override
  67     public void close() { // closes also all child TransactionModuleJMXRegistrator instances
  68         childJMXRegistrator.close();
  69     }
  70 }