/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.wicket.authroles.authorization.strategies.role.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* A mapping of 1..n roles to an action. This annotions must be embedded in the
* {@link AuthorizeActions} annotation.
*
* @see org.apache.wicket.authorization.IAuthorizationStrategy
* @see AnnotationsRoleAuthorizationStrategy
* @see AuthorizeActions
* @see AuthorizeInstantiation
*
* @author Eelco Hillenius
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.PACKAGE, ElementType.TYPE })
@Documented
@Inherited
public @interface AuthorizeAction {
/**
* The action that is allowed. The default actions that are supported by Wicket are
* <code>RENDER</code> and <code>ENABLE<code> as defined as constants
* of {@link org.apache.wicket.Component}.
*
* @see org.apache.wicket.Component#RENDER
* @see org.apache.wicket.Component#ENABLE
*
* @return the action that is allowed
*/
String action();
/**
* The roles for this action.
*
* @return the roles for this action. The default is an empty string (annotations do not allow
* null default values)
*/
String[] roles() default { };
/**
* The roles to deny for this action.
*
* @return the roles to deny for this action. The default is an empty string (annotations do not
* allow null default values)
*/
String[] deny() default { };
}