javax.management.remote.message.HandshakeErrorMessage Maven / Gradle / Ivy

/*
 * @(#)file      HandshakeErrorMessage.java
 * @(#)author    Sun Microsystems, Inc.
 * @(#)version   1.10
 * @(#)lastedit  07/03/08
 * @(#)build     @BUILD_TAG_PLACEHOLDER@
 *
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright (c) 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 http://opendmk.dev.java.net/legal_notices/licenses.txt or in the 
 * LEGAL_NOTICES folder that accompanied this code. 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 found at
 *     http://opendmk.dev.java.net/legal_notices/licenses.txt
 * or in the LEGAL_NOTICES folder that accompanied this code.
 * 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 or 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 javax.management.remote.message;

/**
 * This class represents an error that occurred during the various
 * client/server handshake exchanges.
 *
 * At any time during the handshake, if either the client or the server
 * encounters a problem they can notify the other peer by sending this
 * indication message as to why the operation failed.
 *
 * @see HandshakeBeginMessage
 */
public class HandshakeErrorMessage implements Message {

    private static final long serialVersionUID = -4107265421013519799L;

    /**
     * @serial The detail of the error encountered by the other peer.
     * @see #getDetail()
     */
    private final String detail;

    /**
     * Constructs a new HandshakeErrorMessage with the specified error.
     *
     * @param detail a textual description of the error encountered by
     * the peer object.
     */
    public HandshakeErrorMessage(String detail) {
	this.detail = detail;
    }

    /**
     * A textual description of the error encountered by the
     * peer object.
     * @return The detail of the error encountered by the other peer.
     */
    public String getDetail() {
	return detail;
    }
}