GatewayAuthenticationProviderUnavailableException.java
/*
* Copyright (c) 2017 Bosch Software Innovations GmbH.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/org/documents/epl-2.0/index.php
*
* Contributors:
* Bosch Software Innovations GmbH - initial contribution
*/
package org.eclipse.ditto.signals.commands.base.exceptions;
import java.net.URI;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.eclipse.ditto.model.base.common.HttpStatusCode;
import org.eclipse.ditto.model.base.exceptions.DittoRuntimeException;
import org.eclipse.ditto.model.base.exceptions.DittoRuntimeExceptionBuilder;
import org.eclipse.ditto.model.base.headers.DittoHeaders;
/**
* This exception indicates that Authentication provider (e.g. IM3) was not available at the time of the
* authentication.
*/
@Immutable
public final class GatewayAuthenticationProviderUnavailableException extends DittoRuntimeException
implements GatewayException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "authentication.provider.unavailable";
private static final String DEFAULT_MESSAGE = "The authentication provider is not available.";
private static final String DEFAULT_DESCRIPTION =
"If after retry it is still unavailable, please contact the service team.";
private static final long serialVersionUID = 1885218428059437158L;
private GatewayAuthenticationProviderUnavailableException(final DittoHeaders dittoHeaders, final String message,
final String description, final Throwable cause, final URI href) {
super(ERROR_CODE, HttpStatusCode.SERVICE_UNAVAILABLE, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@code GatewayAuthenticationProviderUnavailableException}.
*
* @return the builder.
*/
public static Builder newBuilder() {
return new Builder();
}
/**
* Constructs a new {@code GatewayAuthenticationProviderUnavailableException} object with given message.
*
* @param message detail message. This message can be later retrieved by the {@link #getMessage()} method.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new GatewayAuthenticationProviderUnavailableException.
*/
public static GatewayAuthenticationProviderUnavailableException fromMessage(final String message,
final DittoHeaders dittoHeaders) {
return new Builder()
.dittoHeaders(dittoHeaders)
.message(message)
.build();
}
/**
* A mutable builder with a fluent API for a {@link GatewayAuthenticationProviderUnavailableException}.
*/
@NotThreadSafe
public static final class Builder extends
DittoRuntimeExceptionBuilder<GatewayAuthenticationProviderUnavailableException> {
private Builder() {
message(DEFAULT_MESSAGE);
description(DEFAULT_DESCRIPTION);
}
@Override
protected GatewayAuthenticationProviderUnavailableException doBuild(final DittoHeaders dittoHeaders,
final String message, final String description, final Throwable cause, final URI href) {
return new GatewayAuthenticationProviderUnavailableException(dittoHeaders, message, description, cause,
href);
}
}
}