org.springframework.security.oauth.consumer

Interface ProtectedResourceDetails

All Known Implementing Classes:

BaseProtectedResourceDetails

public interface ProtectedResourceDetails

Details about a protected resource.

Author:

Ryan Heaton, Andrew McCall

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccessTokenHttpMethod() The HTTP method to use with getAccessTokenURL()
String	getAccessTokenURL() The URL to use to obtain an OAuth access token.
Map<String,String>	getAdditionalParameters() The additional OAuth parameters for this protected resource.
Map<String,String>	getAdditionalRequestHeaders() The additional request headers to send.
String	getAuthorizationHeaderRealm() The value of the realm of the authorization header, or null if none.
String	getConsumerKey() The consumer key with which to interact with the provider.
String	getId() An identifier for these resource details.
String	getRequestTokenHttpMethod() The HTTP method to use with getRequestTokenURL()
String	getRequestTokenURL() The URL to use to obtain an OAuth request token.
SignatureSecret	getSharedSecret() The shared signature secret.
String	getSignatureMethod() The signature method to use for OAuth requests.
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.
boolean	isUse10a() Whether to use OAuth Core 1.0a.

Method Detail

getId

String getId()

An identifier for these resource details.

Returns:

An identifier for these resource details.

getConsumerKey

String getConsumerKey()

The consumer key with which to interact with the provider.

Returns:

The consumer key with which to interact with the provider.

getSignatureMethod

String getSignatureMethod()

The signature method to use for OAuth requests.

Returns:

The signature method to use for OAuth requests.

getSharedSecret

SignatureSecret getSharedSecret()

The shared signature secret.

Returns:

The shared signature secret.

getRequestTokenURL

String getRequestTokenURL()

The URL to use to obtain an OAuth request token.

Returns:

The URL to use to obtain an OAuth request token.

getRequestTokenHttpMethod

String getRequestTokenHttpMethod()

The HTTP method to use with getRequestTokenURL()

Returns:

the HTTP method to use with getRequestTokenURL()

getUserAuthorizationURL

String getUserAuthorizationURL()

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

Returns:

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

getAccessTokenURL

String getAccessTokenURL()

The URL to use to obtain an OAuth access token.

Returns:

The URL to use to obtain an OAuth access token.

getAccessTokenHttpMethod

String getAccessTokenHttpMethod()

The HTTP method to use with getAccessTokenURL()

Returns:

the HTTP method to use with getAccessTokenURL()

isAcceptsAuthorizationHeader

boolean isAcceptsAuthorizationHeader()

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

Returns:

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

getAuthorizationHeaderRealm

String getAuthorizationHeaderRealm()

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

Returns:

The value of the realm of the authorization header

isUse10a

boolean isUse10a()

Whether to use OAuth Core 1.0a.

Returns:

Whether to use OAuth Core 1.0a.

getAdditionalParameters

Map<String,String> getAdditionalParameters()

The additional OAuth parameters for this protected resource.

Returns:

The additional OAuth parameters for this protected resource, or null if none.

getAdditionalRequestHeaders

Map<String,String> getAdditionalRequestHeaders()

The additional request headers to send.

Returns:

The additional request headers to send.