Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sun.jersey.oauth.server.api.providers
Class DefaultOAuthProvider.Consumer

    java.lang.Object
      com.sun.jersey.oauth.server.api.providers.DefaultOAuthProvider.Consumer

All Implemented Interfaces:
  OAuthConsumer

Enclosing class:
  DefaultOAuthProvider

    public static class DefaultOAuthProvider.Consumer

extends java.lang.Object
implements OAuthConsumer

Simple read-only implementation of `OAuthConsumer`.

Method Summary
`MultivaluedMap<java.lang.String,java.lang.String>` | `getAttributes()` Returns additional attributes associated with the consumer (e.g.
`java.lang.String` | `getKey()` Returns consumer key.
`java.lang.String` | `getOwner()` Returns identifier of owner of this consumer - i.e.
`java.security.Principal` | `getPrincipal()` Returns a `Principal` object representing this consumer.
`java.lang.String` | `getSecret()` Returns consumer secret.
`boolean` | `isInRole(java.lang.String role)` Returns a boolean indicating whether this consumer is authorized for the specified logical "role".

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getKey

    public java.lang.String getKey()

  Description copied from interface: `OAuthConsumer`
  Returns consumer key.

  Specified by:
    `getKey` in interface `OAuthConsumer`
  Returns:
    consumer key

### getSecret

    public java.lang.String getSecret()

  Description copied from interface: `OAuthConsumer`
  Returns consumer secret.

  Specified by:
    `getSecret` in interface `OAuthConsumer`
  Returns:
    consumer secret

### getOwner

    public java.lang.String getOwner()

  Returns identifier of owner of this consumer - i.e. who registered the consumer.

  Returns:
    consumer owner

### getAttributes

    public MultivaluedMap<java.lang.String,java.lang.String> getAttributes()

  Returns additional attributes associated with the consumer (e.g. name, URI, description, etc.)

  Returns:
    name-values pairs of additional attributes

### getPrincipal

    public java.security.Principal getPrincipal()

  Description copied from interface: `OAuthConsumer`
  Returns a `Principal` object representing this consumer. When the oauth filter verifies the request and no access token is provided, this is the principal that will get set to the security context. This can be used for 2-legged oauth. If the server does not allow consumers acting on their own (with no access token), this method should return null.

  Specified by:
    `getPrincipal` in interface `OAuthConsumer`
  Returns:
    Principal corresponding to this consumer, or null if 2-legged oauth not supported (i.e. consumers can't act on their own)

### isInRole

    public boolean isInRole(java.lang.String role)

  Description copied from interface: `OAuthConsumer`
  Returns a boolean indicating whether this consumer is authorized for the specified logical "role". When the oauth filter verifies the request and no access token is provided (2-legged oauth), it sets the consumer object to the security context which then delegates `SecurityContext.isUserInRole(java.lang.String)` to this method.

  Specified by:
    `isInRole` in interface `OAuthConsumer`
  Parameters:
    `role` - a `String` specifying the name of the role
  Returns:
    a `boolean` indicating whether this token is authorized for a given role

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2013 Oracle Corporation. All Rights Reserved.