File	Doc	Category	Size	Date	Package
ObjectName.java	API Doc	Java SE 5 API	68086	Fri Aug 26 14:57:34 BST 2005	javax.management

ObjectName

• java.lang.Object

domain: key1 = value1 , key2 = value2

Fields Summary
private static final long	oldSerialVersionUID
private static final long	newSerialVersionUID
private static final ObjectStreamField[]	oldSerialPersistentFields
private static final ObjectStreamField[]	newSerialPersistentFields
private static final long	serialVersionUID
private static final ObjectStreamField[]	serialPersistentFields
private static boolean	compat
private static final Property[]	_Empty_property_array a shared empty array for empty property lists
private static final Hashtable	_EmptyPropertyList a shared empty hashtable for empty property lists
private transient String	_canonicalName a String containing the canonical name
private transient Property[]	_kp_array An array of properties in the same seq order as time creation
private transient Property[]	_ca_array An array of properties in the same seq order as canonical order
private transient int	_domain_length The length of the domain part of built objectname
private transient Hashtable	_propertyList The propertyList of built object name. Initialized lazily. Table that contains all the pairs (key,value) for this ObjectName.
private transient boolean	_domain_pattern boolean that declares if this ObjectName domain part is a pattern
private transient boolean	_property_pattern boolean that declares if this ObjectName contains a pattern on the key property list

Constructors Summary
public ObjectName(String name) Construct an object name from the given string. param name A string representation of the object name. exception MalformedObjectNameException The string passed as a parameter does not have the right format. exception NullPointerException The name parameter is null. construct(name);
public ObjectName(String domain, String key, String value) Construct an object name with exactly one key property. param domain The domain part of the object name. param key The attribute in the key property of the object name. param value The value in the key property of the object name. exception MalformedObjectNameException The domain, key, or value contains an illegal character, or value does not follow the rules for quoting. exception NullPointerException One of the parameters is null. // If key or value are null a NullPointerException // will be thrown by the put method in Hashtable. // Hashtable table = new Hashtable(1); table.put(key, value); construct(domain, table);
public ObjectName(String domain, Hashtable table) Construct an object name with several key properties from a Hashtable. param domain The domain part of the object name. param table A hash table containing one or more key properties. The key of each entry in the table is the key of a key property in the object name. The associated value in the table is the associated value in the object name. exception MalformedObjectNameException The domain contains an illegal character, or one of the keys or values in table contains an illegal character, or one of the values in table does not follow the rules for quoting. exception NullPointerException One of the parameters is null. construct(domain, table);

