org.springframework.security.oauth.provider
Class BaseConsumerDetails

java.lang.Object
  extended by org.springframework.security.oauth.provider.BaseConsumerDetails
All Implemented Interfaces:
Serializable, ConsumerDetails, ExtraTrustConsumerDetails, ResourceSpecificConsumerDetails
Direct Known Subclasses:
SparklrConsumerDetails

public class BaseConsumerDetails
extends Object
implements ResourceSpecificConsumerDetails, ExtraTrustConsumerDetails

Base implementation for consumer details.

Author:
Ryan Heaton, Andrew McCall
See Also:
Serialized Form

Constructor Summary
BaseConsumerDetails()
           
 
Method Summary
 List<org.springframework.security.core.GrantedAuthority> getAuthorities()
          The base authorities for this consumer.
 String getConsumerKey()
          The consumer key.
 String getConsumerName()
          The name of the consumer.
 String getResourceDescription()
          The description of the resource.
 String getResourceName()
          The name of the resource.
 SignatureSecret getSignatureSecret()
          The signature secret.
 boolean isRequiredToObtainAuthenticatedToken()
          Whether this consumer is required to obtain an authenticated oauth token.
 void setAuthorities(List<org.springframework.security.core.GrantedAuthority> authorities)
          The base authorities for this consumer.
 void setConsumerKey(String consumerKey)
          The consumer key.
 void setConsumerName(String consumerName)
          The name of the consumer.
 void setRequiredToObtainAuthenticatedToken(boolean requiredToObtainAuthenticatedToken)
          Whether this consumer is required to obtain an authenticated oauth token.
 void setResourceDescription(String resourceDescription)
          The description of the resource.
 void setResourceName(String resourceName)
          The name of the resource.
 void setSignatureSecret(SignatureSecret signatureSecret)
          The signature secret.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseConsumerDetails

public BaseConsumerDetails()
Method Detail

getConsumerKey

public String getConsumerKey()
The consumer key.

Specified by:
getConsumerKey in interface ConsumerDetails
Returns:
The consumer key.

setConsumerKey

public void setConsumerKey(String consumerKey)
The consumer key.

Parameters:
consumerKey - The consumer key.

getConsumerName

public String getConsumerName()
The name of the consumer.

Specified by:
getConsumerName in interface ConsumerDetails
Returns:
The name of the consumer.

setConsumerName

public void setConsumerName(String consumerName)
The name of the consumer.

Parameters:
consumerName - The name of the consumer.

getSignatureSecret

public SignatureSecret getSignatureSecret()
The signature secret.

Specified by:
getSignatureSecret in interface ConsumerDetails
Returns:
The signature secret.

setSignatureSecret

public void setSignatureSecret(SignatureSecret signatureSecret)
The signature secret.

Parameters:
signatureSecret - The signature secret.

getAuthorities

public List<org.springframework.security.core.GrantedAuthority> getAuthorities()
The base authorities for this consumer.

Specified by:
getAuthorities in interface ConsumerDetails
Returns:
The base authorities for this consumer.

setAuthorities

public void setAuthorities(List<org.springframework.security.core.GrantedAuthority> authorities)
The base authorities for this consumer.

Parameters:
authorities - The base authorities for this consumer.

getResourceName

public String getResourceName()
The name of the resource.

Specified by:
getResourceName in interface ResourceSpecificConsumerDetails
Returns:
The name of the resource.

setResourceName

public void setResourceName(String resourceName)
The name of the resource.

Parameters:
resourceName - The name of the resource.

getResourceDescription

public String getResourceDescription()
The description of the resource.

Specified by:
getResourceDescription in interface ResourceSpecificConsumerDetails
Returns:
The description of the resource.

setResourceDescription

public void setResourceDescription(String resourceDescription)
The description of the resource.

Parameters:
resourceDescription - The description of the resource.

isRequiredToObtainAuthenticatedToken

public boolean isRequiredToObtainAuthenticatedToken()
Whether this consumer is required to obtain an authenticated oauth token.

Specified by:
isRequiredToObtainAuthenticatedToken in interface ExtraTrustConsumerDetails
Returns:
Whether this consumer is required to obtain an authenticated oauth token.

setRequiredToObtainAuthenticatedToken

public void setRequiredToObtainAuthenticatedToken(boolean requiredToObtainAuthenticatedToken)
Whether this consumer is required to obtain an authenticated oauth token.

Parameters:
requiredToObtainAuthenticatedToken - Whether this consumer is required to obtain an authenticated oauth token.


Copyright © 2012. All Rights Reserved.