RestLogoutSuccessHandler.java

/*
 * Copyright (C) 2007-2014 Crafter Software Corporation.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.craftercms.security.authentication.impl;

import java.io.IOException;
import javax.servlet.http.HttpServletResponse;

import org.craftercms.commons.http.RequestContext;
import org.craftercms.security.authentication.LogoutSuccessHandler;
import org.craftercms.security.exception.SecurityProviderException;
import org.craftercms.security.utils.handlers.AbstractRestHandlerBase;

/**
 * Implementation of {@link org.craftercms.security.authentication.LogoutSuccessHandler} for REST based applications,
 * which just returns a 200 OK status with a simple success message.
 *
 * @author avasquez
 */
public class RestLogoutSuccessHandler extends AbstractRestHandlerBase implements LogoutSuccessHandler {

    protected static final String DEFAULT_LOGOUT_SUCCESS_MESSAGE = "Logout successful";

    protected String logoutSuccessMessage;

    public RestLogoutSuccessHandler() {
        logoutSuccessMessage = DEFAULT_LOGOUT_SUCCESS_MESSAGE;
    }

    public void setLogoutSuccessMessage(String logoutSuccessMessage) {
        this.logoutSuccessMessage = logoutSuccessMessage;
    }

    @Override
    public void handle(RequestContext context) throws SecurityProviderException, IOException {
        sendMessage(HttpServletResponse.SC_OK, logoutSuccessMessage, context);
    }

}