Methods Summary
private final java.util.Hashtable	_getKeyPropertyList() Returns the key properties as a Hashtable. The returned value is a Hashtable in which each key is a key in the ObjectName's key property list and each value is the associated value. The returned value must not be modidied. return The table of key properties. synchronized (this) { if (_propertyList == null) { // build (lazy eval) the property list from the canonical // properties array _propertyList = new Hashtable(); int len = _ca_array.length; Property prop; for (int i = len - 1; i >= 0; i--) { prop = _ca_array[i]; _propertyList.put(prop.getKeyString(_canonicalName), prop.getValueString(_canonicalName)); } } } return _propertyList;
private void	addProperty(javax.management.ObjectName$Property prop, int index, java.util.HashMap keys_map, java.lang.String key_name) Add passed property to the list at the given index for the passed key name if (keys_map.containsKey(key_name)) throw new MalformedObjectNameException("key `" + key_name +"' already defined"); // if no more space for property arrays, have to increase it if (index == _kp_array.length) { Property[] tmp_prop_array = new Property[index + 10]; System.arraycopy(_kp_array, 0, tmp_prop_array, 0, index); _kp_array = tmp_prop_array; } _kp_array[index] = prop; keys_map.put(key_name, prop);
public boolean	apply(javax.management.ObjectName name) Test whether this ObjectName, which may be a pattern, matches another ObjectName. If name is a pattern, the result is false. If this ObjectName is a pattern, the result is true if and only if name matches the pattern. If neither this ObjectName nor name is a pattern, the result is true if and only if the two ObjectNames are equal as described for the {@link #equals(Object)} method. param name The name of the MBean to compare to. return True if name matches this ObjectName. exception NullPointerException if name is null. since.unbundled JMX 1.2 if (name == null) throw new NullPointerException(); if (name._domain_pattern || name._property_pattern) return false; // No pattern if (!_domain_pattern && !_property_pattern) return _canonicalName.equals(name._canonicalName); return matchDomains(name) && matchKeys(name);
private java.lang.String	checkKey(java.lang.String key) Check if the key given in parameter in the first constructor is a valid key. if (key == null) throw new MalformedObjectNameException("Invalid key (null)"); final int len = key.length(); if (len == 0) throw new MalformedObjectNameException("Invalid key (empty)"); final char[] k=key.toCharArray(); final int endKey = parseKey(k,0); if (endKey < len) throw new MalformedObjectNameException("Invalid character in value: `" + k[endKey] + "'"); return key;
private java.lang.String	checkValue(java.lang.String val) Check if the value given in parameter in the first constructor is a valid value if (val == null) throw new MalformedObjectNameException("Invalid value (null)"); final int len = val.length(); if (len == 0) throw new MalformedObjectNameException("Invalid value (empty)"); final char[] s = val.toCharArray(); final int endValue = parseValue(s,0); if (endValue < len) throw new MalformedObjectNameException("Invalid character in value: `" + s[endValue] + "'"); return val;
private void	construct(java.lang.String name) Initializes this {@link ObjectName} from the given string representation. param name A string representation of the {@link ObjectName} exception MalformedObjectNameException The string passed as a parameter does not have the right format. exception NullPointerException The name parameter is null. // Instance private fields <======================================= // Private fields <======================================== // Private methods ----------------------------------------> // Category : Instance construction -------------------------> // The name cannot be null if (name == null) throw new NullPointerException("name cannot be null"); // Test if the name is empty if (name.length() == 0) { // this is equivalent to the whole word query object name. _canonicalName = "*:*"; _kp_array = _Empty_property_array; _ca_array = _Empty_property_array; _domain_length = 1; _propertyList = null; _domain_pattern = true; _property_pattern = true; return; } // initialize parsing of the string char[] name_chars = name.toCharArray(); int len = name_chars.length; char[] canonical_chars = new char[len]; // canonical form will be same // length at most int cname_index = 0; int index = 0; char c, c1; // parses domain part domain_parsing: while (index < len) { switch (c = name_chars[index]) { case ':" : _domain_length = index++; break domain_parsing; case '=" : int i = ++index; while ((i < len) && (name_chars[i++] != ':")) if (i == len) throw new MalformedObjectNameException( "Domain part must be specified"); break; case '\n" : throw new MalformedObjectNameException( "Invalid character '\\n' in domain name"); case '*" : case '?" : _domain_pattern = true; default : index++; } } // check for non-empty properties if (index == len) throw new MalformedObjectNameException( "Key properties cannot be empty"); // we have got the domain part, begins building of _canonicalName System.arraycopy(name_chars, 0, canonical_chars, 0, _domain_length); canonical_chars[_domain_length] = ':"; cname_index = _domain_length + 1; // parses property list Property prop; HashMap keys_map = new HashMap(); String[] keys; String key_name; boolean quoted_value; int property_index = 0; int in_index; int key_index, key_length, value_index, value_length; keys = new String[10]; _kp_array = new Property[10]; _property_pattern = false; while (index < len) { c = name_chars[index]; // case of pattern properties if (c == '*") { if (_property_pattern) throw new MalformedObjectNameException( "Cannot have several '*' characters in pattern " + "properties"); else { _property_pattern = true; if ((++index < len ) && (name_chars[index] != ',")) throw new MalformedObjectNameException( "Invalid character found after '*': end of " + "name or ',' expected"); else if (index == len) { if (property_index == 0) { // empty properties case _kp_array = _Empty_property_array; _ca_array = _Empty_property_array; _propertyList = _EmptyPropertyList; } break; } else { // correct pattern spec in props, continue index++; continue; } } } // standard property case, key part in_index = index; key_index = in_index; while ((in_index < len) && ((c1 = name_chars[in_index++]) != '=")) switch (c1) { // '=' considered to introduce value part case '*" : case '?" : case '," : case ':" : case '\n" : final String ichar = ((c1=='\n")?"\\n":""+c1); throw new MalformedObjectNameException( "Invalid character '" + ichar + "' in key part of property"); default: ; } if (in_index == len) throw new MalformedObjectNameException( "Unterminated key property part"); if (in_index == index) throw new MalformedObjectNameException("Invalid key (empty)"); value_index = in_index; // in_index pointing after '=' char key_length = value_index - key_index - 1; // found end of key // standard property case, value part if (name_chars[in_index] == '\"") { quoted_value = true; // the case of quoted value part quoted_value_parsing: while ((++in_index < len) && ((c1 = name_chars[in_index]) != '\"")) { // the case of an escaped character if (c1 == '\\") { if (++in_index == len) throw new MalformedObjectNameException( "Unterminated quoted value"); switch (c1 = name_chars[in_index]) { case '\\" : case '\"" : case '?" : case '*" : case 'n" : break; // valid character default : throw new MalformedObjectNameException( "Invalid escape sequence '\\" + c1 + "' in quoted value"); } } else if (c1 == '\n") { throw new MalformedObjectNameException( "Newline in quoted value"); } else { switch (c1) { case '?" : case '*" : throw new MalformedObjectNameException( "Invalid unescaped reserved character '" + c1 + "' in quoted value"); default: break; } } } if (in_index == len) throw new MalformedObjectNameException( "Unterminated quoted value"); else value_length = ++in_index - value_index; } else { // the case of standard value part quoted_value = false; while ((in_index < len) && ((c1 = name_chars[in_index]) != ',")) switch (c1) { // ',' considered to be the value separator case '*" : case '?" : case '=" : case ':" : case '"" : case '\n" : final String ichar = ((c1=='\n")?"\\n":""+c1); throw new MalformedObjectNameException( "Invalid character '" + c1 + "' in value part of property"); default : in_index++; } value_length = in_index - value_index; } // Parsed property, checks the end of name if (in_index == len - 1) { if (quoted_value) throw new MalformedObjectNameException( "Invalid ending character `" + name_chars[in_index] + "'"); else throw new MalformedObjectNameException( "Invalid ending comma"); } else in_index++; // we got the key and value part, prepare a property for this prop = new Property(key_index, key_length, value_length); key_name = name.substring(key_index, key_index + key_length); if (property_index == keys.length) { String[] tmp_string_array = new String[property_index + 10]; System.arraycopy(keys, 0, tmp_string_array, 0, property_index); keys = tmp_string_array; } keys[property_index] = key_name; addProperty(prop, property_index, keys_map, key_name); property_index++; index = in_index; } // computes and set canonical name setCanonicalName(name_chars, canonical_chars, keys, keys_map, cname_index, property_index);
private void	construct(java.lang.String domain, java.util.Hashtable props) Construct an ObjectName from a domain and a Hashtable. param domain Domain of the ObjectName. param props Hashtable containing couples key -> value. exception MalformedObjectNameException The domain contains an illegal character, or one of the keys or values in table contains an illegal character, or one of the values in table does not follow the rules for quoting. exception NullPointerException One of the parameters is null. // The domain cannot be null if (domain == null) throw new NullPointerException("domain cannot be null"); // The key property list cannot be null if (props == null) throw new NullPointerException("key property list cannot be null"); // The key property list cannot be empty if (props.isEmpty()) throw new MalformedObjectNameException( "key property list cannot be empty"); // checks domain validity if (!isDomain(domain)) throw new MalformedObjectNameException("Invalid domain: " + domain); // init canonicalname final StringBuffer sb = new StringBuffer(); sb.append(domain).append(':"); _domain_length = domain.length(); // allocates the property array int nb_props = props.size(); _kp_array = new Property[nb_props]; String[] keys = new String[nb_props]; final Enumeration e = props.keys(); final HashMap keys_map = new HashMap(); Property prop; int key_index; for (int i = 0; e.hasMoreElements(); i++ ) { if (i > 0) sb.append(","); String key = ""; try { key = (String)e.nextElement(); } catch (Exception x) { throw new MalformedObjectNameException("Invalid key `" + key + "'"); } String value = ""; try { value = (String)props.get(key); } catch (Exception x) { throw new MalformedObjectNameException("Invalid value `" + value + "'"); } key_index = sb.length(); checkKey(key); sb.append(key); keys[i] = key; sb.append("="); checkValue(value); sb.append(value); prop = new Property(key_index, key.length(), value.length()); addProperty(prop, i, keys_map, key); } // initialise canonical name and data structure int len = sb.length(); char[] initial_chars = new char[len]; sb.getChars(0, len, initial_chars, 0); char[] canonical_chars = new char[len]; System.arraycopy(initial_chars, 0, canonical_chars, 0, _domain_length + 1); setCanonicalName(initial_chars, canonical_chars, keys, keys_map, _domain_length + 1, _kp_array.length);
public boolean	equals(java.lang.Object object) Compares the current object name with another object name. Two ObjectName instances are equal if and only if their canonical forms are equal. The canonical form is the string described for {@link #getCanonicalName()}. param object The object name that the current object name is to be compared with. return True if object is an ObjectName whose canonical form is equal to that of this ObjectName. // same object case if (this == object) return true; // object is not an object name case if (!(object instanceof ObjectName)) return false; // equality when canonical names are the same // (because usage of intern()) ObjectName on = (ObjectName) object; String on_string = on._canonicalName; if (_canonicalName == on_string) return true; // Because we are sharing canonical form between object names, // we have finished the comparison at this stage ==> unequal return false;
public java.lang.String	getCanonicalKeyPropertyListString() Returns a string representation of the list of key properties, in which the key properties are sorted in lexical order. This is used in lexicographic comparisons performed in order to select MBeans based on their key property list. Lexical order is the order implied by {@link String#compareTo(String) String.compareTo(String)}. return The canonical key property list string. This string is independent of whether the ObjectName is a pattern. if (_ca_array.length == 0) return ""; int len = _canonicalName.length(); if (_property_pattern) len -= 2; return _canonicalName.substring(_domain_length +1, len);
public java.lang.String	getCanonicalName() Returns the canonical form of the name; that is, a string representation where the properties are sorted in lexical order. More precisely, the canonical form of the name is a String consisting of the domain part, a colon (:), the canonical key property list, and a pattern indication. The canonical key property list is the same string as described for {@link #getCanonicalKeyPropertyListString()}. The pattern indication is: empty for an ObjectName that is not a property pattern; an asterisk for an ObjectName that is a property pattern with no keys; or a comma and an asterisk (,*) for an ObjectName that is a property pattern with at least one key. return The canonical form of the name. return _canonicalName;
public java.lang.String	getDomain() Returns the domain part. return the domain. return _canonicalName.substring(0, _domain_length);
public static javax.management.ObjectName	getInstance(java.lang.String name) Return an instance of ObjectName that can be used anywhere an object obtained with {@link #ObjectName(String) new ObjectName(name)} can be used. The returned object may be of a subclass of ObjectName. Calling this method twice with the same parameters may return the same object or two equal but not identical objects. param name A string representation of the object name. return an ObjectName corresponding to the given String. exception MalformedObjectNameException The string passed as a parameter does not have the right format. exception NullPointerException The name parameter is null. since.unbundled JMX 1.2 return new ObjectName(name);
public static javax.management.ObjectName	getInstance(java.lang.String domain, java.lang.String key, java.lang.String value) Return an instance of ObjectName that can be used anywhere an object obtained with {@link #ObjectName(String, String, String) new ObjectName(domain, key, value)} can be used. The returned object may be of a subclass of ObjectName. Calling this method twice with the same parameters may return the same object or two equal but not identical objects. param domain The domain part of the object name. param key The attribute in the key property of the object name. param value The value in the key property of the object name. return an ObjectName corresponding to the given domain, key, and value. exception MalformedObjectNameException The domain, key, or value contains an illegal character, or value does not follow the rules for quoting. exception NullPointerException One of the parameters is null. since.unbundled JMX 1.2 return new ObjectName(domain, key, value);
public static javax.management.ObjectName	getInstance(java.lang.String domain, java.util.Hashtable table) Return an instance of ObjectName that can be used anywhere an object obtained with {@link #ObjectName(String, Hashtable) new ObjectName(domain, table)} can be used. The returned object may be of a subclass of ObjectName. Calling this method twice with the same parameters may return the same object or two equal but not identical objects. param domain The domain part of the object name. param table A hash table containing one or more key properties. The key of each entry in the table is the key of a key property in the object name. The associated value in the table is the associated value in the object name. return an ObjectName corresponding to the given domain and key mappings. exception MalformedObjectNameException The domain contains an illegal character, or one of the keys or values in table contains an illegal character, or one of the values in table does not follow the rules for quoting. exception NullPointerException One of the parameters is null. since.unbundled JMX 1.2 return new ObjectName(domain, table);
public static javax.management.ObjectName	getInstance(javax.management.ObjectName name) Return an instance of ObjectName that can be used anywhere the given object can be used. The returned object may be of a subclass of ObjectName. If name is of a subclass of ObjectName, it is not guaranteed that the returned object will be of the same class. The returned value may or may not be identical to name. Calling this method twice with the same parameters may return the same object or two equal but not identical objects. Since ObjectName is immutable, it is not usually useful to make a copy of an ObjectName. The principal use of this method is to guard against a malicious caller who might pass an instance of a subclass with surprising behavior to sensitive code. Such code can call this method to obtain an ObjectName that is known not to have surprising behavior. param name an instance of the ObjectName class or of a subclass return an instance of ObjectName or a subclass that is known to have the same semantics. If name respects the semantics of ObjectName, then the returned object is equal (though not necessarily identical) to name. exception NullPointerException The name is null. since.unbundled JMX 1.2 if (name.getClass().equals(ObjectName.class)) return name; try { return new ObjectName(name.getSerializedNameString()); } catch (MalformedObjectNameException e) { throw new IllegalArgumentException("Unexpected: " + e); // can't happen }
public java.lang.String	getKeyProperty(java.lang.String property) Obtains the value associated with a key in a key property. param property The property whose value is to be obtained. return The value of the property, or null if there is no such property in this ObjectName. exception NullPointerException If property is null. return (String) _getKeyPropertyList().get(property);
public java.util.Hashtable	getKeyPropertyList() Returns the key properties as a Hashtable. The returned value is a Hashtable in which each key is a key in the ObjectName's key property list and each value is the associated value. The returned value may be unmodifiable. If it is modifiable, changing it has no effect on this ObjectName. return The table of key properties. return (Hashtable)_getKeyPropertyList().clone();
public java.lang.String	getKeyPropertyListString() Returns a string representation of the list of key properties specified at creation time. If this ObjectName was constructed with the constructor {@link #ObjectName(String)}, the key properties in the returned String will be in the same order as in the argument to the constructor. return The key property list string. This string is independent of whether the ObjectName is a pattern. // BEWARE : we rebuild the propertyliststring at each call !! if (_kp_array.length == 0) return ""; // the size of the string is the canonical one minus domain // part and pattern part final int total_size = _canonicalName.length() - _domain_length - 1 - (_property_pattern?2:0); final char[] dest_chars = new char[total_size]; final char[] value = _canonicalName.toCharArray(); writeKeyPropertyListString(value,dest_chars,0); return new String(dest_chars);
private java.lang.String	getSerializedNameString() Returns the serialized string of the ObjectName. properties specified at creation time. If this ObjectName was constructed with the constructor {@link #ObjectName(String)}, the key properties in the returned String will be in the same order as in the argument to the constructor. return The key property list string. This string is independent of whether the ObjectName is a pattern. // the size of the string is the canonical one final int total_size = _canonicalName.length(); final char[] dest_chars = new char[total_size]; final char[] value = _canonicalName.toCharArray(); final int offset = _domain_length+1; // copy "domain:" into dest_chars // System.arraycopy(value, 0, dest_chars, 0, offset); // Add property list string final int end = writeKeyPropertyListString(value,dest_chars,offset); // Add ",*" if necessary if (_property_pattern) { if (end == offset) { // Property list string is empty. dest_chars[end] = '*"; } else { // Property list string is not empty. dest_chars[end] = ',"; dest_chars[end+1] = '*"; } } return new String(dest_chars);
public int	hashCode() Returns a hash code for this object name. return _canonicalName.hashCode();
private boolean	isDomain(java.lang.String domain) Check if domain is a valid domain if (domain == null) return true; final char[] d=domain.toCharArray(); final int len = d.length; int next = 0; while (next < len) { final char c = d[next++]; switch (c) { case ':" : case '\n" : return false; case '*" : case '?" : _domain_pattern = true; default: continue; } } return true;
public boolean	isDomainPattern() Checks whether the object name is a pattern on the domain part. return True if the name is a domain pattern, otherwise false. since.unbundled JMX 1.2 return _domain_pattern;
public boolean	isPattern() Checks whether the object name is a pattern. An object name is a pattern if its domain contains a wildcard or if the object name is a property pattern. return True if the name is a pattern, otherwise false. return (_domain_pattern || _property_pattern);
public boolean	isPropertyPattern() Checks whether the object name is a pattern on the key properties. return True if the name is a pattern, otherwise false. return _property_pattern;
private final boolean	matchDomains(javax.management.ObjectName name) if (_domain_pattern) { // wildmatch domains final char[] dom_pattern = getDomain().toCharArray(); final char[] dom_string = name.getDomain().toCharArray(); return wildmatch(dom_string,dom_pattern,0,0); } return getDomain().equals(name.getDomain());
private final boolean	matchKeys(javax.management.ObjectName name) if (_property_pattern) { // Every property inside pattern should exist in name final Hashtable nameProps = name._getKeyPropertyList(); final Property[] props=_ca_array; final String cn=_canonicalName; for (int i= props.length -1; i >= 0 ; i--) { // find value in given object name for key at current // index in receiver final Property p = props[i]; final String k = p.getKeyString(cn); final String v = (String)nameProps.get(k); // did we find a value for this key ? if (v == null) return false; // if this property is ok (same key, same value), // go to next if (v.equals(p.getValueString(cn))) continue; return false; } return true; } final String p1 = name.getCanonicalKeyPropertyListString(); final String p2 = getCanonicalKeyPropertyListString(); return (p1.equals(p2));
private static final int	parseKey(char[] s, int startKey) Parse a key. final int endKey=parseKey(s,startKey); key starts at startKey (included), and ends at endKey (excluded). If (startKey == endKey), then the key is empty. param s The char array of the original string. param startKey index at which to begin parsing. return The index following the last character of the key. int next = startKey; int endKey = startKey; final int len = s.length; while (next < len) { final char k = s[next++]; switch (k) { case '*": case '?": case ',": case ':": case '\n": final String ichar = ((k=='\n")?"\\n":""+k); throw new MalformedObjectNameException("Invalid character in key: `" + ichar + "'"); case '=": // we got the key. endKey = next-1; break; default: if (next < len) continue; else endKey=next; } break; } return endKey;
private static final int	parseValue(char[] s, int startValue) Parse a value. final int endVal=parseValue(s,startVal); value starts at startVal (included), and ends at endVal (excluded). If (startVal == endVal), then the key is empty. param s The char array of the original string. param startValue index at which to begin parsing. return The index following the last character of the value. int next = startValue; int endValue = startValue; final int len = s.length; final char q=s[startValue]; if (q == '"") { // quoted value if (++next == len) throw new MalformedObjectNameException("Invalid quote"); while (next < len) { char last = s[next]; if (last == '\\") { if (++next == len) throw new MalformedObjectNameException( "Invalid unterminated quoted character sequence"); last = s[next]; switch (last) { case '\\" : case '?" : case '*" : case 'n" : break; case '\"" : // We have an escaped quote. If this escaped // quote is the last character, it does not // qualify as a valid termination quote. // if (next+1 == len) throw new MalformedObjectNameException( "Missing termination quote"); break; default: throw new MalformedObjectNameException( "Invalid quoted character sequence '\\" + last + "'"); } } else if (last == '\n") { throw new MalformedObjectNameException( "Newline in quoted value"); } else if (last == '\"") { next++; break; } else { switch (last) { case '?" : case '*" : throw new MalformedObjectNameException( "Invalid unescaped reserved character '" + last + "' in quoted value"); default: break; } } next++; // Check that last character is a termination quote. // We have already handled the case were the last // character is an escaped quote earlier. // if ((next >= len) && (last != '\"")) throw new MalformedObjectNameException("Missing termination quote"); } endValue = next; if (next < len) { if (s[next++] != ',") throw new MalformedObjectNameException("Invalid quote"); } } else { // Non quoted value. while (next < len) { final char v=s[next++]; switch(v) { case '*": case '?": case '=": case ':": case '\n" : final String ichar = ((v=='\n")?"\\n":""+v); throw new MalformedObjectNameException("Invalid character `" + ichar + "' in value"); case ',": endValue = next-1; break; default: if (next < len) continue; else endValue=next; } break; } } return endValue;
public static java.lang.String	quote(java.lang.String s) Returns a quoted form of the given String, suitable for inclusion in an ObjectName. The returned value can be used as the value associated with a key in an ObjectName. The String s may contain any character. Appropriate quoting ensures that the returned value is legal in an ObjectName. The returned value consists of a quote ('"'), a sequence of characters corresponding to the characters of s, and another quote. Characters in s appear unchanged within the returned value except: A quote ('"')is replaced by a backslash (\) followed by a quote. A star ('*') is replaced by a backslash (\) followed by a star. A question mark ('?') is replaced by a backslash (\) followed by a question mark. A backslash ('\') is replaced by two backslashes. A newline character (the character '\n' in Java) is replaced by a backslash followed by the character '\n'. param s the String to be quoted. return the quoted String. exception NullPointerException if s is null. since.unbundled JMX 1.2 final StringBuffer buf = new StringBuffer("\""); final int len = s.length(); for (int i = 0; i < len; i++) { char c = s.charAt(i); switch (c) { case '\n": c = 'n"; // fall in... case '\\": case '\"": case '*": case '?": buf.append('\\"); break; } buf.append(c); } buf.append('""); return buf.toString();
private void	readObject(java.io.ObjectInputStream in) Deserializes an {@link ObjectName} from an {@link ObjectInputStream}. serialData In the current serial form (value of property jmx.serial.form differs from 1.0): the string "<domain>:<properties><wild>", where: <domain> represents the domain part of the {@link ObjectName} <properties> represents the list of properties, as returned by {@link #getKeyPropertyListString} <wild> is empty if not isPropertyPattern, or is the character "*" if isPropertyPattern and <properties> is empty, or is ",*" if isPropertyPattern and <properties> is not empty. The intent is that this string could be supplied to the {@link #ObjectName(String)} constructor to produce an equivalent {@link ObjectName}. In the old serial form (value of property jmx.serial.form is 1.0): <domain> <propertyList> <propertyListString> <canonicalName> <pattern> <propertyPattern>, where: <domain> represents the domain part of the {@link ObjectName} <propertyList> is the {@link Hashtable} that contains all the pairs (key,value) for this {@link ObjectName} <propertyListString> is the {@link String} representation of the list of properties in any order (not mandatorily a canonical representation) <canonicalName> is the {@link String} containing this {@link ObjectName}'s canonical name <pattern> is a boolean which is true if this {@link ObjectName} contains a pattern <propertyPattern> is a boolean which is true if this {@link ObjectName} contains a pattern in the list of properties String cn; if (compat) { // Read an object serialized in the old serial form // //in.defaultReadObject(); final ObjectInputStream.GetField fields = in.readFields(); cn = (String)fields.get("domain", "default")+ ":"+ (String)fields.get("propertyListString", ""); } else { // Read an object serialized in the new serial form // in.defaultReadObject(); cn = (String)in.readObject(); } try { construct(cn); } catch (NullPointerException e) { throw new InvalidObjectException(e.toString()); } catch (MalformedObjectNameException e) { throw new InvalidObjectException(e.toString()); }
private void	setCanonicalName(char[] specified_chars, char[] canonical_chars, java.lang.String[] keys, java.util.HashMap keys_map, int prop_index, int nb_props) Sets the canonical name of receiver from input 'specified_chars' array, by filling 'canonical_chars' array with found 'nb-props' properties starting at position 'prop_index'. // Sort the list of found properties if (_kp_array != _Empty_property_array) { String[] tmp_keys = new String[nb_props]; Property[] tmp_props = new Property[nb_props]; System.arraycopy(keys, 0, tmp_keys, 0, nb_props); Arrays.sort(tmp_keys); keys = tmp_keys; System.arraycopy(_kp_array, 0, tmp_props, 0 , nb_props); _kp_array = tmp_props; _ca_array = new Property[nb_props]; // now assigns _ca_array to the sorted list of keys // (there cannot be two identical keys in an objectname. for (int i = 0; i < nb_props; i++) _ca_array[i] = (Property) keys_map.get(keys[i]); // now we build the canonical name and set begin indexes of // properties to reflect canonical form int last_index = nb_props - 1; int prop_len; Property prop; for (int i = 0; i <= last_index; i++) { prop = _ca_array[i]; // length of prop including '=' char prop_len = prop._key_length + prop._value_length + 1; System.arraycopy(specified_chars, prop._key_index, canonical_chars, prop_index, prop_len); prop.setKeyIndex(prop_index); prop_index += prop_len; if (i != last_index) { canonical_chars[prop_index] = ',"; prop_index++; } } } // terminate canonicalname with '*' in case of pattern if (_property_pattern) { if (_kp_array != _Empty_property_array) canonical_chars[prop_index++] = ',"; canonical_chars[prop_index++] = '*"; } // we now build the canonicalname string _canonicalName = (new String(canonical_chars, 0, prop_index)).intern();
public void	setMBeanServer(javax.management.MBeanServer mbs)
public java.lang.String	toString() Returns a string representation of the object name. The format of this string is not specified, but users can expect that two ObjectNames return the same string if and only if they are equal. return a string representation of this object name. return getSerializedNameString();
public static java.lang.String	unquote(java.lang.String q) Returns an unquoted form of the given String. If q is a String returned by {@link #quote quote(s)}, then unquote(q).equals(s). If there is no String s for which quote(s).equals(q), then unquote(q) throws an IllegalArgumentException. These rules imply that there is a one-to-one mapping between quoted and unquoted forms. param q the String to be unquoted. return the unquoted String. exception IllegalArgumentException if q could not have been returned by the {@link #quote} method, for instance if it does not begin and end with a quote ("). exception NullPointerException if q is null. since.unbundled JMX 1.2 final StringBuffer buf = new StringBuffer(); final int len = q.length(); if (len < 2 || q.charAt(0) != '"" || q.charAt(len - 1) != '"") throw new IllegalArgumentException("Argument not quoted"); for (int i = 1; i < len - 1; i++) { char c = q.charAt(i); if (c == '\\") { if (i == len - 2) throw new IllegalArgumentException("Trailing backslash"); c = q.charAt(++i); switch (c) { case 'n": c = '\n"; break; case '\\": case '\"": case '*": case '?": break; default: throw new IllegalArgumentException( "Bad character '" + c + "' after backslash"); } } else { switch (c) { case '*" : case '?" : case '\"": case '\n": throw new IllegalArgumentException( "Invalid unescaped character '" + c + "' in the string to unquote"); default : ; } } buf.append(c); } return buf.toString();
private static boolean	wildmatch(char[] s, char[] p, int si, int pi) char c; final int slen = s.length; final int plen = p.length; while (pi < plen) { // While still string c = p[pi++]; if (c == '?") { if (++si > slen) return false; } else if (c == '*") { // Wildcard if (pi >= plen) return true; do { if (wildmatch(s,p,si,pi)) return true; } while (++si < slen); return false; } else { if (si >= slen || c != s[si++]) return false; } } return (si == slen);
private int	writeKeyPropertyListString(char[] canonicalChars, char[] data, int offset) Write a string representation of the list of key properties specified at creation time in the given array, starting at the specified offset. If this ObjectName was constructed with the constructor {@link #ObjectName(String)}, the key properties in the returned String will be in the same order as in the argument to the constructor. return offset + #of chars written if (_kp_array.length == 0) return offset; final char[] dest_chars = data; final char[] value = _canonicalName.toCharArray(); int index = offset; final int len = _kp_array.length; final int last = len - 1; for (int i = 0; i < len; i++) { final Property prop = _kp_array[i]; final int prop_len = prop._key_length + prop._value_length + 1; System.arraycopy(value, prop._key_index, dest_chars, index, prop_len); index += prop_len; if (i < last ) dest_chars[index++] = ',"; } return index;
private void	writeObject(java.io.ObjectOutputStream out) Serializes an {@link ObjectName} to an {@link ObjectOutputStream}. serialData In the current serial form (value of property jmx.serial.form differs from 1.0): the string "<domain>:<properties><wild>", where: <domain> represents the domain part of the {@link ObjectName} <properties> represents the list of properties, as returned by {@link #getKeyPropertyListString} <wild> is empty if not isPropertyPattern, or is the character "*" if this isPropertyPattern and <properties> is empty, or is ",*" if isPropertyPattern and <properties> is not empty. The intent is that this string could be supplied to the {@link #ObjectName(String)} constructor to produce an equivalent {@link ObjectName}. In the old serial form (value of property jmx.serial.form is 1.0): <domain> <propertyList> <propertyListString> <canonicalName> <pattern> <propertyPattern>, where: <domain> represents the domain part of the {@link ObjectName} <propertyList> is the {@link Hashtable} that contains all the pairs (key,value) for this {@link ObjectName} <propertyListString> is the {@link String} representation of the list of properties in any order (not mandatorily a canonical representation) <canonicalName> is the {@link String} containing this {@link ObjectName}'s canonical name <pattern> is a boolean which is true if this {@link ObjectName} contains a pattern <propertyPattern> is a boolean which is true if this {@link ObjectName} contains a pattern in the list of properties if (compat) { // Serializes this instance in the old serial form // ObjectOutputStream.PutField fields = out.putFields(); fields.put("domain", _canonicalName.substring(0, _domain_length)); fields.put("propertyList", getKeyPropertyList()); fields.put("propertyListString", getKeyPropertyListString()); fields.put("canonicalName", _canonicalName); fields.put("pattern", (_domain_pattern || _property_pattern)); fields.put("propertyPattern", _property_pattern); out.writeFields(); } else { // Serializes this instance in the new serial form // out.defaultWriteObject(); out.writeObject(getSerializedNameString()); }