org.apache.river.proxy.MarshalledWrapper Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.apache.river.proxy;
import java.io.IOException;
import java.io.InvalidObjectException;
import java.io.ObjectInput;
import java.io.ObjectInputStream;
import java.io.ObjectStreamException;
import java.io.Serializable;
import java.util.Collection;
import java.util.Iterator;
import net.jini.io.MarshalledInstance;
import net.jini.io.ObjectStreamContext;
import net.jini.io.context.AtomicValidationEnforcement;
import net.jini.io.context.IntegrityEnforcement;
import org.apache.river.api.io.AtomicSerial;
import org.apache.river.api.io.AtomicSerial.GetArg;
import org.apache.river.api.io.AtomicSerial.ReadInput;
import org.apache.river.api.io.AtomicSerial.ReadObject;
/**
* Wrapper around {@link MarshalledInstance} that samples the integrity setting
* (if any) of the stream it is unmarshalled from, and uses that setting to
* determine whether or not to verify codebase integrity when calling the
* {@link MarshalledInstance#get(boolean) get} method of the contained
* MarshalledInstance.
*
* @author Sun Microsystems, Inc.
*
* @since 2.0
*/
@AtomicSerial
public class MarshalledWrapper implements Serializable {
private static class RO implements ReadObject{
boolean integrity;
@Override
public void read(ObjectInput input) throws IOException, ClassNotFoundException {
integrity = integrityEnforced(input);
}
}
@ReadInput
static ReadObject read(){
return new RO();
}
private static final long serialVersionUID = 2L;
/**
* The wrapped MarshalledInstance.
*
* @serial
*/
private final MarshalledInstance instance;
/**
* Flag set to true if this instance was unmarshalled from an
* integrity-protected stream, or false otherwise
*/
private transient boolean integrity = false;
/**
* Returns the integrity protection setting of the given stream, determined
* as follows: if the stream implements {@link ObjectStreamContext} and has
* in its context collection an object of type
* {@link IntegrityEnforcement}, the
* {@link IntegrityEnforcement#integrityEnforced integrityEnforced} method
* of that object is called and the resulting value returned; otherwise,
* false is returned.
*
* @param stream the given stream
* @return integrity protection setting of the given stream
*/
public static boolean integrityEnforced(ObjectInput stream) {
if (stream instanceof ObjectStreamContext) {
return integrityEnforced(((ObjectStreamContext) stream));
}
return false;
}
/**
* Returns the integrity protection setting in the given ObjectStreamContext.
* @param context
* @return
*/
public static boolean integrityEnforced(ObjectStreamContext context) {
Collection ctx = context.getObjectStreamContext();
for (Iterator i = ctx.iterator(); i.hasNext(); ) {
Object obj = i.next();
if (obj instanceof IntegrityEnforcement) {
return ((IntegrityEnforcement) obj).integrityEnforced();
}
}
return false;
}
/**
* Returns the atomicity protection setting of the given stream, determined
* as follows: if the stream implements {@link ObjectStreamContext} and has
* in its context collection an object of type
* {@link AtomicValidationEnforcement}, the
* {@link AtomicValidationEnforcement#enforced enforced} method
* of that object is called and the resulting value returned; otherwise,
* false is returned.
*
* @param context
* @return integrity protection setting of the given stream
*/
public static boolean atomicityEnforced(ObjectStreamContext context) {
Collection ctx =
((ObjectStreamContext) context).getObjectStreamContext();
for (Iterator i = ctx.iterator(); i.hasNext(); ) {
Object obj = i.next();
if (obj instanceof AtomicValidationEnforcement) {
return ((AtomicValidationEnforcement) obj).enforced();
}
}
return false;
}
/**
* Creates a new MarshalledWrapper wrapping a
* MarshalledInstance containing the given object.
*
* @param obj object to create MarshalledInstance with
* @throws IOException if MarshalledInstance creation fails
*/
public MarshalledWrapper(Object obj) throws IOException {
instance = new MarshalledInstance(obj);
}
/**
* Creates a new MarshalledWrapper wrapping the given
* MarshalledInstance.
*
* @param instance MarshalledInstance to wrap
* @throws NullPointerException if instance is
* null
*/
public MarshalledWrapper(MarshalledInstance instance) {
this(check(instance), false);
}
public MarshalledWrapper(GetArg arg) throws IOException, ClassNotFoundException {
this(validate(arg.get("instance", null, MarshalledInstance.class)),
((RO) arg.getReader()).integrity);
}
private MarshalledWrapper(MarshalledInstance instance, boolean integrity){
this.instance = instance;
this.integrity = integrity;
}
private static MarshalledInstance check( MarshalledInstance instance){
if (instance == null) {
throw new NullPointerException();
}
return instance;
}
private static MarshalledInstance validate(MarshalledInstance instance) throws InvalidObjectException{
if (instance == null) {
throw new InvalidObjectException("null instance");
}
return instance;
}
/**
* Returns the result of calling the {@link MarshalledInstance#get(boolean)
* get} method of the wrapped MarshalledInstance, passing the
* integrity value sampled during deserialization as the
* verifyCodebaseIntegrity argument. If this
* MarshalledWrapper instance was not produced by
* deserialization or was deserialized from a stream with no integrity
* protection setting, then a verifyCodebaseIntegrity value of
* false is used.
*
* @return the object unmarshalled by the wrapped
* MarshalledInstance
* @throws IOException if an IOException occurs during
* unmarshalling
* @throws ClassNotFoundException if any classes necessary for
* reconstructing the object being unmarshalled cannot be found
*/
public Object get() throws IOException, ClassNotFoundException {
return instance.get(integrity);
}
/**
* Returns the result of calling the
* {@link MarshalledInstance#get(ClassLoader, boolean, ClassLoader, Collection)
* get} method of the wrapped MarshalledInstance, passing the
* integrity value sampled during deserialization as the
* verifyCodebaseIntegrity argument. If this
* MarshalledWrapper instance was not produced by
* deserialization or was deserialized from a stream with no integrity
* protection setting, then a verifyCodebaseIntegrity value of
* false is used.
*
* @param defaultLoader the class loader value (possibly
* null) to pass as the defaultLoader
* argument to RMIClassLoader methods
* @param verifierLoader the class loader value (possibly
* null) to pass to {@link
* net.jini.security.Security#verifyCodebaseIntegrity
* Security.verifyCodebaseIntegrity}, if
* verifyCodebaseIntegrity is true
* @return the object unmarshalled by the wrapped
* MarshalledInstance
* @throws IOException if an IOException occurs during
* unmarshalling
* @throws ClassNotFoundException if any classes necessary for
* reconstructing the object being unmarshalled cannot be found
* @since JGDMS-3.1
*/
public Object get(final ClassLoader defaultLoader,
final ClassLoader verifierLoader)
throws IOException, ClassNotFoundException
{
return instance.get(defaultLoader, integrity, verifierLoader, null);
}
/**
* Returns the result of calling the
* {@link MarshalledInstance#get(ClassLoader, boolean, ClassLoader, Collection)
* get} method of the wrapped MarshalledInstance, passing the
* integrity value sampled during deserialization as the
* verifyCodebaseIntegrity argument. If this
* MarshalledWrapper instance was not produced by
* deserialization or was deserialized from a stream with no integrity
* protection setting, then a verifyCodebaseIntegrity value of
* false is used.
*
* @param defaultLoader the class loader value (possibly
* null) to pass as the defaultLoader
* argument to RMIClassLoader methods
* @param verifierLoader the class loader value (possibly
* null) to pass to {@link
* net.jini.security.Security#verifyCodebaseIntegrity
* Security.verifyCodebaseIntegrity}, if
* verifyCodebaseIntegrity is true
* @param context
* @return the object unmarshalled by the wrapped
* MarshalledInstance
* @throws IOException if an IOException occurs during
* unmarshalling
* @throws ClassNotFoundException if any classes necessary for
* reconstructing the object being unmarshalled cannot be found
* @since JGDMS-3.1
*/
public Object get(final ClassLoader defaultLoader,
final ClassLoader verifierLoader,
final Collection context)
throws IOException, ClassNotFoundException
{
return instance.get(defaultLoader, integrity, verifierLoader, context);
}
/**
* Returns the MarshalledInstance wrapped by this
* MarshalledWrapper.
*
* @return wrapped MarshalledInstance
*/
public MarshalledInstance getMarshalledInstance() {
return instance;
}
/**
* Returns the integrity value sampled during deserialization of this
* MarshalledWrapper instance, or false if this
* instance was not produced by deserialization or was deserialized from a
* stream with no integrity protection setting.
*
* @return sampled integrity value
*/
public boolean getIntegrity() {
return integrity;
}
/**
* Returns the hash code value for this MarshalledWrapper.
*
* @return the hash code value for this MarshalledWrapper.
*/
public int hashCode() {
return MarshalledWrapper.class.hashCode() ^ instance.hashCode();
}
/**
* Compares the specified object with this MarshalledWrapper
* for equality. This method returns true if and only if the
* specified object is of the same class as this object and its wrapped
* MarshalledInstance is equal to the one in this object.
*
* @param obj object to compare with
* @return true if obj is equivalent to
* this object; false otherwise
*/
public boolean equals(Object obj) {
return obj == this ||
(obj != null &&
obj.getClass() == getClass() &&
instance.equals(((MarshalledWrapper) obj).instance));
}
/**
* Samples integrity protection setting (if any) of the stream from which
* this instance is being deserialized.
*/
private void readObject(ObjectInputStream in)
throws IOException, ClassNotFoundException
{
in.defaultReadObject();
if (instance == null) {
throw new InvalidObjectException("null instance");
}
integrity = integrityEnforced(in);
}
/**
* Throws InvalidObjectException, since data for this class is required.
*/
private void readObjectNoData() throws ObjectStreamException {
throw new InvalidObjectException("no data");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy