org.opendaylight.controller.config.api.jmx

Class ObjectNameUtil

java.lang.Object

org.opendaylight.controller.config.api.jmx.ObjectNameUtil

@ThreadSafe
public final class ObjectNameUtil
extends Object

Provides ObjectName creation. Each created ObjectName consists of domain that is defined as ON_DOMAIN and at least one key-value pair. The only mandatory property is TYPE_KEY. All transaction related mbeans have TRANSACTION_NAME_KEY property set.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INSTANCE_NAME_KEY
static String	MODULE_FACTORY_NAME_KEY
static String	ON_DOMAIN
static String	ON_WILDCARD
static String	REF_NAME_KEY
static String	SERVICE_QNAME_KEY
static String	TRANSACTION_NAME_KEY
static String	TYPE_CONFIG_TRANSACTION
static String	TYPE_KEY
static String	TYPE_MODULE
static String	TYPE_RUNTIME_BEAN
static String	TYPE_SERVICE_REFERENCE

Method Summary

Modifier and Type	Method and Description
static void	checkDomain(ObjectName objectName)
static void	checkType(ObjectName objectName, String type)
static void	checkTypeOneOf(ObjectName objectName, String... types)
static ObjectName	createModulePattern(String moduleName, String instanceName)
static ObjectName	createModulePattern(String ifcName, String instanceName, String transactionName)
static ObjectName	createON(String on)
static ObjectName	createON(String domain, Map<String,String> attribs)
static ObjectName	createON(String name, String key, String value)
static ObjectName	createONWithDomainAndType(String type)
static ObjectName	createReadOnlyModuleON(ModuleIdentifier moduleIdentifier)
static ObjectName	createReadOnlyModuleON(String moduleName, String instanceName)
static ObjectName	createReadOnlyServiceON(String serviceQName, String refName)
static ObjectName	createRuntimeBeanName(String moduleName, String instanceName, Map<String,String> additionalProperties)
static ObjectName	createRuntimeBeanPattern(String moduleName, String instanceName)
static ObjectName	createTransactionControllerON(String transactionName)
static ObjectName	createTransactionModuleON(String transactionName, ModuleIdentifier moduleIdentifier)
static ObjectName	createTransactionModuleON(String transactionName, ObjectName on)
static ObjectName	createTransactionModuleON(String transactionName, String moduleName, String instanceName)
static ObjectName	createTransactionServiceON(String transactionName, String serviceQName, String refName)
static ModuleIdentifier	fromON(ObjectName objectName, String expectedType)
static Map<String,String>	getAdditionalProperties(ObjectName on)
static Map<String,String>	getAdditionalPropertiesOfRuntimeBeanName(ObjectName on)
static String	getFactoryName(ObjectName objectName)
static String	getInstanceName(ObjectName objectName)
static String	getReferenceName(ObjectName objectName)
static String	getServiceQName(ObjectName objectName)
static String	getTransactionName(ObjectName objectName)
static boolean	isServiceReference(ObjectName objectName)
static ObjectName	withoutTransactionName(ObjectName inputON) Sanitize on: keep only mandatory attributes of module + metadata.
static ObjectName	withTransactionName(ObjectName inputON, String transactionName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ON_DOMAIN

public static final String ON_DOMAIN

See Also:

Constant Field Values

MODULE_FACTORY_NAME_KEY

public static final String MODULE_FACTORY_NAME_KEY

See Also:

Constant Field Values

SERVICE_QNAME_KEY

public static final String SERVICE_QNAME_KEY

See Also:

Constant Field Values

INSTANCE_NAME_KEY

public static final String INSTANCE_NAME_KEY

See Also:

Constant Field Values

TYPE_KEY

public static final String TYPE_KEY

See Also:

Constant Field Values

TYPE_CONFIG_TRANSACTION

public static final String TYPE_CONFIG_TRANSACTION

See Also:

Constant Field Values

TYPE_MODULE

public static final String TYPE_MODULE

See Also:

Constant Field Values

TYPE_SERVICE_REFERENCE

public static final String TYPE_SERVICE_REFERENCE

See Also:

Constant Field Values

TYPE_RUNTIME_BEAN

public static final String TYPE_RUNTIME_BEAN

See Also:

Constant Field Values

TRANSACTION_NAME_KEY

public static final String TRANSACTION_NAME_KEY

See Also:

Constant Field Values

REF_NAME_KEY

public static final String REF_NAME_KEY

See Also:

Constant Field Values

ON_WILDCARD

public static final String ON_WILDCARD

See Also:

Constant Field Values

Method Detail

createON

public static ObjectName createON(String on)

createON

public static ObjectName createON(String name,
                                  String key,
                                  String value)

createON

public static ObjectName createON(String domain,
                                  Map<String,String> attribs)

createONWithDomainAndType

public static ObjectName createONWithDomainAndType(String type)

createTransactionControllerON

public static ObjectName createTransactionControllerON(String transactionName)

createTransactionModuleON

public static ObjectName createTransactionModuleON(String transactionName,
                                                   ModuleIdentifier moduleIdentifier)

createTransactionModuleON

public static ObjectName createTransactionModuleON(String transactionName,
                                                   String moduleName,
                                                   String instanceName)

createTransactionModuleON

public static ObjectName createTransactionModuleON(String transactionName,
                                                   ObjectName on)

createReadOnlyModuleON

public static ObjectName createReadOnlyModuleON(ModuleIdentifier moduleIdentifier)

createReadOnlyModuleON

public static ObjectName createReadOnlyModuleON(String moduleName,
                                                String instanceName)

createReadOnlyServiceON

public static ObjectName createReadOnlyServiceON(String serviceQName,
                                                 String refName)

createTransactionServiceON

public static ObjectName createTransactionServiceON(String transactionName,
                                                    String serviceQName,
                                                    String refName)

getServiceQName

public static String getServiceQName(ObjectName objectName)

getReferenceName

public static String getReferenceName(ObjectName objectName)

getFactoryName

public static String getFactoryName(ObjectName objectName)

getInstanceName

public static String getInstanceName(ObjectName objectName)

getTransactionName

public static String getTransactionName(ObjectName objectName)

withoutTransactionName

public static ObjectName withoutTransactionName(ObjectName inputON)

Sanitize on: keep only mandatory attributes of module + metadata.

withTransactionName

public static ObjectName withTransactionName(ObjectName inputON,
                                             String transactionName)

createRuntimeBeanName

public static ObjectName createRuntimeBeanName(String moduleName,
                                               String instanceName,
                                               Map<String,String> additionalProperties)

getAdditionalPropertiesOfRuntimeBeanName

public static Map<String,String> getAdditionalPropertiesOfRuntimeBeanName(ObjectName on)

getAdditionalProperties

public static Map<String,String> getAdditionalProperties(ObjectName on)

checkDomain

public static void checkDomain(ObjectName objectName)

checkType

public static void checkType(ObjectName objectName,
                             String type)

checkTypeOneOf

public static void checkTypeOneOf(ObjectName objectName,
                                  String... types)

createModulePattern

public static ObjectName createModulePattern(String moduleName,
                                             String instanceName)

createModulePattern

public static ObjectName createModulePattern(String ifcName,
                                             String instanceName,
                                             String transactionName)

createRuntimeBeanPattern

public static ObjectName createRuntimeBeanPattern(String moduleName,
                                                  String instanceName)

fromON

public static ModuleIdentifier fromON(ObjectName objectName,
                                      String expectedType)

isServiceReference

public static boolean isServiceReference(ObjectName objectName)