/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
 
/*
 * $Header: /cvs/glassfish/admin-cli/cli-api/src/java/com/sun/cli/jmx/util/ObjectNameQuery.java,v 1.4 2007/05/05 05:25:00 tcfujii Exp $
 * $Revision: 1.4 $
 * $Date: 2007/05/05 05:25:00 $
 */
package com.sun.cli.jmx.util;

import java.util.Set;

import javax.management.ObjectName;
import javax.management.MBeanServerConnection;
import javax.management.MalformedObjectNameException;

public interface ObjectNameQuery
{
	/*
		Return the ObjectNames of all MBeans whose properties match all the specified
		regular expressions.  Both property names and values may be searched.
		
		A starting set may be specified by using an ObjectName pattern.
		This can greatly improve the performance of the search by restricting the
		set of MBeans which are examined; otherwise all registered MBeans must be examined.
		
		The regexNames[ i ] pattern corresponds to regexValues[ i ].  A value of null
		for any item is taken to mean "match anything".  Thus specifing null for 
		'regexNames' means "match any name" and specifying regexNames[ i ] = null means
		to match only based on regexValues[ i ] (and vice versa).
		
		@param startingSetPattern 	optional ObjectName pattern for starting set to search
		@param regexNames			optional series of regular expressions for Property names
		@param regexNames			optional series of regular expressions for Property values
		@returns 					array of ObjectName (may be of zero length)
	 */
	Set	matchAll( Set startingSet, String [] regexNames, String [] regexValues );
				
	/*
		Return the ObjectNames of all MBeans whose properties match any of the specified
		regular expressions.  Both property names and values may be searched.
		
		A starting set may be specified by using an ObjectName pattern.
		This can greatly improve the performance of the search by restricting the
		set of MBeans which are examined; otherwise all registered MBeans must be examined.
		
		
		The regexNames[ i ] pattern corresponds to regexValues[ i ].  A value of null
		for any item is taken to mean "match anything".  Thus specifing null for 
		'regexNames' means "match any name" and specifying regexNames[ i ] = null means
		to match only based on regexValues[ i ] (and vice versa).
		
		@param startingSetPattern 	optional ObjectName pattern for starting set to search
		@param regexNames			optional series of regular expressions for Property names
		@param regexNames			optional series of regular expressions for Property values
		@returns 					array of ObjectName (may be of zero length)
	 */
	Set	matchAny( Set startingSet, String [] regexNames, String [] regexValues );
}