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.common;
031
032import org.openimaj.util.api.auth.Parameter;
033import org.openimaj.util.api.auth.Token;
034
035/**
036 * An authentication token for the Twitter API.
037 * 
038 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 */
040@Token(name = "Twitter API", url = "https://dev.twitter.com/apps/new")
041public class TwitterAPIToken {
042        /**
043         * The consumer key
044         */
045        @Parameter(name = "Consumer Key")
046        public String consumerKey;
047
048        /**
049         * The consumer secret
050         */
051        @Parameter(name = "Consumer Secret")
052        public String consumerSecret;
053
054        /**
055         * The access token
056         */
057        @Parameter(name = "Access Token")
058        public String accessToken;
059
060        /**
061         * The access secret
062         */
063        @Parameter(name = "Access Secret")
064        public String accessSecret;
065
066        /**
067         * Construct an empty token.
068         */
069        public TwitterAPIToken() {
070
071        }
072
073        /**
074         * Construct a token with the given parameters.
075         * 
076         * @param consumerKey
077         *            the consumer key
078         * @param consumerSecret
079         *            the consumer secret
080         * @param accessToken
081         *            the access token
082         * @param accessSecret
083         *            the access secret
084         */
085        public TwitterAPIToken(String consumerKey, String consumerSecret, String accessToken, String accessSecret) {
086                this.consumerKey = consumerKey;
087                this.consumerSecret = consumerSecret;
088                this.accessToken = accessToken;
089                this.accessSecret = accessSecret;
090        }
091}