Package x.oauth

Class ScopeService

java.lang.Object

x.oauth.ScopeService

public class ScopeService
extends Object

Responsible for storing and loading OAuth20 scopes.

Author:

sakdsitt

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	MANDATORY_FIELDS_ERROR
protected static final String	MANDATORY_SCOPE_ERROR
protected static final String	SCOPE_ALREADY_EXISTS
protected static final String	SCOPE_DELETED_NOK_MESSAGE
protected static final String	SCOPE_DELETED_OK_MESSAGE
protected static final String	SCOPE_NAME_INVALID_ERROR
protected static final String	SCOPE_NOT_EXIST
protected static final String	SCOPE_STORED_NOK_MESSAGE
protected static final String	SCOPE_STORED_OK_MESSAGE
protected static final String	SCOPE_UPDATED_NOK_MESSAGE
protected static final String	SCOPE_UPDATED_OK_MESSAGE
protected static final String	SCOPE_USED_BY_APP_MESSAGE

Constructor Summary

Constructors

Constructor	Description
ScopeService()

Method Summary

Modifier and Type	Method	Description
String	deleteScope(String scopeName)	Deletes a scope.
protected List<ApplicationInfo>	getClientAppsByScope(String scopeName)
Long	getExpiresIn(String tokenGrantType, String scope)	Returns value for expires_in by given scope and token type.
String	getScopeByName(String scopeName)
protected String	getScopes(String clientId)
String	getScopes(javax.servlet.http.HttpServletRequest req)	Returns either all scopes or scopes for a specific client_id passed as query parameter.
String	getValidScope(String scope, String clientId)	Checks whether a scope is valid for a given client id.
String	getValidScopeByScope(String scope, String storedScope)
protected List<Scope>	loadScopes(String scope)
String	registerScope(javax.servlet.http.HttpServletRequest req)	Register an oauth scope.
boolean	scopeAllowed(String scope, String allowedScopes)	Checks whether a scope is contained in allowed scopes.
protected void	setScopeEmptyValues(Scope scope, Scope foundScope)
String	updateScope(javax.servlet.http.HttpServletRequest req, String scopeName)	Updates a scope.

Methods inherited from class java.lang.Object

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

Field Details

MANDATORY_FIELDS_ERROR

protected static final String MANDATORY_FIELDS_ERROR

See Also:

• Constant Field Values

MANDATORY_SCOPE_ERROR

protected static final String MANDATORY_SCOPE_ERROR

See Also:

• Constant Field Values

SCOPE_NAME_INVALID_ERROR

protected static final String SCOPE_NAME_INVALID_ERROR

See Also:

• Constant Field Values

SCOPE_STORED_OK_MESSAGE

protected static final String SCOPE_STORED_OK_MESSAGE

See Also:

• Constant Field Values

SCOPE_STORED_NOK_MESSAGE

protected static final String SCOPE_STORED_NOK_MESSAGE

See Also:

• Constant Field Values

SCOPE_UPDATED_OK_MESSAGE

protected static final String SCOPE_UPDATED_OK_MESSAGE

See Also:

• Constant Field Values

SCOPE_UPDATED_NOK_MESSAGE

protected static final String SCOPE_UPDATED_NOK_MESSAGE

See Also:

• Constant Field Values

SCOPE_NOT_EXIST

protected static final String SCOPE_NOT_EXIST

See Also:

• Constant Field Values

SCOPE_ALREADY_EXISTS

protected static final String SCOPE_ALREADY_EXISTS

See Also:

• Constant Field Values

SCOPE_DELETED_OK_MESSAGE

protected static final String SCOPE_DELETED_OK_MESSAGE

See Also:

• Constant Field Values

SCOPE_DELETED_NOK_MESSAGE

protected static final String SCOPE_DELETED_NOK_MESSAGE

See Also:

• Constant Field Values

SCOPE_USED_BY_APP_MESSAGE

protected static final String SCOPE_USED_BY_APP_MESSAGE

See Also:

• Constant Field Values

Constructor Details

ScopeService

public ScopeService()

Method Details

registerScope

public String registerScope(javax.servlet.http.HttpServletRequest req)
                     throws OAuthException,
IOException

Register an oauth scope. If the scope already exists, returns an error.

Throws:

OAuthException

IOException

getScopes

public String getScopes(javax.servlet.http.HttpServletRequest req)
                 throws OAuthException

Returns either all scopes or scopes for a specific client_id passed as query parameter.

Throws:

OAuthException

getValidScope

public String getValidScope(String scope,
 String clientId)

Checks whether a scope is valid for a given client id.

getValidScopeByScope

public String getValidScopeByScope(String scope,
 String storedScope)

scopeAllowed

public boolean scopeAllowed(String scope,
 String allowedScopes)

Checks whether a scope is contained in allowed scopes.

getExpiresIn

public Long getExpiresIn(String tokenGrantType,
 String scope)

Returns value for expires_in by given scope and token type.

updateScope

public String updateScope(javax.servlet.http.HttpServletRequest req,
 String scopeName)
                   throws OAuthException

Updates a scope. If the scope does not exists, returns an error.

Throws:

OAuthException

deleteScope

public String deleteScope(String scopeName)
                   throws OAuthException

Deletes a scope. If the scope does not exists, returns an error.

Throws:

OAuthException

getScopeByName

public String getScopeByName(String scopeName)
                      throws OAuthException

Throws:

OAuthException

getClientAppsByScope

protected List<ApplicationInfo> getClientAppsByScope(String scopeName)

setScopeEmptyValues

protected void setScopeEmptyValues(Scope scope,
 Scope foundScope)

loadScopes

protected List<Scope> loadScopes(String scope)

getScopes

protected String getScopes(String clientId)
                    throws OAuthException

Throws:

OAuthException