be.objectify.deadbolt.java.DynamicResourceHandler Maven / Gradle / Ivy
/*
* Copyright 2010-2016 Steve Chaloner
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package be.objectify.deadbolt.java;
import play.mvc.Http;
import java.util.Optional;
import java.util.concurrent.CompletionStage;
/**
* Implementations of this interface are used to process dynamic restrictions (both from the view and the controller). A
* good system to use is to have a single DynamicResourceHandler returned from your {@link DeadboltHandler} which in turn
* delegates the isAllowed call to a an inner DynamicResourceHandler specific to the restriction name, e.g.
*
* public class MyDynamicResourceHandler
* {
* private static final Map<String, DynamicResourceHandler> HANDLERS = new HashMap<String, DynamicResourceHandler>();
*
* static
* {
* HANDLERS.put("foo",
* new DynamicResourceHandler()
* {
* public boolean isAllowed(String name,
* String meta,
* DeadboltHandler deadboltHandler)
* {
* // something specific to foo
* }
* });
* // repeat for your other dynamic restrictions
* }
*
* public F.Promise isAllowed(String name,
* String meta,
* DeadboltHandler deadboltHandler)
* {
* return HANDLERS.get(name).isAllowed(name, meta, deadboltHandler);
* }
*
* }
*
* @author Steve Chaloner ([email protected])
*/
public interface DynamicResourceHandler
{
/**
* Check the access of the named resource.
*
* @param name the resource name
* @param meta additional information on the resource
* @param deadboltHandler the current {@link DeadboltHandler}
* @param ctx the context of the current request
* @return true if access to the resource is allowed, otherwise false
*/
CompletionStage isAllowed(String name,
Optional meta,
DeadboltHandler deadboltHandler,
Http.Context ctx);
/**
* Invoked when a custom pattern needs checking..
*
* @param permissionValue the permission value
* @param meta additional information on the resource
* @param deadboltHandler the current {@link DeadboltHandler}
* @param ctx the context of the current request
* @return true if access based on the permission is allowed, otherwise false
*/
CompletionStage checkPermission(String permissionValue,
Optional meta,
DeadboltHandler deadboltHandler,
Http.Context ctx);
}