001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.camel.component.gae.login;
018    
019    /**
020     * Interface to login services. 
021     */
022    public interface GLoginService {
023    
024        /**
025         * Authenticates a user and stores the authentication token to
026         * {@link GLoginData#setAuthenticationToken(String)} (only if needed by
027         * {@link #authorize(GLoginData)}).
028         * 
029         * @param data
030         *            authentication input data and response data (authentication
031         *            token) container.
032         * @throws Exception
033         */
034        void authenticate(GLoginData data) throws Exception;
035    
036        /**
037         * Authorizes access to an application and stores an authorization cookie to
038         * {@link GLoginData#setAuthorizationCookie(String)}.
039         * 
040         * @param data
041         *            authentication input data and response data (authorization
042         *            cookie) container.
043         * @throws Exception
044         */
045        void authorize(GLoginData data) throws Exception;
046    
047    }