Package io.vertx.mutiny.ext.auth.oauth2.authorization

Class ScopeAuthorization

java.lang.Object
io.vertx.mutiny.ext.auth.authorization.AuthorizationProvider
io.vertx.mutiny.ext.auth.oauth2.authorization.ScopeAuthorization
All Implemented Interfaces:
MutinyDelegate
public class ScopeAuthorization extends AuthorizationProvider implements MutinyDelegate
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 the original non Mutiny-ified interface using Vert.x codegen.

  • Field Details

  • Constructor Details

    • ScopeAuthorization

      public ScopeAuthorization(io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization delegate)

    • ScopeAuthorization

      public ScopeAuthorization(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Overrides:
      getDelegate in class AuthorizationProvider
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class AuthorizationProvider

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AuthorizationProvider

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AuthorizationProvider

    • create

      public static ScopeAuthorization create()
      Returns:
      a AuthorizationProvider

    • create

      public static ScopeAuthorization create(String scopeSeparator)
      Parameters:
      scopeSeparator - the scope separator e.g.: " ", ",", "+"
      Returns:
      a AuthorizationProvider

    • create

      public static ScopeAuthorization create(String scopeSeparator, String claimKey)
      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 separator.

    • claimKey

      public String claimKey()
      Returns:
      the claim key.

    • encode

      public String encode(List<String> scopes)
      Parameters:
      scopes - a list of scopes
      Returns:
      concatenated string.

    • newInstance

      public static ScopeAuthorization newInstance(io.vertx.ext.auth.oauth2.authorization.ScopeAuthorization arg)