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

Class RoleBasedAuthorization

java.lang.Object
io.vertx.mutiny.ext.auth.authorization.RoleBasedAuthorization
All Implemented Interfaces:
MutinyDelegate, Authorization
public class RoleBasedAuthorization extends Object implements Authorization, MutinyDelegate
Represents a role. Note that this role can optionally be assigned to a specific resource

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Stephane Bastian
See Also:
  • RoleBasedAuthorization

  • Field Details

  • Constructor Details

    • RoleBasedAuthorization

      public RoleBasedAuthorization(io.vertx.ext.auth.authorization.RoleBasedAuthorization delegate)
      Create a new instance of RoleBasedAuthorization delegating to the given (non-null) instance of RoleBasedAuthorization.

    • RoleBasedAuthorization

      public RoleBasedAuthorization(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.authorization.RoleBasedAuthorization getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface Authorization
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • create

      public static RoleBasedAuthorization create(String role)

    • getRole

      public String getRole()
      returns the role
      Returns:

    • getResource

      public String getResource()
      returns an optional resource that the role is assigned-on
      Returns:

    • setResource

      public RoleBasedAuthorization setResource(String resource)
      sets an optional resource that the role is assigned-on
      Returns:

    • toJson

      public io.vertx.core.json.JsonObject toJson()
      Specified by:
      toJson in interface Authorization

    • match

      public boolean match(User arg0)
      this methods verifies whether or not the authorization match the specified context.
      Specified by:
      match in interface Authorization
      Parameters:
      context - the context.
      Returns:
      true if there's a match.

    • verify

      public boolean verify(Authorization arg0)
      this method verifies whether or not the authorization implies the specified authorization.
      Note that it doesn't always mean an exact match. For instance, in the case of a WildcardPermissionBasedAuthorization, this method may return true even if the permissions are different
      WildcardPermissionBasedAuthorization.create('*').verify(WildcardPermissionBasedAuthorization.create('anypermission')) would return true
      Specified by:
      verify in interface Authorization
      Parameters:
      authorization - the authorization.
      Returns:
      true if implies the argument.

    • match

      public boolean match(AuthorizationContext arg0)
      this methods verifies whether or not the authorization match the specified context.
      Specified by:
      match in interface Authorization
      Parameters:
      context - the context.
      Returns:
      true if there's a match.

    • newInstance

      public static RoleBasedAuthorization newInstance(io.vertx.ext.auth.authorization.RoleBasedAuthorization delegate)
      Creates a new instance of the RoleBasedAuthorization.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class Object