RESTAuthConstants.java

/*******************************************************************************
 * 
 * Copyright 2011-2014 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.client.rest.util;

/**
 * This interface defines the necessary constants to perform a login for a REST service
 * that follows the Novell architecture council standard for tokenized identity
 */
public interface RESTAuthConstants
{
       /**
         * The username JSON token.
         */
        String USERNAME_TOKEN = "user";
        /**
         * The password JSON token.
         */
        String PASSWORD_TOKEN = "pwd";
        /**
         * The authorization URL JSON token.
         */
        String AUTH_URL_TOKEN = "auth-url";
        /**
         * The authorization logout URL JSON token.
         */
        String AUTH_LOGOUT_URL_TOKEN = "auth-logout-url";
        /**
         * The user token JSON token.
         */
        String USER_TOKEN = "token";

        /**
         * An error code indicating the login request was invalid.
         */
        String INVALID_LOGIN_REQUEST = "InvalidLoginRequest";

        /**
         * An error code indicating the current token is no longer valid.
         */
        String INVALID_AUTH_HEADER = "InvalidAuthHeader";

        /**
         * An error code indicating the logout request was invalid.
         */
        String INVALID_LOGOUT_REQUEST = "InvalidLogoutRequest";

        /**
         * An error code indicating the token server URL was invalid.
         */
        String INVALID_TS_URL = "InvalidTokenServerURL";

        /**
         * An error code indicating there were multiple accounts with the same username.
         */
        String MULTIPLE_ACCOUNTS = "MultipleAccounts";

        /**
         * An error code indicating the JSON sent to the AuthServlet was invalid.
         */
        String INVALID_JSON = "InvalidJSONRequest";

        /**
         * An error code indicating the username or password for login was incorrect.
         */
        String INVALID_INPUT = "InvalidInput";

        /**
         * An error code indicating the user is valid, but doesn't have permission to access the application.
         */
        String NO_PRIVILEGE = "NoPrivilege";

        /**
         * An error code indicating the token server URL can't be found.
         */
        String NOTFOUND_TS_URL = "UnFoundTokenServerURL";

        /**
         * An error code indicating the token is gone from the authentication.
         * server.  Normally because it expired.
         */
        String GONE = "Gone";    
}