com.dell.cpsd.service.common.client.callback.ServiceCallback Maven / Gradle / Ivy

Go to download
/**
 * Copyright © 2017 Dell Inc. or its subsidiaries. All Rights Reserved. 
 * Dell EMC Confidential/Proprietary Information
 */

package com.dell.cpsd.service.common.client.callback;

/**
 * This is an implementation of IServiceCallback that is used for synchronous processing of a service request.
 *
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries. All Rights Reserved. 
 * Dell EMC Confidential/Proprietary Information
 * 
 * 
 * @version 1.0
 * 
 * @since 1.0
 */
public class ServiceCallback> implements IServiceCallback
{
    /*
     * The flag to indicate that the callback is complete
     */
    private volatile boolean done            = false;

    /*
     * The service error.
     */
    private ServiceError     error           = null;

    /*
     * The service response
     */
    private T                serviceResponse = null;

    /**
     * ServiceCallback constructor.
     * 
     * @since 1.0
     */
    public ServiceCallback()
    {
        super();
    }

    /**
     * This returns a ServiceError, or null.
     * 
     * @return The ServiceError, or null.
     * 
     * @since 1.0
     */
    public ServiceError getServiceError()
    {
        return this.error;
    }

    /**
     * This returns the ServiceResponse.
     * 
     * @return The response to the service request.
     * 
     * @since 1.0
     */
    public T getServiceResponse()
    {
        return this.serviceResponse;
    }

    /**
     * Tihs returns true if this service callback has completed processing.
     * 
     * @return True if this service callback is done, else false.
     * 
     * @since 1.0
     */
    public boolean isDone()
    {
        return this.done;
    }

    /**
     * This sets the value of the done flag.
     * 
     * @param done
     *            The value of the done flag.
     * 
     * @since 1.0
     */
    public void setDone(final boolean done)
    {
        this.done = done;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void handleServiceError(ServiceError error)
    {
        this.error = error;

        this.setDone(true);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void handleServiceTimeout(ServiceTimeout timeout)
    {
        // do nothing
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void handleServiceResponse(final T serviceResponse)
    {
        this.serviceResponse = serviceResponse;

        this.setDone(true);
    }
}