com.microsoft.store.partnercenter.exception.PartnerResponseParseException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of partnercenter Show documentation
SDK for accessing Microsoft Partner Center API.
There is a newer version: 1.15.3
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See the LICENSE file in the project root for full license information.

package com.microsoft.store.partnercenter.exception;

import java.text.MessageFormat;

import com.microsoft.store.partnercenter.network.PartnerServiceClient;
import com.microsoft.store.partnercenter.requestcontext.IRequestContext;

/**
 * This exception is thrown by {@link PartnerServiceClient} objects when they fail to parse the
 * response according to the caller's expectations.
 */
public class PartnerResponseParseException
    extends PartnerException
{
    private static final long serialVersionUID = 2L;

    private String response;

    /**
     * Initializes a new instance of the PartnerResponseParseException class.
     */
    public PartnerResponseParseException()
    {
        this("");
    }

    /**
     * Initializes a new instance of the PartnerResponseParseException class.
     * 
     * @param message The exception message.
     */
    public PartnerResponseParseException(String message)
    {
        this(message, null);
    }

    /**
     * Initializes a new instance of the PartnerResponseParseException class.
     * 
     * @param message The exception message.
     * @param innerException The exception that is the cause of the current exception, or a null reference if no inner
     *            exception is specified.
     */
    public PartnerResponseParseException(String message, Exception innerException)
    {
        super(message, innerException);
        this.setErrorCategory(PartnerErrorCategory.RESPONSE_PARSING);
    }

    /**
     * Initializes a new instance of the PartnerResponseParseException class.
     * 
     * @param response The HTTP response payload which could not be parsed.
     * @param context The partner context.
     * @param message The exception message.
     * @param innerException The exception that is the cause of the current exception, or a null reference if no inner
     *            exception is specified.
     */
    public PartnerResponseParseException(String response, IRequestContext context, String message, Exception innerException)
    {
        this(message, innerException);
        this.setResponse(response);
        this.setContext(context);
    }

    /**
     * Gets the HTTP response payload that could not be parsed.
     * 
     * @return The HTTP response payload that could not be parsed.
     */
    public String getResponse()
    {
        return response;
    }

    /**
     * Sets the HTTP response payload that could not be parsed.
     * 
     * @param value The HTTP response payload that could not be parsed.
     */
    public void setResponse(String value)
    {
        response = value;
    }

    /**
     * Displays the partner API network exception details.
     * 
     * @return A string representing the network exception including the base and extended properties.
     */
    @Override
    public String toString()
    {
        return MessageFormat.format(
            "PartnerApiParsingException: Response: {0}, Base Description: {1}",
            this.getResponse().toString(), 
            super.toString());
    }
}