1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.myfaces.component; 20 21 /** 22 * Behavioral interface. 23 * Components that support user role checking should implement this interface 24 * to optimize property access. 25 * 26 * @author Manfred Geiler (latest modification by $Author: lu4242 $) 27 * @version $Revision: 659874 $ $Date: 2008-05-24 15:59:15 -0500 (Sat, 24 May 2008) $ 28 */ 29 public interface UserRoleAware 30 { 31 static final String ENABLED_ON_USER_ROLE_ATTR = "enabledOnUserRole"; 32 static final String VISIBLE_ON_USER_ROLE_ATTR = "visibleOnUserRole"; 33 34 /** 35 * If user is in given role, this component will be rendered 36 * normally. If not, no hyperlink is rendered but all nested 37 * tags (=body) are rendered. 38 * 39 * @JSFProperty 40 * @return 41 */ 42 String getEnabledOnUserRole(); 43 44 void setEnabledOnUserRole(String userRole); 45 46 /** 47 * If user is in given role, this component will be rendered 48 * normally. If not, nothing is rendered and the body of this 49 * tag will be skipped. 50 * 51 * @JSFProperty 52 * @return 53 */ 54 String getVisibleOnUserRole(); 55 56 void setVisibleOnUserRole(String userRole); 57 }