/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2014-2016 ForgeRock AS.
 */

package org.forgerock.caf.authentication.framework;

import java.util.Collection;

import org.forgerock.caf.authentication.api.AuthenticationException;
import org.forgerock.caf.authentication.api.MessageContext;
import org.forgerock.guava.common.net.MediaType;

/**
 * Writes {@code AuthenticationException} responses for different media types.
 * Implementations should be thread-safe.
 *
 * @since 2.0.0
 */
public interface ResponseWriter {

    /**
     * Which media types can this handler handle.
     *
     * @return A list of media types.
     */
    Collection<MediaType> handles();

    /**
     * Write the details of the exception out, and set the content type of the response.
     *
     * @param context The {@code MessageContext} containing the response to write the details to.
     * @param exception The {@code AuthenticationException} to be written.
     */
    void write(MessageContext context, AuthenticationException exception);

    /**
     * A short but useful description of this response writer. Description should include the
     * media type this response handler handles.
     */
    @Override
    String toString();
}
