io.vertx.ext.auth.authorization.impl

Class RoleBasedAuthorizationImpl

java.lang.Object

io.vertx.ext.auth.authorization.impl.RoleBasedAuthorizationImpl

All Implemented Interfaces:

Authorization, RoleBasedAuthorization

public class RoleBasedAuthorizationImpl
extends Object
implements RoleBasedAuthorization

Constructor Summary

Constructors

Constructor and Description
RoleBasedAuthorizationImpl(String role)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getResource() returns an optional resource that the role is assigned-on
String	getRole() returns the role
int	hashCode()
boolean	match(AuthorizationContext context) this methods verifies whether or not the authorization match the specified context.
RoleBasedAuthorization	setResource(String resource) sets an optional resource that the role is assigned-on
boolean	verify(Authorization otherAuthorization) this method verifies whether or not the authorization implies the specified authorization.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.auth.authorization.RoleBasedAuthorization

create

Methods inherited from interface io.vertx.ext.auth.authorization.Authorization

match

Constructor Detail

RoleBasedAuthorizationImpl

public RoleBasedAuthorizationImpl(String role)

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getRole

public String getRole()

Description copied from interface: RoleBasedAuthorization

returns the role

Specified by:

getRole in interface RoleBasedAuthorization

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

match

public boolean match(AuthorizationContext context)

Description copied from interface: Authorization

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 otherAuthorization)

Description copied from interface: Authorization

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:

otherAuthorization - the authorization.

Returns:

true if implies the argument.

getResource

public String getResource()

Description copied from interface: RoleBasedAuthorization

returns an optional resource that the role is assigned-on

Specified by:

getResource in interface RoleBasedAuthorization

Returns:

setResource

public RoleBasedAuthorization setResource(String resource)

Description copied from interface: RoleBasedAuthorization

sets an optional resource that the role is assigned-on

Specified by:

setResource in interface RoleBasedAuthorization

Returns: