org.restlet.ext.oauth
Class OAuthForm

java.lang.Object
  extended by org.restlet.util.WrapperList<T>
      extended by org.restlet.util.Series<Parameter>
          extended by org.restlet.data.Form
              extended by org.restlet.ext.oauth.OAuthForm
All Implemented Interfaces:
Iterable<Parameter>, Collection<Parameter>, List<Parameter>

public class OAuthForm
extends Form

Helper class used when the OAuth token should be transmitted as a form. Only viable for HTTP PUT, POST and DELETE Still the best practice as a client is to set the token in "Authorization" HTTP header.

Author:
Kristoffer Gronowski

Field Summary
 
Fields inherited from class org.restlet.util.Series
EMPTY_VALUE
 
Constructor Summary
OAuthForm(String token)
          Constructor.
OAuthForm(String token, int initialCapacity)
          Constructor.
OAuthForm(String token, List<Parameter> delegate)
          Constructor.
OAuthForm(String token, Representation webForm)
          Constructor.
OAuthForm(String token, String queryString)
          Constructor.
OAuthForm(String token, String parametersString, char separator)
          Constructor.
OAuthForm(String token, String queryString, CharacterSet characterSet)
          Constructor.
OAuthForm(String token, String parametersString, CharacterSet characterSet, char separator)
          Constructor.
 
Method Summary
 String getOAuthToken()
          Returns the value of the OAuthServerResource.OAUTH_TOKEN token.
 
Methods inherited from class org.restlet.data.Form
createEntry, encode, encode, encode, getMatrixString, getMatrixString, getQueryString, getQueryString, getWebRepresentation, getWebRepresentation
 
Methods inherited from class org.restlet.util.Series
add, copyTo, createSeries, getFirst, getFirst, getFirstValue, getFirstValue, getFirstValue, getFirstValue, getNames, getValues, getValues, getValuesArray, getValuesArray, getValuesArray, getValuesArray, getValuesMap, removeAll, removeAll, removeFirst, removeFirst, set, set, subList, subList, subList, unmodifiableSeries
 
Methods inherited from class org.restlet.util.WrapperList
add, add, addAll, addAll, clear, contains, containsAll, equals, get, getDelegate, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OAuthForm

public OAuthForm(String token)
Constructor.

Parameters:
token - The value of the OAuthServerResource.OAUTH_TOKEN token.

OAuthForm

public OAuthForm(String token,
                 int initialCapacity)
Constructor.

Parameters:
token - The value of the OAuthServerResource.OAUTH_TOKEN token.
initialCapacity - The initial list capacity.

OAuthForm

public OAuthForm(String token,
                 List<Parameter> delegate)
Constructor.

Parameters:
token - The value of the OAuthServerResource.OAUTH_TOKEN token.
delegate - The delegate list.

OAuthForm

public OAuthForm(String token,
                 Representation webForm)
Constructor.

Parameters:
token - The value of the OAuthServerResource.OAUTH_TOKEN token.
webForm - The URL encoded Web form.

OAuthForm

public OAuthForm(String token,
                 String queryString)
Constructor.

Parameters:
token - The value of the OAuthServerResource.OAUTH_TOKEN token.
queryString - The Web form parameters as a string.

OAuthForm

public OAuthForm(String token,
                 String parametersString,
                 char separator)
Constructor.

Parameters:
token - The value of the OAuthServerResource.OAUTH_TOKEN token.
parametersString - The parameters string to parse.
separator - The separator character to append between parameters.

OAuthForm

public OAuthForm(String token,
                 String queryString,
                 CharacterSet characterSet)
Constructor.

Parameters:
token - The value of the OAuthServerResource.OAUTH_TOKEN token.
queryString - The Web form parameters as a string.
characterSet - The supported character encoding.

OAuthForm

public OAuthForm(String token,
                 String parametersString,
                 CharacterSet characterSet,
                 char separator)
Constructor.

Parameters:
token - The value of the OAuthServerResource.OAUTH_TOKEN token.
parametersString - The parameters string to parse.
characterSet - The supported character encoding.
separator - The separator character to append between parameters.
Method Detail

getOAuthToken

public String getOAuthToken()
Returns the value of the OAuthServerResource.OAUTH_TOKEN token.

Returns:
The value of the OAuthServerResource.OAUTH_TOKEN token.


Copyright © 2005-2013 Restlet.