FileDocCategorySizeDatePackage
DottedNames.javaAPI DocGlassfish v2 API3236Fri May 04 22:30:30 BST 2007com.sun.appserv.management.base

DottedNames.java

/*
 * 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.
 */
package com.sun.appserv.management.base;

import com.sun.appserv.management.base.XTypes;

/**
	Programmatic access to dotted-names corresponding to <i>asadmin</i> CLI
	functionality.
	<p>
	Note that the set of dotted names is periodically refreshed; to force
	an update use {@link #refresh}.
	
	@see DottedNames
	@see AllDottedNames
	@see com.sun.appserv.management.config.ConfigDottedNames
	@see com.sun.appserv.management.monitor.MonitoringDottedNames
 */
public interface DottedNames extends AMX
{
	/**
		Return an array of values corresponding to each dotted-name.
		Each slot in the array will contain either an Attribute or an Exception.
	 */
	public Object[]	dottedNameGet( String[] names );
	
	/**
		Return a value for a dotted-name.  If a name does not exist,
		then null is returned.
		@param name
	 */
	public Object	dottedNameGet( String name );
	
	/**
		List all valid prefixes for dotted names
		@param names
	 */
	public Object[]	dottedNameList( String[] names );
	
	
	/**
		Set values for dotted names; each entry must be of the form:
		<pre>
            <i>dotted-name</i>=<i>value</i>
        </pre> 
		@param nameValuePairs
	 */
	public Object[]	dottedNameSet( String[] nameValuePairs );
	
	/**
		Force a refresh of the list of dotted names.
	 */
	public void	refresh();



}