org.springframework.security.oauth.consumer
Class BaseProtectedResourceDetails

java.lang.Object
  org.springframework.security.oauth.consumer.BaseProtectedResourceDetails

All Implemented Interfaces:

ProtectedResourceDetails

public class BaseProtectedResourceDetails
extends java.lang.Object
implements ProtectedResourceDetails

Basic implementation of protected resource details.

Author:

Ryan Heaton

Constructor Summary

BaseProtectedResourceDetails()

Method Summary

java.lang.String	getAccessTokenURL() The URL to use to obtain an OAuth access token.
java.lang.String	getAuthorizationHeaderRealm() The value of the realm of the authorization header, or null if none.
java.lang.String	getConsumerKey() The consumer key with which to interact with the provider.
java.lang.String	getId() An identifier for these resource details.
java.lang.String	getRequestTokenURL() The URL to use to obtain an OAuth request token.
SignatureSecret	getSharedSecret() The shared signature secret.
java.lang.String	getSignatureMethod() The signature method to use for OAuth requests.
java.lang.String	getUserAuthorizationCallbackParameterName() The parameter name of the callback parameter at the user authorization URL.
java.lang.String	getUserAuthorizationTokenParameterName() The parameter name of the request token parameter at the user authorization URL.
java.lang.String	getUserAuthorizationURL() The URL to which to redirect the user for authorization of access to the protected resource.
boolean	isAcceptsAuthorizationHeader() Whether the provider of this resource accepts the OAuth Authorization HTTP header.
void	setAcceptsAuthorizationHeader(boolean acceptsAuthorizationHeader)
void	setAccessTokenURL(java.lang.String accessTokenURL)
void	setAuthorizationHeaderRealm(java.lang.String authorizationHeaderRealm)
void	setConsumerKey(java.lang.String consumerKey)
void	setId(java.lang.String id)
void	setRequestTokenURL(java.lang.String requestTokenURL)
void	setSharedSecret(SignatureSecret sharedSecret)
void	setSignatureMethod(java.lang.String signatureMethod)
void	setUserAuthorizationCallbackParameterName(java.lang.String userAuthorizationCallbackParameterName)
void	setUserAuthorizationTokenParameterName(java.lang.String userAuthorizationTokenParameterName)
void	setUserAuthorizationURL(java.lang.String userAuthorizationURL)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseProtectedResourceDetails

public BaseProtectedResourceDetails()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: ProtectedResourceDetails

An identifier for these resource details.

Specified by:

getId in interface ProtectedResourceDetails

Returns:

An identifier for these resource details.

setId

public void setId(java.lang.String id)

getConsumerKey

public java.lang.String getConsumerKey()

Description copied from interface: ProtectedResourceDetails

The consumer key with which to interact with the provider.

Specified by:

getConsumerKey in interface ProtectedResourceDetails

Returns:

The consumer key with which to interact with the provider.

setConsumerKey

public void setConsumerKey(java.lang.String consumerKey)

getSignatureMethod

public java.lang.String getSignatureMethod()

Description copied from interface: ProtectedResourceDetails

The signature method to use for OAuth requests.

Specified by:

getSignatureMethod in interface ProtectedResourceDetails

Returns:

The signature method to use for OAuth requests.

setSignatureMethod

public void setSignatureMethod(java.lang.String signatureMethod)

getSharedSecret

public SignatureSecret getSharedSecret()

Description copied from interface: ProtectedResourceDetails

The shared signature secret.

Specified by:

getSharedSecret in interface ProtectedResourceDetails

Returns:

The shared signature secret.

setSharedSecret

public void setSharedSecret(SignatureSecret sharedSecret)

getRequestTokenURL

public java.lang.String getRequestTokenURL()

Description copied from interface: ProtectedResourceDetails

The URL to use to obtain an OAuth request token.

Specified by:

getRequestTokenURL in interface ProtectedResourceDetails

Returns:

The URL to use to obtain an OAuth request token.

setRequestTokenURL

public void setRequestTokenURL(java.lang.String requestTokenURL)

getUserAuthorizationURL

public java.lang.String getUserAuthorizationURL()

Description copied from interface: ProtectedResourceDetails

The URL to which to redirect the user for authorization of access to the protected resource.

Specified by:

getUserAuthorizationURL in interface ProtectedResourceDetails

Returns:

The URL to which to redirect the user for authorization of access to the protected resource.

setUserAuthorizationURL

public void setUserAuthorizationURL(java.lang.String userAuthorizationURL)

getUserAuthorizationTokenParameterName

public java.lang.String getUserAuthorizationTokenParameterName()

Description copied from interface: ProtectedResourceDetails

The parameter name of the request token parameter at the user authorization URL.

Specified by:

getUserAuthorizationTokenParameterName in interface ProtectedResourceDetails

Returns:

The parameter name of the request token parameter at the user authorization URL.

setUserAuthorizationTokenParameterName

public void setUserAuthorizationTokenParameterName(java.lang.String userAuthorizationTokenParameterName)

getUserAuthorizationCallbackParameterName

public java.lang.String getUserAuthorizationCallbackParameterName()

Description copied from interface: ProtectedResourceDetails

The parameter name of the callback parameter at the user authorization URL.

Specified by:

getUserAuthorizationCallbackParameterName in interface ProtectedResourceDetails

Returns:

The parameter name of the the callback parameter at the user authorization URL.

setUserAuthorizationCallbackParameterName

public void setUserAuthorizationCallbackParameterName(java.lang.String userAuthorizationCallbackParameterName)

getAccessTokenURL

public java.lang.String getAccessTokenURL()

Description copied from interface: ProtectedResourceDetails

The URL to use to obtain an OAuth access token.

Specified by:

getAccessTokenURL in interface ProtectedResourceDetails

Returns:

The URL to use to obtain an OAuth access token.

setAccessTokenURL

public void setAccessTokenURL(java.lang.String accessTokenURL)

isAcceptsAuthorizationHeader

public boolean isAcceptsAuthorizationHeader()

Description copied from interface: ProtectedResourceDetails

Whether the provider of this resource accepts the OAuth Authorization HTTP header. Default: true.

Specified by:

isAcceptsAuthorizationHeader in interface ProtectedResourceDetails

Returns:

Whether the provider of this resource accepts the OAuth Authorization HTTP header.

setAcceptsAuthorizationHeader

public void setAcceptsAuthorizationHeader(boolean acceptsAuthorizationHeader)

getAuthorizationHeaderRealm

public java.lang.String getAuthorizationHeaderRealm()

Description copied from interface: ProtectedResourceDetails

The value of the realm of the authorization header, or null if none.

Specified by:

getAuthorizationHeaderRealm in interface ProtectedResourceDetails

Returns:

The value of the realm of the authorization header

setAuthorizationHeaderRealm

public void setAuthorizationHeaderRealm(java.lang.String authorizationHeaderRealm)