001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.util.api.auth;
031
032/**
033 * Interface describing a class capable of providing API tokens. See the
034 * {@link DefaultTokenFactory} for an implementation that stores tokens in the
035 * Java Preference system and can interactively query the user for the required
036 * parameters if they don't have a saved token.
037 * <p>
038 * The tokens produced by a {@link TokenFactory} must be instances of a class
039 * which is annotated with {@link Token}, and with fields annotated with
040 * {@link Parameter}.
041 * 
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 */
044public interface TokenFactory {
045        /**
046         * Get the default token for the given class.
047         * <p>
048         * If a predefined token is unavailable, the token might be built by the
049         * underlying implementation; for example by interacting with the user.
050         * 
051         * @param tokenClass
052         *            the class of the token to build
053         * @return the token
054         */
055        <T> T getToken(Class<T> tokenClass);
056
057        /**
058         * Get the token for the given class, tagged with a specific name. This is
059         * useful if you have are multiple authentication tokens for the same API
060         * and want to refer to a specific one.
061         * <p>
062         * If a predefined token is unavailable, the token might be built by the
063         * underlying implementation; for example by interacting with the user.
064         * 
065         * @param tokenClass
066         *            the class of the token to build
067         * @param name
068         *            the name of the token
069         * @return the token
070         */
071        <T> T getToken(Class<T> tokenClass, String name);
072}