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.security.Principal;
20  import java.util.prefs.Preferences;
21  
22  /***
23   * <p>A role made of a {@link RolePrincipal} and the role {@link Preferences}.</p>
24   * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
25   */
26  public interface Role
27  {
28      /***
29       * <p>Getter for the role {@link Principal}.</p>
30       * @return The {@link Principal}.
31       */
32      Principal getPrincipal();
33  
34      /***
35       * <p>Setter for the role {@link RolePrincipal}.</p>
36       * @param rolePrincipal The {@link Principal}.
37       */
38      void setPrincipal(Principal rolePrincipal);
39  
40      /***
41       * <p>Getter for the role {@link Preferences} node, providing access to the
42       * role preferences properties.</p>
43       * @return The {@link Preferences}.
44       */
45      Preferences getPreferences();
46  
47      /***
48       * <p>Setter for the role {@link Preferences} node, providing access to the
49       * role preferences properties.</p>
50       * @param preferences The {@link Preferences}.
51       */
52      void setPreferences(Preferences preferences);
53  }