ObjectNameQuery


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23   
24  /*
25   * $Header: /cvs/glassfish/admin-core/mbeanapi/src/java/com/sun/appserv/management/util/jmx/ObjectNameQuery.java,v 1.3 2005/12/25 03:51:30 tcfujii Exp $
26   * $Revision: 1.3 $
27   * $Date: 2005/12/25 03:51:30 $
28   */
29  package com.sun.appserv.management.util.jmx;
30  
31  import java.util.Set  ;
32  
33  import javax.management.ObjectName  ;
34  import javax.management.MBeanServerConnection  ;
35  import javax.management.MalformedObjectNameException  ;
36  
37  public interface ObjectNameQuery
38  {
39      /**
40          Return the ObjectNames of all MBeans whose properties match all the specified
41          regular expressions.  Both property names and values may be searched.
42          
43          A starting set may be specified by using an ObjectName pattern.
44          This can greatly improve the performance of the search by restricting the
45          set of MBeans which are examined; otherwise all registered MBeans must be examined.
46          
47          The regexNames[ i ] pattern corresponds to regexValues[ i ].  A value of null
48          for any item is taken to mean "match anything".  Thus specifing null for 
49          'regexNames' means "match any name" and specifying regexNames[ i ] = null means
50          to match only based on regexValues[ i ] (and vice versa).
51          
52          @param startingSet          optional ObjectName pattern for starting set to search
53          @param regexNames           optional series of regular expressions for Property names
54          @param regexValues          optional series of regular expressions for Property values
55          @return                     array of ObjectName (may be of zero length)
56       */
57      Set  <ObjectName  > matchAll( Set  <ObjectName  > startingSet, String   [] regexNames, String   [] regexValues );
58                  
59      /**
60          Return the ObjectNames of all MBeans whose properties match any of the specified
61          regular expressions.  Both property names and values may be searched.
62          
63          A starting set may be specified by using an ObjectName pattern.
64          This can greatly improve the performance of the search by restricting the
65          set of MBeans which are examined; otherwise all registered MBeans must be examined.
66          
67          
68          The regexNames[ i ] pattern corresponds to regexValues[ i ].  A value of null
69          for any item is taken to mean "match anything".  Thus specifing null for 
70          'regexNames' means "match any name" and specifying regexNames[ i ] = null means
71          to match only based on regexValues[ i ] (and vice versa).
72          
73          @param startingSet          optional ObjectName pattern for starting set to search
74          @param regexNames           optional series of regular expressions for Property names
75          @param regexValues          optional series of regular expressions for Property values
76          @return                     array of ObjectName (may be of zero length)
77       */
78      Set  <ObjectName  > matchAny( Set  <ObjectName  > startingSet, String   [] regexNames, String   [] regexValues );
79  }
80  
81  
82  
83  
84  
85  
86
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags