org.wildfly.security.auth.server.RealmUnavailableException Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2015 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.
*/
package org.wildfly.security.auth.server;
import java.io.IOException;
/**
* An exception to indicate a general underlying failure of the realm.
*
* Realms should only make use of this exception for general failures within the realm such as being unable to communicate with
* a remote store of users rather than to report errors with a specific authentication request.
*
* @author Darran Lofthouse
*/
public class RealmUnavailableException extends IOException {
private static final long serialVersionUID = 5893125522523952643L;
/**
* Constructs a new {@code RealmUnavailableException} instance. The message is left blank ({@code null}), and no
* cause is specified.
*/
public RealmUnavailableException() {
}
/**
* Constructs a new {@code RealmUnavailableException} instance with an initial message. No cause is specified.
*
* @param msg the message
*/
public RealmUnavailableException(final String msg) {
super(msg);
}
/**
* Constructs a new {@code RealmUnavailableException} instance with an initial cause. If a non-{@code null} cause
* is specified, its message is used to initialize the message of this {@code RealmUnavailableException}; otherwise
* the message is left blank ({@code null}).
*
* @param cause the cause
*/
public RealmUnavailableException(final Throwable cause) {
super(cause);
}
/**
* Constructs a new {@code RealmUnavailableException} instance with an initial message and cause.
*
* @param msg the message
* @param cause the cause
*/
public RealmUnavailableException(final String msg, final Throwable cause) {
super(msg, cause);
}
}