Class ScopeAuthorization
- java.lang.Object
-
- io.vertx.reactivex.ext.auth.authorization.AuthorizationProvider
-
- io.vertx.reactivex.ext.auth.oauth2.authorization.ScopeAuthorization
-
public class ScopeAuthorization extends AuthorizationProvider
Scope is a mechanism in OAuth 2.0 to limit an application's access to a user's account. An application can request one or more scopes, this information is then presented to the user in the consent screen, and the access token issued to the application will be limited to the scopes granted. The OAuth spec allows the authorization server or user to modify the scopes granted to the application compared to what is requested, although there are not many examples of services doing this in practice. OAuth2 does not define any particular values for scopes, since it is highly dependent on the service's internal architecture and needs. NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<ScopeAuthorization>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description ScopeAuthorization(ScopeAuthorization delegate)
ScopeAuthorization(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
claimKey()
Returns the configured claim key.static ScopeAuthorization
create()
Factory method to create a Authorization provider for Oauth 2.0 scopes using the default separator" "
.static ScopeAuthorization
create(String scopeSeparator)
Factory method to create a Authorization provider for Oauth 2.0 scopes.static ScopeAuthorization
create(String scopeSeparator, String claimKey)
Factory method to create a Authorization provider for OpenID Connect scopes.String
encode(List<String> scopes)
Returns a String with the given scopes concatenated with the given separator.boolean
equals(Object o)
ScopeAuthorization
getDelegate()
int
hashCode()
static ScopeAuthorization
newInstance(ScopeAuthorization arg)
String
separator()
Returns the configured separator.String
toString()
-
Methods inherited from class io.vertx.reactivex.ext.auth.authorization.AuthorizationProvider
create, getAuthorizations, getAuthorizations, getId, newInstance, rxGetAuthorizations
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<ScopeAuthorization> __TYPE_ARG
-
-
Constructor Detail
-
ScopeAuthorization
public ScopeAuthorization(ScopeAuthorization delegate)
-
ScopeAuthorization
public ScopeAuthorization(Object delegate)
-
-
Method Detail
-
toString
public String toString()
- Overrides:
toString
in classAuthorizationProvider
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classAuthorizationProvider
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAuthorizationProvider
-
getDelegate
public ScopeAuthorization getDelegate()
- Overrides:
getDelegate
in classAuthorizationProvider
-
create
public static ScopeAuthorization create()
Factory method to create a Authorization provider for Oauth 2.0 scopes using the default separator" "
.- Returns:
- a AuthorizationProvider
-
create
public static ScopeAuthorization create(String scopeSeparator)
Factory method to create a Authorization provider for Oauth 2.0 scopes.- Parameters:
scopeSeparator
- the scope separator e.g.:" "
,","
,"+"
- Returns:
- a AuthorizationProvider
-
create
public static ScopeAuthorization create(String scopeSeparator, String claimKey)
Factory method to create a Authorization provider for OpenID Connect scopes. The claim key will be used to locate the scopes from a decoded JWT.- Parameters:
scopeSeparator
- the scope separator e.g.:" "
,","
,"+"
claimKey
- the scope claim key e.g.:"scp"
,"scope"
- Returns:
- a AuthorizationProvider
-
separator
public String separator()
Returns the configured separator.- Returns:
- the separator.
-
claimKey
public String claimKey()
Returns the configured claim key.- Returns:
- the claim key.
-
encode
public String encode(List<String> scopes)
Returns a String with the given scopes concatenated with the given separator.- Parameters:
scopes
- a list of scopes- Returns:
- concatenated string.
-
newInstance
public static ScopeAuthorization newInstance(ScopeAuthorization arg)
-
-