com.sun.xml.ws.config.management.jmx.MBeanAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metro-cm-impl
There is a newer version: 4.0.4
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. 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_1_1.html
 * or packager/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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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.xml.ws.config.management.jmx;

import javax.management.InvalidAttributeValueException;
import javax.management.openmbean.OpenType;

/**
 * All management MBean attributes need to implement this interface.
 *
 * @author Fabian Ritzmann
 */
public interface MBeanAttribute {

    /**
     * The description of the attribute.
     *
     * @return The description of the attribute.
     */
    public String getDescription();

    /**
     * The type of the attribute.
     *
     * @return The type of the attribute.
     */
    public OpenType getType();

    /**
     * If the attribute is readable.
     *
     * @return If the attribute is readable.
     */
    public boolean isReadable();

    /**
     * If the attribute is writable.
     *
     * @return If the attribute is writable.
     */
    public boolean isWritable();

    /**
     * Returns the attribute value.
     *
     * @return The attribute value. May be null.
     * @throws UnsupportedOperationException If the attribute is not readable.
     */
    public Object getValue() throws UnsupportedOperationException;

    /**
     * Sets the attribute value.
     *
     * @param value The attribute value.
     * @throws InvalidAttributeValueException If the value is invalid.
     */
    public void setValue(Object value) throws InvalidAttributeValueException;

}