You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@oltu.apache.org by si...@apache.org on 2010/07/05 12:23:32 UTC

svn commit: r960525 - /incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java

Author: simonetripodi
Date: Mon Jul  5 10:23:31 2010
New Revision: 960525

URL: http://svn.apache.org/viewvc?rev=960525&view=rev
Log:
The Token can be represented as a final entity rather than an interface.

Modified:
    incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java

Modified: incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java
URL: http://svn.apache.org/viewvc/incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java?rev=960525&r1=960524&r2=960525&view=diff
==============================================================================
--- incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java (original)
+++ incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java Mon Jul  5 10:23:31 2010
@@ -17,6 +17,10 @@
 package org.apache.amber;
 
 import java.io.Serializable;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Set;
 
 /**
  * <p>
@@ -24,46 +28,104 @@ import java.io.Serializable;
  * {@link org.apache.amber.OAuthClient} during the authentication or authorisation
  * process.
  * </p>
- * 
+ *
  * <p>
  * The implementation MUST also support validation of the returned access token
  * values to determine whether the token is authorised or unauthorised.
  * </p>
- * 
+ *
  * <p>
  * A Map contains additional response parameters, sent by the provider.
  * </p>
- * 
- * 
- * @version $Revision$ $Date$
- * 
+ *
+ * @version $Id$
  */
-public interface OAuthToken extends Serializable {
+public final class OAuthToken implements Serializable {
 
     /**
-     * @return the token
+     * The default serialVersionUID.
      */
-    String getToken();
+    private static final long serialVersionUID = 1L;
 
     /**
-     * @param token
+     * The additional response parameters, sent by the provider.
      */
-    void setToken(String token);
+    private final Map<String, String> additionalParameters = new HashMap<String, String>();
 
     /**
-     * @param token
-     * @return outcome
+     * The {@code oauth_token} parameter.
      */
-    boolean matchesToken(String token);
+    private String token;
 
     /**
-     * @return the secret
+     * The {@code oauth_token_secret} parameter.
      */
-    String getSecret();
+    private String tokenSecret;
 
     /**
-     * @param secret
+     * The {@code oauth_callback_confirmed} parameter.
      */
-    void setSecret(String secret);
+    private boolean callbackConfirmed;
 
-}
\ No newline at end of file
+    /**
+     * @return the the {@code oauth_token} parameter.
+     */
+    public String getToken() {
+        return this.token;
+    }
+
+    /**
+     * @param token the {@code oauth_token} parameter.
+     */
+    public void setToken(String token) {
+        this.token = token;
+    }
+
+    /**
+     * @return the {@code oauth_token_secret} parameter.
+     */
+    public String getTokenSecret() {
+        return tokenSecret;
+    }
+
+    /**
+     * @param tokenSecret the {@code oauth_token_secret} parameter.
+     */
+    public void setTokenSecret(String tokenSecret) {
+        this.tokenSecret = tokenSecret;
+    }
+
+    /**
+     * @return the {@code oauth_callback_confirmed} parameter.
+     */
+    public boolean isCallbackConfirmed() {
+        return callbackConfirmed;
+    }
+
+    /**
+     * @param callbackConfirmed the {@code oauth_callback_confirmed} parameter.
+     */
+    public void setCallbackConfirmed(boolean callbackConfirmed) {
+        this.callbackConfirmed = callbackConfirmed;
+    }
+
+    /**
+     * Associates the specified value with the specified name in this additional
+     * parameters map.
+     *
+     * @param name name with which the specified value is to be associated.
+     * @param value value to be associated with the specified name.
+     */
+    public void addAdditionalParameters(String name, String value) {
+        this.additionalParameters.put(name, value);
+    }
+
+    /**
+     * @return a {@link Set} view of the mappings contained in this additional
+     *         parameters map
+     */
+    public Set<Entry<String, String>> additionalParametersEntrySet() {
+        return this.additionalParameters.entrySet();
+    }
+
+}



Re: svn commit: r960525 - /incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java

Posted by Pid <pi...@pidster.com>.
On 5 July 2010 11:47, Simone Tripodi <si...@gmail.com> wrote:
> OK, I didn't think at JPA chance at all, my fault. If you're not
> modifying it, I can rollback it to interface, just let me know.
> Simo

