001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.authroles.authorization.strategies.role.annotations;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Inherited;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Annotation for configuring what roles are allowed for requesting the annotated resource. It works analogously
028 * to {@link org.apache.wicket.authroles.authorization.strategies.role.annotations.AuthorizeInstantiation}.
029 *
030 * @author Carl-Eric Menzel
031 * @see org.apache.wicket.authorization.IAuthorizationStrategy
032 * @see AnnotationsRoleAuthorizationStrategy
033 */
034@Retention(RetentionPolicy.RUNTIME)
035@Target({ElementType.PACKAGE, ElementType.TYPE})
036@Documented
037@Inherited
038public @interface AuthorizeResource
039{
040
041        /**
042         * Gets the roles that are allowed to take the action.
043         *
044         * @return the roles that are allowed. Returns a zero length array by default
045         */
046        String[] value() default {};
047}