/*
* Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.yangtools.yang.common;
import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
/**
* A builder for creating RpcResult instances.
*
* @author Thomas Pantelis
*
* @param <T> the result value type
*/
public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
private static class RpcResultImpl<T> implements RpcResult<T>, Serializable {
private static final long serialVersionUID = 1L;
private final Collection<RpcError> errors;
private final T result;
private final boolean successful;
RpcResultImpl( final boolean successful, final T result,
final Collection<RpcError> errors ) {
this.successful = successful;
this.result = result;
this.errors = errors;
}
@Override
public Collection<RpcError> getErrors() {
return errors;
}
@Override
public T getResult() {
return result;
}
@Override
public boolean isSuccessful() {
return successful;
}
@Override
public String toString() {
return "RpcResult [successful=" + successful + ", result="
+ result + ", errors=" + errors + "]";
}
}
private static class RpcErrorImpl implements RpcError, Serializable {
private static final long serialVersionUID = 1L;
private final String applicationTag;
private final String tag;
private final String info;
private final ErrorSeverity severity;
private final String message;
private final ErrorType errorType;
private final Throwable cause;
RpcErrorImpl( final ErrorSeverity severity, final ErrorType errorType,
final String tag, final String message, final String applicationTag, final String info,
final Throwable cause ) {
this.severity = severity;
this.errorType = errorType;
this.tag = tag;
this.message = message;
this.applicationTag = applicationTag;
this.info = info;
this.cause = cause;
}
@Override
public String getApplicationTag() {
return applicationTag;
}
@Override
public String getTag() {
return tag;
}
@Override
public String getInfo() {
return info;
}
@Override
public ErrorSeverity getSeverity() {
return severity;
}
@Override
public String getMessage() {
return message;
}
@Override
public ErrorType getErrorType() {
return errorType;
}
@Override
public Throwable getCause() {
return cause;
}
@Override
public String toString() {
return "RpcError [message=" + message + ", severity="
+ severity + ", errorType=" + errorType + ", tag=" + tag
+ ", applicationTag=" + applicationTag + ", info=" + info
+ ", cause=" + cause + "]";
}
}
private ImmutableList.Builder<RpcError> errors;
private T result;
private final boolean successful;
private RpcResultBuilder( final boolean successful, final T result ) {
this.successful = successful;
this.result = result;
}
/**
* Returns a builder for a successful result.
*/
public static <T> RpcResultBuilder<T> success() {
return new RpcResultBuilder<>(true, null);
}
/**
* Returns a builder for a successful result.
*
* @param result the result value
*/
public static <T> RpcResultBuilder<T> success( final T result ) {
return new RpcResultBuilder<>(true, result);
}
/**
* Returns a builder for a successful result.
*
* @param builder builder for the result value
*/
public static <T> RpcResultBuilder<T> success( final Builder<T> builder ) {
return success(builder.build());
}
/**
* Returns a builder for a failed result.
*/
public static <T> RpcResultBuilder<T> failed() {
return new RpcResultBuilder<>(false, null);
}
/**
* Returns a builder based on the given status.
*
* @param success true if successful, false otherwise.
*/
public static <T> RpcResultBuilder<T> status( final boolean success ) {
return new RpcResultBuilder<>(success, null);
}
/**
* Returns a builder from another RpcResult.
*
* @param other the other RpcResult.
*/
public static <T> RpcResultBuilder<T> from( final RpcResult<T> other ) {
return new RpcResultBuilder<>(other.isSuccessful(), other.getResult())
.withRpcErrors( other.getErrors() );
}
/**
* Creates an RpcError with severity ERROR for reuse.
*
* @param errorType the conceptual layer at which the error occurred.
* @param tag a short string that identifies the general type of error condition. See
* {@link RpcError#getTag} for a list of suggested values.
* @param message a string suitable for human display that describes the error condition.
*
* @return an RpcError
*/
public static RpcError newError( final ErrorType errorType, final String tag, final String message ) {
return new RpcErrorImpl( ErrorSeverity.ERROR, errorType,
tag != null ? tag : "operation-failed", message, null, null, null );
}
/**
* Creates an RpcError with severity ERROR for reuse.
*
* @param errorType the conceptual layer at which the error occurred.
* @param tag a short string that identifies the general type of error condition. See
* {@link RpcError#getTag} for a list of suggested values.
* @param message a string suitable for human display that describes the error condition.
* * @param applicationTag a short string that identifies the specific type of error condition.
* @param info a string containing additional information to provide extended
* and/or implementation-specific debugging information.
* @param cause the exception that triggered the error.
*
* @return an RpcError
*/
public static RpcError newError( final ErrorType errorType, final String tag, final String message,
final String applicationTag, final String info, final Throwable cause ) {
return new RpcErrorImpl( ErrorSeverity.ERROR, errorType,
tag != null ? tag : "operation-failed", message, applicationTag, info, cause );
}
/**
* Creates an RpcError with severity WARNING for reuse.
*
* @param errorType the conceptual layer at which the warning occurred.
* @param tag a short string that identifies the general type of warning condition. See
* {@link RpcError#getTag} for a list of suggested values.
* @param message a string suitable for human display that describes the warning condition.
*
* @return an RpcError
*/
public static RpcError newWarning( final ErrorType errorType, final String tag, final String message ) {
return new RpcErrorImpl( ErrorSeverity.WARNING, errorType, tag, message, null, null, null );
}
/**
* Creates an RpcError with severity WARNING for reuse.
*
* @param errorType the conceptual layer at which the warning occurred.
* @param tag a short string that identifies the general type of warning condition. See
* {@link RpcError#getTag} for a list of suggested values.
* @param message a string suitable for human display that describes the warning condition.
* * @param applicationTag a short string that identifies the specific type of warning condition.
* @param info a string containing additional information to provide extended
* and/or implementation-specific debugging information.
* @param cause the exception that triggered the warning.
*
* @return an RpcError
*/
public static RpcError newWarning( final ErrorType errorType, final String tag, final String message,
final String applicationTag, final String info, final Throwable cause ) {
return new RpcErrorImpl( ErrorSeverity.WARNING, errorType, tag, message,
applicationTag, info, cause );
}
/**
* Sets the value of the result.
*
* @param result the result value
*/
public RpcResultBuilder<T> withResult( final T result ) {
this.result = result;
return this;
}
/**
* Sets the value of the result.
*
* @param builder builder for the result value
*/
public RpcResultBuilder<T> withResult( final Builder<T> builder ) {
return withResult(builder.build());
}
private void addError( final ErrorSeverity severity, final ErrorType errorType,
final String tag, final String message, final String applicationTag, final String info,
final Throwable cause ) {
addError( new RpcErrorImpl( severity, errorType,
tag != null ? tag : "operation-failed", message,
applicationTag, info, cause ) );
}
private void addError( final RpcError error ) {
if (errors == null) {
errors = new ImmutableList.Builder<>();
}
errors.add( error );
}
/**
* Adds a warning to the result.
*
* @param errorType the conceptual layer at which the warning occurred.
* @param tag a short string that identifies the general type of warning condition. See
* {@link RpcError#getTag} for a list of suggested values.
* @param message a string suitable for human display that describes the warning condition.
*/
public RpcResultBuilder<T> withWarning( final ErrorType errorType, final String tag, final String message ) {
addError( ErrorSeverity.WARNING, errorType, tag, message, null, null, null );
return this;
}
/**
* Adds a warning to the result.
*
* @param errorType the conceptual layer at which the warning occurred.
* @param tag a short string that identifies the general type of warning condition. See
* {@link RpcError#getTag} for a list of suggested values.
* @param message a string suitable for human display that describes the warning condition.
* @param applicationTag a short string that identifies the specific type of warning condition.
* @param info a string containing additional information to provide extended
* and/or implementation-specific debugging information.
* @param cause the exception that triggered the warning.
*/
public RpcResultBuilder<T> withWarning( final ErrorType errorType, final String tag, final String message,
final String applicationTag, final String info, final Throwable cause ) {
addError( ErrorSeverity.WARNING, errorType, tag, message, applicationTag, info, cause );
return this;
}
/**
* Adds an error to the result. The general error tag defaults to "operation-failed".
*
* @param errorType the conceptual layer at which the error occurred.
* @param message a string suitable for human display that describes the error condition.
*/
public RpcResultBuilder<T> withError( final ErrorType errorType, final String message ) {
addError( ErrorSeverity.ERROR, errorType, null, message, null, null, null );
return this;
}
/**
* Adds an error to the result.
*
* @param errorType the conceptual layer at which the error occurred.
* @param tag a short string that identifies the general type of error condition. See
* {@link RpcError#getTag} for a list of suggested values.
* @param message a string suitable for human display that describes the error condition.
*/
public RpcResultBuilder<T> withError( final ErrorType errorType, final String tag, final String message ) {
addError( ErrorSeverity.ERROR, errorType, tag, message, null, null, null );
return this;
}
/**
* Adds an error to the result. The general error tag defaults to "operation-failed".
*
* @param errorType the conceptual layer at which the error occurred.
* @param message a string suitable for human display that describes the error condition.
* @param cause the exception that triggered the error.
*/
public RpcResultBuilder<T> withError( final ErrorType errorType, final String message,
final Throwable cause ) {
addError( ErrorSeverity.ERROR, errorType, null, message, null, null, cause );
return this;
}
/**
* Adds an error to the result.
*
* @param errorType the conceptual layer at which the error occurred.
* @param tag a short string that identifies the general type of error condition. See
* {@link RpcError#getTag} for a list of suggested values.
* @param message a string suitable for human display that describes the error condition.
* @param applicationTag a short string that identifies the specific type of error condition.
* @param info a string containing additional information to provide extended
* and/or implementation-specific debugging information.
* @param cause the exception that triggered the error.
*/
public RpcResultBuilder<T> withError( final ErrorType errorType, final String tag, final String message,
final String applicationTag, final String info, final Throwable cause ) {
addError( ErrorSeverity.ERROR, errorType, tag, message, applicationTag, info, cause );
return this;
}
/**
* Adds an RpcError.
*
* @param error the RpcError
*/
public RpcResultBuilder<T> withRpcError( final RpcError error ) {
addError( error );
return this;
}
/**
* Adds RpcErrors.
*
* @param errors the list of RpcErrors
*/
public RpcResultBuilder<T> withRpcErrors( final Collection<RpcError> errors ) {
if (errors != null) {
for (RpcError error : errors) {
addError( error );
}
}
return this;
}
@Override
public RpcResult<T> build() {
return new RpcResultImpl<>(successful, result,
errors != null ? errors.build() : Collections.emptyList());
}
/**
* Builds RpcResult and wraps it in a Future
*
* This is a convenience method to assist those writing rpcs
* that produce immediate results. It allows you to replace
*
* Futures.immediateFuture(rpcResult.build())
*
* with
*
* rpcResult.buildFuture();
*
* @return Future for RpcResult built by RpcResultBuilder
*
*/
public ListenableFuture<RpcResult<T>> buildFuture() {
return Futures.immediateFuture(build());
}
}