001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2014 ForgeRock AS.
015 */
016
017package org.forgerock.openig.filter.oauth2.challenge;
018
019import org.forgerock.openig.http.Response;
020
021/**
022 * Builds an error {@link Response} when the request does not contains any OAuth 2.0 Bearer token.
023 * <p>
024 * Example:
025 * <pre>
026 *     HTTP/1.1 401 Unauthorized
027 *     WWW-Authenticate: Bearer realm="example"
028 * </pre>
029 */
030public class NoAuthenticationChallengeHandler extends AuthenticateChallengeHandler {
031
032    /**
033     * Builds a new NoAuthenticationChallengeHandler.
034     *
035     * @param realm
036     *         mandatory realm value.
037     */
038    public NoAuthenticationChallengeHandler(final String realm) {
039        super(realm, null, null, null);
040    }
041
042    @Override
043    public Response createResponse() {
044        Response response = new Response();
045        response.setStatus(401);
046        response.setReason("Unauthorized");
047        return response;
048    }
049}