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
032import java.lang.annotation.Documented;
033import java.lang.annotation.ElementType;
034import java.lang.annotation.Retention;
035import java.lang.annotation.RetentionPolicy;
036import java.lang.annotation.Target;
037
038/**
039 * Metadata describing an API token
040 * 
041 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 * 
043 */
044@Retention(value = RetentionPolicy.RUNTIME)
045@Target(value = ElementType.TYPE)
046@Documented
047public @interface Token {
048        /**
049         * Get the name of the API with which this token is used
050         * 
051         * @return the name of the API with which this token is used
052         */
053        String name();
054
055        /**
056         * Get any additional information about this token or the mechanism by which
057         * a user should go about getting the parameters. This might displayed to
058         * the user by a {@link TokenFactory} when querying the user for the
059         * {@link Parameter}s required to access the API.
060         * 
061         * @return additional information about the API and getting the required
062         *         {@link Parameter}s.
063         */
064        String extraInfo() default "";
065
066        /**
067         * Get the URL at which the API parameters can be obtained (usually by the
068         * user registering for an account, etc).
069         * 
070         * @return the URL at which the API parameters can be obtained.
071         */
072        String url();
073}