Roll it back. I'm working on something else at the moment.

> PS [OFF TOPIC] did your wife give born to little Pid? :)

Pidlet isn't due for 2 weeks, but it could be anytime from now onwards. :)


p

> http://people.apache.org/~simonetripodi/
> http://www.99soft.org/
>
>
>
> On Mon, Jul 5, 2010 at 12:32 PM, Pid <pi...@pidster.com> wrote:
>> The reason it's an interface is so that a user can pass in any class,
>> e.g. one that extends an existing Principal implementation in a
>> servlet container, or a token that is a JPA POJO.
>>
>> We'd provide a default entity in the implementation, if an existing
>> one isn't used.
>>
>> Sorry, my bad - I should have documented that logic somewhere.
>>
>>
>> p
>>
>> On 5 July 2010 11:23,  <si...@apache.org> wrote:
>>> Author: simonetripodi
>>> Date: Mon Jul  5 10:23:31 2010
>>> New Revision: 960525
>>>
>>> URL: http://svn.apache.org/viewvc?rev=960525&view=rev
>>> Log:
>>> The Token can be represented as a final entity rather than an interface.
>>>
>>> Modified:
>>>    incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java
>>>
>>> Modified: incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java
>>> URL: http://svn.apache.org/viewvc/incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java?rev=960525&r1=960524&r2=960525&view=diff
>>> ==============================================================================
>>> --- incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java (original)
>>> +++ incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java Mon Jul  5 10:23:31 2010
>>> @@ -17,6 +17,10 @@
>>>  package org.apache.amber;
>>>
>>>  import java.io.Serializable;
>>> +import java.util.HashMap;
>>> +import java.util.Map;
>>> +import java.util.Map.Entry;
>>> +import java.util.Set;
>>>
>>>  /**
>>>  * <p>
>>> @@ -24,46 +28,104 @@ import java.io.Serializable;
>>>  * {@link org.apache.amber.OAuthClient} during the authentication or authorisation
>>>  * process.
>>>  * </p>
>>> - *
>>> + *
>>>  * <p>
>>>  * The implementation MUST also support validation of the returned access token
>>>  * values to determine whether the token is authorised or unauthorised.
>>>  * </p>
>>> - *
>>> + *
>>>  * <p>
>>>  * A Map contains additional response parameters, sent by the provider.
>>>  * </p>
>>> - *
>>> - *
>>> - * @version $Revision$ $Date$
>>> - *
>>> + *
>>> + * @version $Id$
>>>  */
>>> -public interface OAuthToken extends Serializable {
>>> +public final class OAuthToken implements Serializable {
>>>
>>>     /**
>>> -     * @return the token
>>> +     * The default serialVersionUID.
>>>      */
>>> -    String getToken();
>>> +    private static final long serialVersionUID = 1L;
>>>
>>>     /**
>>> -     * @param token
>>> +     * The additional response parameters, sent by the provider.
>>>      */
>>> -    void setToken(String token);
>>> +    private final Map<String, String> additionalParameters = new HashMap<String, String>();
>>>
>>>     /**
>>> -     * @param token
>>> -     * @return outcome
>>> +     * The {@code oauth_token} parameter.
>>>      */
>>> -    boolean matchesToken(String token);
>>> +    private String token;
>>>
>>>     /**
>>> -     * @return the secret
>>> +     * The {@code oauth_token_secret} parameter.
>>>      */
>>> -    String getSecret();
>>> +    private String tokenSecret;
>>>
>>>     /**
>>> -     * @param secret
>>> +     * The {@code oauth_callback_confirmed} parameter.
>>>      */
>>> -    void setSecret(String secret);
>>> +    private boolean callbackConfirmed;
>>>
>>> -}
>>> \ No newline at end of file
>>> +    /**
>>> +     * @return the the {@code oauth_token} parameter.
>>> +     */
>>> +    public String getToken() {
>>> +        return this.token;
>>> +    }
>>> +
>>> +    /**
>>> +     * @param token the {@code oauth_token} parameter.
>>> +     */
>>> +    public void setToken(String token) {
>>> +        this.token = token;
>>> +    }
>>> +
>>> +    /**
>>> +     * @return the {@code oauth_token_secret} parameter.
>>> +     */
>>> +    public String getTokenSecret() {
>>> +        return tokenSecret;
>>> +    }
>>> +
>>> +    /**
>>> +     * @param tokenSecret the {@code oauth_token_secret} parameter.
>>> +     */
>>> +    public void setTokenSecret(String tokenSecret) {
>>> +        this.tokenSecret = tokenSecret;
>>> +    }
>>> +
>>> +    /**
>>> +     * @return the {@code oauth_callback_confirmed} parameter.
>>> +     */
>>> +    public boolean isCallbackConfirmed() {
>>> +        return callbackConfirmed;
>>> +    }
>>> +
>>> +    /**
>>> +     * @param callbackConfirmed the {@code oauth_callback_confirmed} parameter.
>>> +     */
>>> +    public void setCallbackConfirmed(boolean callbackConfirmed) {
>>> +        this.callbackConfirmed = callbackConfirmed;
>>> +    }
>>> +
>>> +    /**
>>> +     * Associates the specified value with the specified name in this additional
>>> +     * parameters map.
>>> +     *
>>> +     * @param name name with which the specified value is to be associated.
>>> +     * @param value value to be associated with the specified name.
>>> +     */
>>> +    public void addAdditionalParameters(String name, String value) {
>>> +        this.additionalParameters.put(name, value);
>>> +    }
>>> +
>>> +    /**
>>> +     * @return a {@link Set} view of the mappings contained in this additional
>>> +     *         parameters map
>>> +     */
>>> +    public Set<Entry<String, String>> additionalParametersEntrySet() {
>>> +        return this.additionalParameters.entrySet();
>>> +    }
>>> +
>>> +}
>>>
>>>
>>>
>>
>>
>>
>> --
>>
>> --
>> pidster.com
>>
>



