Copyright (c) 2019 Stephane Bastian
This program and the accompanying materials are made available under the 2
terms of the Eclipse Public License 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
SPDX-License-Identifier: EPL-2.0 3
Contributors: 4
Stephane Bastian - initial API and implementation
/********************************************************************************
* Copyright (c) 2019 Stephane Bastian
*
* This program and the accompanying materials are made available under the 2
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* SPDX-License-Identifier: EPL-2.0 3
*
* Contributors: 4
* Stephane Bastian - initial API and implementation
********************************************************************************/
package io.vertx.ext.auth.authorization;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.ext.auth.authorization.impl.WildcardPermissionBasedAuthorizationImpl;
Represents a wildcard permission (ie: 'manage:order:*' '*:orders', '*', etc.)
Note that it can optionally be assigned to a specific resource
Author: Stephane Bastian
/**
* Represents a wildcard permission (ie: 'manage:order:*' '*:orders', '*', etc.)
* Note that it can optionally be assigned to a specific resource
*
* @author <a href="mail://stephane.bastian.dev@gmail.com">Stephane Bastian</a>
*
*/
@VertxGen
public interface WildcardPermissionBasedAuthorization extends Authorization {
static WildcardPermissionBasedAuthorization create(String permission) {
return new WildcardPermissionBasedAuthorizationImpl(permission);
}
return the value of the wildcard permission
Returns:
/**
* return the value of the wildcard permission
*
* @return
*/
String getPermission();
returns an optional resource that the permission is assigned-on
Returns:
/**
* returns an optional resource that the permission is assigned-on
*
* @return
*/
String getResource();
sets an optional resource that the permission is assigned-on
Returns:
/**
* sets an optional resource that the permission is assigned-on
*
* @return
*/
@Fluent
WildcardPermissionBasedAuthorization setResource(String resource);
}