LeaseMapException.java

/*
 * 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 net.jini.core.lease;

import java.io.InvalidObjectException;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

/**
 * An exception generated when a LeaseMap renewAll or cancelAll call
 * generates exceptions on one or more leases in the map.
 *
 * @author Sun Microsystems, Inc.
 *
 * @since 1.0
 */
public class LeaseMapException extends LeaseException {

    private static final long serialVersionUID = -4854893779678486122L;

    /**
     * A Map from Lease to Exception, containing each lease that failed to
     * renew or cancel, and the exception that resulted from that lease's
     * renewal or cancel attempt.
     *
     * @serial
     */
    public Map exceptionMap;

    /**
     * Constructs a LeaseMapException for the specified map with a
     * detail message.
     *
     * @param s             the detail message
     * @param exceptionMap  the <tt>Map</tt> object on which the exception 
     *                      occurred
     * @throws NullPointerException if <code>exceptionMap</code> is
     *         <code>null</code> or contains a <code>null</code> key
     *         or a <code>null</code> value
     * @throws IllegalArgumentException if <code>exceptionMap</code>
     *         contains any key which is not an instance of 
     *         {@link Lease}, or any value which is not an instance of
     *         <code>Throwable</code>
     */
    public LeaseMapException(String s, Map exceptionMap) {
	super(s);

	final Set mapEntries = exceptionMap.entrySet();
	for (Iterator i=mapEntries.iterator(); i.hasNext(); ) {
	    final Map.Entry entry = (Entry)i.next();
	    final Object key = entry.getKey();
	    final Object value = entry.getValue();

	    if (key == null) {
		throw new NullPointerException("exceptionMap contains a null key");
	    }

	    if (!(key instanceof Lease)) {
		throw new IllegalArgumentException("exceptionMap contains an " +
		    "a key which is not a Lease:" + key);
	    }

	    if (value == null) {
		throw 
		    new NullPointerException("exceptionMap contains a null value");
	    }

	    if (!(value instanceof Throwable)) {
		throw new IllegalArgumentException("exceptionMap contains an " +
		    "a value which is not a Throwable:" + value);
	    }
	}

	this.exceptionMap = exceptionMap;
    }

    /**
     * @throws InvalidObjectException if <code>exceptionMap</code> is 
     * <code>null</code>, contains any key which is not an instance of
     * {@link Lease}, or contains any value which in not an instance of
     * <code>Throwable</code>
     */
    private void readObject(ObjectInputStream in) 
	throws IOException, ClassNotFoundException
    {
	in.defaultReadObject();

	if (exceptionMap == null)
	    throw new InvalidObjectException("exceptionMap is null");

	final Set mapEntries = exceptionMap.entrySet();
	for (Iterator i=mapEntries.iterator(); i.hasNext(); ) {
	    final Map.Entry entry = (Entry)i.next();
	    final Object key = entry.getKey();
	    final Object value = entry.getValue();

	    if (!(key instanceof Lease)) {
		throw new InvalidObjectException("exceptionMap contains an " +
		    "a key which is not a Lease:" + key);
	    }

	    if (!(value instanceof Throwable)) {
		throw new InvalidObjectException("exceptionMap contains an " +
		    "a value which is not a Throwable:" + value);
	    }
	}
    }

    /** 
     * @throws InvalidObjectException if called
     */
    private void readObjectNoData() throws InvalidObjectException {
	throw new InvalidObjectException(
	    "LeaseMapException should always have data");
    }
}