FileDocCategorySizeDatePackage
ValueAccessor.javaAPI DocGlassfish v2 API3156Fri May 04 22:24:08 BST 2007com.sun.enterprise.admin.dottedname.valueaccessor

ValueAccessor.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.
 */
 
/*
 * $Header: /cvs/glassfish/admin/mbeans/src/java/com/sun/enterprise/admin/dottedname/valueaccessor/ValueAccessor.java,v 1.4 2007/05/05 05:24:07 tcfujii Exp $
 * $Revision: 1.4 $
 * $Date: 2007/05/05 05:24:07 $
 */
 

package com.sun.enterprise.admin.dottedname.valueaccessor;

import javax.management.Attribute;
import javax.management.ObjectName;


/*
	Implementors of this interface are responsible for getting and setting values,
	however that may happen.  The need for this is driven by the fact that values
	can be accessed as attributes or operations (with varying names).
	
	This particular interface is designed for use with the CLI, so get/set require
	the use of 'String', though the implementing class may choose to coerce the
	String to another data type.
 */
public interface ValueAccessor
{
	/*
		Get a value by name.  Throw an exception if it cannot be found.
	 */
	public Attribute		getValue( ObjectName objectName,  String valueName ) throws Exception;
	
	/*
		Set a value by name.  An exception should be thrown if a failure occurs.
		
		The return Attribute may be different than the original.
	 */
	public Attribute		setValue( ObjectName objectName, Attribute attr ) throws Exception;
}