Skip to content

Commit

Permalink
HBASE-22844 Fixed Checkstyle violations in client snapshot exceptions
Browse files Browse the repository at this point in the history
Signed-off-by: stack <[email protected]>
  • Loading branch information
HorizonNet committed Aug 21, 2019
1 parent 947f6d4 commit ce91a48
Show file tree
Hide file tree
Showing 10 changed files with 162 additions and 115 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,34 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.hadoop.hbase.snapshot;

import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.yetus.audience.InterfaceAudience;

import org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos;
import org.apache.hadoop.hbase.util.Bytes;

/**
* Class to help with dealing with a snapshot description on the client side.
* There is a corresponding class on the server side.
*/
@InterfaceAudience.Private
public class ClientSnapshotDescriptionUtils {
public final class ClientSnapshotDescriptionUtils {
private ClientSnapshotDescriptionUtils() {
}

/**
* Check to make sure that the description of the snapshot requested is valid
* @param snapshot description of the snapshot
* @throws IllegalArgumentException if the name of the snapshot or the name of the table to
* snapshot are not valid names.
* snapshot are not valid names
*/
public static void assertSnapshotRequestIsValid(SnapshotProtos.SnapshotDescription snapshot)
throws IllegalArgumentException {
// make sure the snapshot name is valid
TableName.isLegalTableQualifierName(Bytes.toBytes(snapshot.getName()), true);
if(snapshot.hasTable()) {
if (snapshot.hasTable()) {
// make sure the table name is valid, this will implicitly check validity
TableName tableName = TableName.valueOf(snapshot.getTable());

Expand All @@ -51,18 +54,22 @@ public static void assertSnapshotRequestIsValid(SnapshotProtos.SnapshotDescripti
}

/**
* Returns a single line (no \n) representation of snapshot metadata. Use this instead of
* {@link org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription#toString()}. We don't replace SnapshotDescrpition's toString
* because it is auto-generated by protoc.
* @param ssd
* @return Single line string with a summary of the snapshot parameters
* Returns a single line (no \n) representation of snapshot metadata. Use this instead of
* {@link org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription#toString()}.
* We don't replace
* {@link org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription}'s
* {@code toString}, because it is auto-generated by protoc.
*
* @param snapshot description of the snapshot
* @return single line string with a summary of the snapshot parameters
*/
public static String toString(SnapshotProtos.SnapshotDescription ssd) {
if (ssd == null) {
public static String toString(SnapshotProtos.SnapshotDescription snapshot) {
if (snapshot == null) {
return null;
}
return "{ ss=" + ssd.getName() +
" table=" + (ssd.hasTable()?TableName.valueOf(ssd.getTable()):"") +
" type=" + ssd.getType() + " }";

return "{ ss=" + snapshot.getName() +
" table=" + (snapshot.hasTable()?TableName.valueOf(snapshot.getTable()):"") +
" type=" + snapshot.getType() + " }";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,35 +17,38 @@
*/
package org.apache.hadoop.hbase.snapshot;

import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.client.SnapshotDescription;

import org.apache.yetus.audience.InterfaceAudience;

/**
* Exception thrown when the found snapshot info from the filesystem is not valid
* Exception thrown when the found snapshot info from the filesystem is not valid.
*/
@SuppressWarnings("serial")
@InterfaceAudience.Public
public class CorruptedSnapshotException extends HBaseSnapshotException {

/**
* Snapshot was corrupt for some reason.
*
* @param message message describing the exception
* @param e cause
* @param e the actual cause of the exception
*/
public CorruptedSnapshotException(String message, Exception e) {
super(message, e);
}

/**
* Snapshot was corrupt for some reason
* Snapshot was corrupt for some reason.
*
* @param message full description of the failure
* @param snapshot snapshot that was expected
* @param snapshotDescription snapshot that was expected
*/
public CorruptedSnapshotException(String message, SnapshotDescription snapshot) {
super(message, snapshot);
public CorruptedSnapshotException(String message, SnapshotDescription snapshotDescription) {
super(message, snapshotDescription);
}

/**
* Snapshot was corrupt for some reason.
*
* @param message message describing the exception
*/
public CorruptedSnapshotException(String message) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,16 @@
@InterfaceAudience.Public
@SuppressWarnings("serial")
public class ExportSnapshotException extends HBaseSnapshotException {

/**
* @param msg message describing the exception
* @param message message describing the exception
*/
public ExportSnapshotException(String msg) {
super(msg);
public ExportSnapshotException(String message) {
super(message);
}

/**
* @param message message describing the exception
* @param e cause
* @param e the actual cause of the exception
*/
public ExportSnapshotException(String message, Exception e) {
super(message, e);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,57 +18,64 @@
package org.apache.hadoop.hbase.snapshot;

import org.apache.hadoop.hbase.DoNotRetryIOException;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.client.SnapshotDescription;
import org.apache.yetus.audience.InterfaceAudience;

/**
* General exception base class for when a snapshot fails
* General exception base class for when a snapshot fails.
*/
@SuppressWarnings("serial")
@InterfaceAudience.Public
public class HBaseSnapshotException extends DoNotRetryIOException {

private SnapshotDescription description;

/**
* Some exception happened for a snapshot and don't even know the snapshot that it was about
* @param msg Full description of the failure
* Some exception happened for a snapshot and don't even know the snapshot that it was about.
*
* @param message the full description of the failure
*/
public HBaseSnapshotException(String msg) {
super(msg);
public HBaseSnapshotException(String message) {
super(message);
}

/**
* Exception for the given snapshot that has no previous root cause
* @param msg reason why the snapshot failed
* @param desc description of the snapshot that is being failed
* Exception for the given snapshot that has no previous root cause.
*
* @param message the reason why the snapshot failed
* @param snapshotDescription the description of the snapshot that is failing
*/
public HBaseSnapshotException(String msg, SnapshotDescription desc) {
super(msg);
this.description = desc;
public HBaseSnapshotException(String message, SnapshotDescription snapshotDescription) {
super(message);
this.description = snapshotDescription;
}

/**
* Exception for the given snapshot due to another exception
* @param msg reason why the snapshot failed
* @param cause root cause of the failure
* @param desc description of the snapshot that is being failed
* Exception for the given snapshot due to another exception.
*
* @param message the reason why the snapshot failed
* @param cause the root cause of the failure
* @param snapshotDescription the description of the snapshot that is being failed
*/
public HBaseSnapshotException(String msg, Throwable cause, SnapshotDescription desc) {
super(msg, cause);
this.description = desc;
public HBaseSnapshotException(String message, Throwable cause,
SnapshotDescription snapshotDescription) {
super(message, cause);
this.description = snapshotDescription;
}

/**
* Exception when the description of the snapshot cannot be determined, due to some root other
* root cause
* root cause.
*
* @param message description of what caused the failure
* @param e root cause
* @param cause the root cause
*/
public HBaseSnapshotException(String message, Throwable e) {
super(message, e);
public HBaseSnapshotException(String message, Throwable cause) {
super(message, cause);
}

/**
* @return the description of the snapshot that is being failed
*/
public SnapshotDescription getSnapshotDescription() {
return this.description;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,47 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.hadoop.hbase.snapshot;

import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.client.SnapshotDescription;
import org.apache.yetus.audience.InterfaceAudience;

/**
* Thrown when a snapshot could not be restored due to a server-side error when restoring it.
*/
@SuppressWarnings("serial")
@InterfaceAudience.Public
public class RestoreSnapshotException extends HBaseSnapshotException {
public RestoreSnapshotException(String msg, SnapshotDescription desc) {
super(msg, desc);
/**
* @param message reason why restoring the snapshot fails
* @param snapshotDescription description of the snapshot attempted
*/
public RestoreSnapshotException(String message, SnapshotDescription snapshotDescription) {
super(message, snapshotDescription);
}

public RestoreSnapshotException(String msg, Throwable cause, SnapshotDescription desc) {
super(msg, cause, desc);
/**
* @param message reason why restoring the snapshot fails
* @param cause the root cause of the failure
* @param snapshotDescription description of the snapshot attempted
*/
public RestoreSnapshotException(String message, Throwable cause,
SnapshotDescription snapshotDescription) {
super(message, cause, snapshotDescription);
}

public RestoreSnapshotException(String msg) {
super(msg);
/**
* @param message reason why restoring the snapshot fails
*/
public RestoreSnapshotException(String message) {
super(message);
}

public RestoreSnapshotException(String message, Throwable e) {
super(message, e);
/**
* @param message reason why restoring the snapshot fails
* @param cause the root cause of the failure
*/
public RestoreSnapshotException(String message, Throwable cause) {
super(message, cause);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
*/
package org.apache.hadoop.hbase.snapshot;

import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.client.SnapshotDescription;
import org.apache.yetus.audience.InterfaceAudience;

/**
* Thrown when a snapshot could not be created due to a server-side error when
Expand All @@ -27,31 +27,34 @@
@SuppressWarnings("serial")
@InterfaceAudience.Public
public class SnapshotCreationException extends HBaseSnapshotException {

/**
* Used internally by the RPC engine to pass the exception back to the client.
* @param msg error message to pass back
*
* @param message error message to pass back
*/
public SnapshotCreationException(String msg) {
super(msg);
public SnapshotCreationException(String message) {
super(message);
}

/**
* Failure to create the specified snapshot
* @param msg reason why the snapshot couldn't be completed
* @param desc description of the snapshot attempted
* Failure to create the specified snapshot.
*
* @param message reason why the snapshot couldn't be completed
* @param snapshotDescription description of the snapshot attempted
*/
public SnapshotCreationException(String msg, SnapshotDescription desc) {
super(msg, desc);
public SnapshotCreationException(String message, SnapshotDescription snapshotDescription) {
super(message, snapshotDescription);
}

/**
* Failure to create the specified snapshot due to an external cause
* @param msg reason why the snapshot couldn't be completed
* @param cause root cause of the failure
* @param desc description of the snapshot attempted
* Failure to create the specified snapshot due to an external cause.
*
* @param message reason why the snapshot couldn't be completed
* @param cause the root cause of the failure
* @param snapshotDescription description of the snapshot attempted
*/
public SnapshotCreationException(String msg, Throwable cause, SnapshotDescription desc) {
super(msg, cause, desc);
public SnapshotCreationException(String message, Throwable cause,
SnapshotDescription snapshotDescription) {
super(message, cause, snapshotDescription);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,27 @@
*/
package org.apache.hadoop.hbase.snapshot;

import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.client.SnapshotDescription;

import org.apache.yetus.audience.InterfaceAudience;

/**
* Thrown when the server is looking for a snapshot but can't find the snapshot on the filesystem
* Thrown when the server is looking for a snapshot, but can't find the snapshot on the filesystem.
*/
@SuppressWarnings("serial")
@InterfaceAudience.Public
public class SnapshotDoesNotExistException extends HBaseSnapshotException {
/**
* @param msg full description of the failure
* @param message the full description of the failure
*/
public SnapshotDoesNotExistException(String msg) {
super(msg);
public SnapshotDoesNotExistException(String message) {
super(message);
}

/**
* @param desc expected snapshot to find
* @param snapshotDescription expected snapshot to find
*/
public SnapshotDoesNotExistException(SnapshotDescription desc) {
super("Snapshot '" + desc.getName() +"' doesn't exist on the filesystem", desc);
public SnapshotDoesNotExistException(SnapshotDescription snapshotDescription) {
super("Snapshot '" + snapshotDescription.getName() + "' doesn't exist on the filesystem",
snapshotDescription);
}
}
Loading

0 comments on commit ce91a48

Please sign in to comment.