com.gemstone.gemfire.cache.RegionDistributionException Maven / Gradle / Ivy
/*
* Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
*
* 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. See accompanying
* LICENSE file.
*/
package com.gemstone.gemfire.cache;
import java.io.*;
import java.util.*;
import com.gemstone.gemfire.distributed.Role;
import com.gemstone.gemfire.distributed.internal.membership.InternalRole;
/**
* Indicates that an attempt to send a distributed cache event to one or more
* {@link MembershipAttributes#getRequiredRoles required roles} may have
* failed. Failure may be caused by departure of one or more required roles
* while sending the message to them. If the region scope is {@linkplain
* com.gemstone.gemfire.cache.Scope#DISTRIBUTED_NO_ACK DISTRIBUTED_NO_ACK} or
* {@linkplain com.gemstone.gemfire.cache.Scope#GLOBAL GLOBAL} then failure
* may be caused by one or more required roles not acknowledging receipt of
* the message.
*
* @author Kirk Lund
* @since 5.0
*/
public class RegionDistributionException extends RegionRoleException {
private static final long serialVersionUID = -5950359426786805646L;
/**
* Set of missing required roles causing access to the region to fail.
* failedRoles is transient to avoid NotSerializableException. See {@link
* #writeObject} and {@link #readObject} for custom serialization.
*/
private transient Set failedRoles = Collections.EMPTY_SET;
/**
* Constructs a RegionDistributionException with a message.
* @param s the String message
* @param regionFullPath full path of region for which access was attempted
* @param failedRoles the required roles that caused this exception
*/
public RegionDistributionException(String s, String regionFullPath, Set failedRoles) {
super(s, regionFullPath);
this.failedRoles = failedRoles;
if (this.failedRoles == null) {
this.failedRoles = Collections.EMPTY_SET;
}
}
/**
* Constructs a RegionDistributionException with a message and
* a cause.
* @param s the String message
* @param regionFullPath full path of region for which access was attempted
* @param failedRoles the required roles that caused this exception
* @param ex the Throwable cause
*/
public RegionDistributionException(String s, String regionFullPath, Set failedRoles, Throwable ex) {
super(s, regionFullPath, ex);
this.failedRoles = failedRoles;
if (this.failedRoles == null) {
this.failedRoles = Collections.EMPTY_SET;
}
}
/**
* Returns the required roles that caused this exception. One or more
* roles failed to receive a cache distribution message or acknowledge
* receipt of that message.
* @return the required roles that caused this exception
*/
public Set getFailedRoles() {
return this.failedRoles;
}
/**
* Override writeObject which is used in serialization. Customize
* serialization of this exception to avoid escape of InternalRole
* which is not Serializable.
*/
private void writeObject(java.io.ObjectOutputStream out)
throws IOException {
out.defaultWriteObject();
// transform roles to string names which are serializable...
Set roleNames = new HashSet(this.failedRoles.size());
for (Iterator iter = this.failedRoles.iterator(); iter.hasNext();) {
String name = ((Role)iter.next()).getName();
roleNames.add(name);
}
out.writeObject(roleNames);
}
/**
* Override readObject which is used in serialization. Customize
* serialization of this exception to avoid escape of InternalRole
* which is not Serializable.
*/
private void readObject(java.io.ObjectInputStream in)
throws IOException, ClassNotFoundException {
in.defaultReadObject();
// transform string names which are serializable back into roles...
Set roleNames = (Set)in.readObject();
Set roles = new HashSet(roleNames.size());
for (Iterator iter = roleNames.iterator(); iter.hasNext();) {
String name = (String) iter.next();
roles.add(InternalRole.getRole(name));
}
this.failedRoles = roles;
}
}