com.sun.jersey.oauth.server
Class OAuthSecurityContext

java.lang.Object
  extended by com.sun.jersey.oauth.server.OAuthSecurityContext
All Implemented Interfaces:
SecurityContext

public class OAuthSecurityContext
extends Object
implements SecurityContext

Security request that gets injected into the context by the OAuth filter based on the access token attached to the request.

Author:
Martin Matula

Field Summary
 
Fields inherited from interface javax.ws.rs.core.SecurityContext
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Constructor Summary
OAuthSecurityContext(OAuthToken token, boolean isSecure)
           
 
Method Summary
 String getAuthenticationScheme()
          Returns the string value of the authentication scheme used to protect the resource.
 Principal getUserPrincipal()
          Returns a java.security.Principal object containing the name of the current authenticated user.
 boolean isSecure()
          Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
 boolean isUserInRole(String string)
          Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OAuthSecurityContext

public OAuthSecurityContext(OAuthToken token,
                            boolean isSecure)
Method Detail

getUserPrincipal

public Principal getUserPrincipal()
Description copied from interface: SecurityContext
Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

Specified by:
getUserPrincipal in interface SecurityContext
Returns:
a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

isUserInRole

public boolean isUserInRole(String string)
Description copied from interface: SecurityContext
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". If the user has not been authenticated, the method returns false.

Specified by:
isUserInRole in interface SecurityContext
Parameters:
string - a String specifying the name of the role
Returns:
a boolean indicating whether the user making the request belongs to a given role; false if the user has not been authenticated

isSecure

public boolean isSecure()
Description copied from interface: SecurityContext
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

Specified by:
isSecure in interface SecurityContext
Returns:
true if the request was made using a secure channel, false otherwise

getAuthenticationScheme

public String getAuthenticationScheme()
Description copied from interface: SecurityContext
Returns the string value of the authentication scheme used to protect the resource. If the resource is not authenticated, null is returned. Values are the same as the CGI variable AUTH_TYPE

Specified by:
getAuthenticationScheme in interface SecurityContext
Returns:
one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.


Copyright © 2013 Oracle Corporation. All Rights Reserved.