-- 

--
pidster.com

Re: svn commit: r960525 - /incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java

Posted by Simone Tripodi <si...@gmail.com>.
OK, I didn't think at JPA chance at all, my fault. If you're not
modifying it, I can rollback it to interface, just let me know.
Simo

PS [OFF TOPIC] did your wife give born to little Pid? :)

http://people.apache.org/~simonetripodi/
http://www.99soft.org/



On Mon, Jul 5, 2010 at 12:32 PM, Pid <pi...@pidster.com> wrote:
> The reason it's an interface is so that a user can pass in any class,
> e.g. one that extends an existing Principal implementation in a
> servlet container, or a token that is a JPA POJO.
>
> We'd provide a default entity in the implementation, if an existing
> one isn't used.
>
> Sorry, my bad - I should have documented that logic somewhere.
>
>
> p
>
> On 5 July 2010 11:23,  <si...@apache.org> wrote:
>> Author: simonetripodi
>> Date: Mon Jul  5 10:23:31 2010
>> New Revision: 960525
>>
>> URL: http://svn.apache.org/viewvc?rev=960525&view=rev
>> Log:
>> The Token can be represented as a final entity rather than an interface.
>>
>> Modified:
>>    incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java
>>
>> Modified: incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java
>> URL: http://svn.apache.org/viewvc/incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java?rev=960525&r1=960524&r2=960525&view=diff
>> ==============================================================================
>> --- incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java (original)
>> +++ incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java Mon Jul  5 10:23:31 2010
>> @@ -17,6 +17,10 @@
>>  package org.apache.amber;
>>
>>  import java.io.Serializable;
>> +import java.util.HashMap;
>> +import java.util.Map;
>> +import java.util.Map.Entry;
>> +import java.util.Set;
>>
>>  /**
>>  * <p>
>> @@ -24,46 +28,104 @@ import java.io.Serializable;
>>  * {@link org.apache.amber.OAuthClient} during the authentication or authorisation
>>  * process.
>>  * </p>
>> - *
>> + *
>>  * <p>
>>  * The implementation MUST also support validation of the returned access token
>>  * values to determine whether the token is authorised or unauthorised.
>>  * </p>
>> - *
>> + *
>>  * <p>
>>  * A Map contains additional response parameters, sent by the provider.
>>  * </p>
>> - *
>> - *
>> - * @version $Revision$ $Date$
>> - *
>> + *
>> + * @version $Id$
>>  */
>> -public interface OAuthToken extends Serializable {
>> +public final class OAuthToken implements Serializable {
>>
>>     /**
>> -     * @return the token
>> +     * The default serialVersionUID.
>>      */
>> -    String getToken();
>> +    private static final long serialVersionUID = 1L;
>>
>>     /**
>> -     * @param token
>> +     * The additional response parameters, sent by the provider.
>>      */
>> -    void setToken(String token);
>> +    private final Map<String, String> additionalParameters = new HashMap<String, String>();
>>
>>     /**
>> -     * @param token
>> -     * @return outcome
>> +     * The {@code oauth_token} parameter.
>>      */
>> -    boolean matchesToken(String token);
>> +    private String token;
>>
>>     /**
>> -     * @return the secret
>> +     * The {@code oauth_token_secret} parameter.
>>      */
>> -    String getSecret();
>> +    private String tokenSecret;
>>
>>     /**
>> -     * @param secret
>> +     * The {@code oauth_callback_confirmed} parameter.
>>      */
>> -    void setSecret(String secret);
>> +    private boolean callbackConfirmed;
>>
>> -}
>> \ No newline at end of file
>> +    /**
>> +     * @return the the {@code oauth_token} parameter.
>> +     */
>> +    public String getToken() {
>> +        return this.token;
>> +    }
>> +
>> +    /**
>> +     * @param token the {@code oauth_token} parameter.
>> +     */
>> +    public void setToken(String token) {
>> +        this.token = token;
>> +    }
>> +
>> +    /**
>> +     * @return the {@code oauth_token_secret} parameter.
>> +     */
>> +    public String getTokenSecret() {
>> +        return tokenSecret;
>> +    }
>> +
>> +    /**
>> +     * @param tokenSecret the {@code oauth_token_secret} parameter.
>> +     */
>> +    public void setTokenSecret(String tokenSecret) {
>> +        this.tokenSecret = tokenSecret;
>> +    }
>> +
>> +    /**
>> +     * @return the {@code oauth_callback_confirmed} parameter.
>> +     */
>> +    public boolean isCallbackConfirmed() {
>> +        return callbackConfirmed;
>> +    }
>> +
>> +    /**
>> +     * @param callbackConfirmed the {@code oauth_callback_confirmed} parameter.
>> +     */
>> +    public void setCallbackConfirmed(boolean callbackConfirmed) {
>> +        this.callbackConfirmed = callbackConfirmed;
>> +    }
>> +
>> +    /**
>> +     * Associates the specified value with the specified name in this additional
>> +     * parameters map.
>> +     *
>> +     * @param name name with which the specified value is to be associated.
>> +     * @param value value to be associated with the specified name.
>> +     */
>> +    public void addAdditionalParameters(String name, String value) {
>> +        this.additionalParameters.put(name, value);
>> +    }
>> +
>> +    /**
>> +     * @return a {@link Set} view of the mappings contained in this additional
>> +     *         parameters map
>> +     */
>> +    public Set<Entry<String, String>> additionalParametersEntrySet() {
>> +        return this.additionalParameters.entrySet();
>> +    }
>> +
>> +}
>>
>>
>>
>
>
>
> --
>
> --
> pidster.com
>

