SampleAuthUtil.java

/*******************************************************************************
 *
 * Copyright 2012 Spiffy UI Team   
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
package org.spiffyui.spsample.client.rest;

import com.google.gwt.http.client.Response;

import org.spiffyui.client.login.LoginStringHelper;
import org.spiffyui.client.login.LoginStrings;
import org.spiffyui.client.rest.AuthUtil;
import org.spiffyui.client.rest.RESTCallback;
import org.spiffyui.client.rest.RESTException;
import org.spiffyui.client.rest.RESTility;
import org.spiffyui.client.rest.RESTObjectCallBack;
import org.spiffyui.client.rest.v2.RESTOAuthProvider;

/**
 * This is a sample authentication helper to provide custom strings to the login panel
 */
public class SampleAuthUtil extends AuthUtil implements RESTOAuthProvider
{
    @Override
    public String getAuthServerUrl(RESTCallback callback, String tokenServerUrl, Response response, RESTException exception)
    {
        return "/oauthserver";
    }

    @Override
    public String getClientId()
    {
        return null;
    }

    @Override
    public String getScope()
    {
        return null;
    }

    @Override
    public boolean shouldSendRedirectUrl()
    {
        return true;
    }

    @Override
    protected LoginStringHelper getStringHelper()
    {
        return new SPSampleStringHelper();
    }

    @Override
    public void logout(final RESTObjectCallBack<String> callback)
    {
        if (RESTility.getTokenType().equals("Bearer")) {
            /*
             * This gives us a chance to call extra OAuth logout mechanisms,
             * but we don't have those in this sample application so we 
             * just clear the credentials from the client.
             */
            RESTility.doLocalLogout();
            callback.success("");
        } else {
            super.logout(callback);
        }
    }

    /**
     * This class provides a string for the title of the login dialog
     */
    private static class SPSampleStringHelper extends LoginStringHelper
    {
        @Override
        public String getString(LoginStrings msgKey)
        {
            return getString(msgKey, null);
        }

        @Override
        public String getString(LoginStrings msgKey, String arg1)
        {
            if (msgKey.equals(LoginStrings.LOGIN_TITLE)) {
                return "Login with any username and password you want";
            } else {
                return super.getString(msgKey, arg1);
            }

        }
    }

    @Override
    public void error(RESTException e) 
    {
        /*
         * This sample doesn't need to handle any errors.
         */
    }
}