javax.management.remote.generic.ObjectWrapping Maven / Gradle / Ivy
Show all versions of jppf-jmxremote_optional Show documentation
/*
* JPPF.
* Copyright (C) 2005-2016 JPPF Team.
* http://www.jppf.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* @(#)file ObjectWrapping.java
* @(#)author Sun Microsystems, Inc.
* @(#)version 1.12
* @(#)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.generic;
import java.io.IOException;
/**
* An interface that defines how to wrap parameters that use a non-default class loader.
* A {@link GenericConnector} can specify an instance of this interface to define a connection-specific wrapping.
*
Certain parameters to {@link javax.management.MBeanServerConnection MBeanServerConnection} methods have to
* be wrapped because their class loader is not necessarily known to the remote connector server.
*
For example, when calling {@link javax.management.MBeanServerConnection#setAttribute setAttribute} on an
* MBean X, the attribute value v to be set might be of a class that is known to X's class
* loader but not to the class loader of the connector server. If v were not wrapped, the connector server
* would receive it at the same time as it received other information such as X's ObjectName.
* The whole request would fail because of the inability to find the v's class.
*
Object wrapping solves this problem by encoding v inside an object of a type that is known to the connector
* server, such as byte[] or String. Then v is recreated using X's class loader,
* which the connector server can know once X's name has been successfully received.
*
An instance of this class can be communicated to the Generic Connector or Generic Connector Server using the attribute {@link GenericConnector#OBJECT_WRAPPING}.
*
The default ObjectWrapping wraps objects in a byte array that contains the output of
* {@link java.io.ObjectOutputStream#writeObject(Object) ObjectOutputStream.writeObject} for the given object in a new ObjectOutputStream.
* @exclude
*/
public interface ObjectWrapping {
/**
* Wraps an object.
* @param obj the object to be wrapped.
* @return the wrapped object.
* @exception IOException if the object cannot be wrapped for some reason.
*/
Object wrap(Object obj) throws IOException;
/**
* Unwraps an object.
* @param wrapped the wrapped object to be unwrapped.
* @param cloader the class loader to be used to load the object's class. Can be null, meaning the bootstrap class loader.
* @return the unwrapped object.
* @exception ClassNotFoundException if the class that the unwrapped object should have is not known to the given class loader.
* @exception IOException if the object cannot be unwrapped for some reason.
*/
Object unwrap(Object wrapped, ClassLoader cloader) throws IOException, ClassNotFoundException;
}