Re: svn commit: r960525 - /incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java

Posted by Pid <pi...@pidster.com>.
The reason it's an interface is so that a user can pass in any class,
e.g. one that extends an existing Principal implementation in a
servlet container, or a token that is a JPA POJO.

We'd provide a default entity in the implementation, if an existing
one isn't used.

Sorry, my bad - I should have documented that logic somewhere.


p

On 5 July 2010 11:23,  <si...@apache.org> wrote:
> Author: simonetripodi
> Date: Mon Jul  5 10:23:31 2010
> New Revision: 960525
>
> URL: http://svn.apache.org/viewvc?rev=960525&view=rev
> Log:
> The Token can be represented as a final entity rather than an interface.
>
> Modified:
>    incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java
>
> Modified: incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java
> URL: http://svn.apache.org/viewvc/incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java?rev=960525&r1=960524&r2=960525&view=diff
> ==============================================================================
> --- incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java (original)
> +++ incubator/amber/trunk/spec-api/src/main/java/org/apache/amber/OAuthToken.java Mon Jul  5 10:23:31 2010
> @@ -17,6 +17,10 @@
>  package org.apache.amber;
>
>  import java.io.Serializable;
> +import java.util.HashMap;
> +import java.util.Map;
> +import java.util.Map.Entry;
> +import java.util.Set;
>
>  /**
>  * <p>
> @@ -24,46 +28,104 @@ import java.io.Serializable;
>  * {@link org.apache.amber.OAuthClient} during the authentication or authorisation
>  * process.
>  * </p>
> - *
> + *
>  * <p>
>  * The implementation MUST also support validation of the returned access token
>  * values to determine whether the token is authorised or unauthorised.
>  * </p>
> - *
> + *
>  * <p>
>  * A Map contains additional response parameters, sent by the provider.
>  * </p>
> - *
> - *
> - * @version $Revision$ $Date$
> - *
> + *
> + * @version $Id$
>  */
> -public interface OAuthToken extends Serializable {
> +public final class OAuthToken implements Serializable {
>
>     /**
> -     * @return the token
> +     * The default serialVersionUID.
>      */
> -    String getToken();
> +    private static final long serialVersionUID = 1L;
>
>     /**
> -     * @param token
> +     * The additional response parameters, sent by the provider.
>      */
> -    void setToken(String token);
> +    private final Map<String, String> additionalParameters = new HashMap<String, String>();
>
>     /**
> -     * @param token
> -     * @return outcome
> +     * The {@code oauth_token} parameter.
>      */
> -    boolean matchesToken(String token);
> +    private String token;
>
>     /**
> -     * @return the secret
> +     * The {@code oauth_token_secret} parameter.
>      */
> -    String getSecret();
> +    private String tokenSecret;
>
>     /**
> -     * @param secret
> +     * The {@code oauth_callback_confirmed} parameter.
>      */
> -    void setSecret(String secret);
> +    private boolean callbackConfirmed;
>
> -}
> \ No newline at end of file
> +    /**
> +     * @return the the {@code oauth_token} parameter.
> +     */
> +    public String getToken() {
> +        return this.token;
> +    }
> +
> +    /**
> +     * @param token the {@code oauth_token} parameter.
> +     */
> +    public void setToken(String token) {
> +        this.token = token;
> +    }
> +
> +    /**
> +     * @return the {@code oauth_token_secret} parameter.
> +     */
> +    public String getTokenSecret() {
> +        return tokenSecret;
> +    }
> +
> +    /**
> +     * @param tokenSecret the {@code oauth_token_secret} parameter.
> +     */
> +    public void setTokenSecret(String tokenSecret) {
> +        this.tokenSecret = tokenSecret;
> +    }
> +
> +    /**
> +     * @return the {@code oauth_callback_confirmed} parameter.
> +     */
> +    public boolean isCallbackConfirmed() {
> +        return callbackConfirmed;
> +    }
> +
> +    /**
> +     * @param callbackConfirmed the {@code oauth_callback_confirmed} parameter.
> +     */
> +    public void setCallbackConfirmed(boolean callbackConfirmed) {
> +        this.callbackConfirmed = callbackConfirmed;
> +    }
> +
> +    /**
> +     * Associates the specified value with the specified name in this additional
> +     * parameters map.
> +     *
> +     * @param name name with which the specified value is to be associated.
> +     * @param value value to be associated with the specified name.
> +     */
> +    public void addAdditionalParameters(String name, String value) {
> +        this.additionalParameters.put(name, value);
> +    }
> +
> +    /**
> +     * @return a {@link Set} view of the mappings contained in this additional
> +     *         parameters map
> +     */
> +    public Set<Entry<String, String>> additionalParametersEntrySet() {
> +        return this.additionalParameters.entrySet();
> +    }
> +
> +}
>
>
>



-- 

--
pidster.com