View Javadoc

1   /* 
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.security;
18  
19  import java.util.prefs.Preferences;
20  
21  /***
22   * <p>
23   * This class allows to implement different types of groups/roles hierarchy.
24   * </p>
25   * 
26   * @author <a href="mailto:Artem.Grinshtein@t-systems.com">Artem Grinshtein </a>
27   * @version $Id: HierarchyResolver.java 187640 2004-09-30 04:01:42Z dlestrat $
28   */
29  public interface HierarchyResolver 
30  {
31      
32      /***
33       * <p>
34       * Returns absolute path names of the hierarchy roles/groups.
35       * </p>
36       * 
37       * @param prefs Preferences for the role/group
38       * @return Returns absolute path names of the dependcy roles/groups.
39       */
40      public String[] resolve(Preferences prefs);
41      
42      /***
43       * <p>
44       * Returns the absolute path names of the children of the given hierarchy
45       * roles/groups node.
46       * </p>
47       * 
48       * @param prefs Preferences for the role/group
49       * @return Returns absolute path names of the children roles/groups.
50       */
51      public String[] resolveChildren(Preferences prefs);
52          
53  }