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-2015 ForgeRock AS.
015 */
016
017package org.forgerock.openig.filter.oauth2.challenge;
018
019import org.forgerock.http.protocol.Response;
020import org.forgerock.http.protocol.Status;
021
022/**
023 * Builds an error {@link Response} when the request does not contains any OAuth 2.0 Bearer token.
024 * <p>
025 * Example:
026 * <pre>
027 *     {@code
028 *     HTTP/1.1 401 Unauthorized
029 *     WWW-Authenticate: Bearer realm="example"
030 *     }
031 * </pre>
032 */
033public class NoAuthenticationChallengeHandler extends AuthenticateChallengeHandler {
034
035    /**
036     * Builds a new NoAuthenticationChallengeHandler.
037     *
038     * @param realm
039     *         mandatory realm value.
040     */
041    public NoAuthenticationChallengeHandler(final String realm) {
042        super(realm, null, null, null);
043    }
044
045    @Override
046    public Response createResponse() {
047        Response response = new Response();
048        response.setStatus(Status.UNAUTHORIZED);
049        return response;
050    }
051}