View Javadoc

1   package org.apache.turbine.services.security.torque;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.turbine.services.security.torque.om.TurbineGroupPeer;
23  
24  /***
25   * Constants for configuring the various columns and bean properties
26   * for the used peer.
27   *
28   * <pre>
29   * Default is:
30   *
31   * security.torque.groupPeer.class = org.apache.turbine.services.security.torque.om.TurbineGroupPeer
32   * security.torque.groupPeer.column.name       = GROUP_NAME
33   * security.torque.groupPeer.column.id         = GROUP_ID
34   *
35   * security.torque.group.class = org.apache.turbine.services.security.torque.om.TurbineGroup
36   * security.torque.group.property.name       = Name
37   * security.torque.group.property.id         = GroupId
38   *
39   * </pre>
40   * If security.torque.group.class is unset, then the value of the constant CLASSNAME_DEFAULT
41   * from the configured Peer is used.
42   *
43   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
44   * @version $Id: GroupPeerManagerConstants.java 534527 2007-05-02 16:10:59Z tv $
45   */
46  
47  public interface GroupPeerManagerConstants
48  {
49      /*** The key within the security service properties for the group class implementation */
50      String GROUP_CLASS_KEY =
51              "torque.group.class";
52  
53      /*** The key within the security service properties for the group peer class implementation */
54      String GROUP_PEER_CLASS_KEY =
55              "torque.groupPeer.class";
56  
57      /*** Group peer default class */
58      String GROUP_PEER_CLASS_DEFAULT =
59              TurbineGroupPeer.class.getName();
60  
61      /*** The column name for the login name field. */
62      String GROUP_NAME_COLUMN_KEY =
63              "torque.groupPeer.column.name";
64  
65      /*** The column name for the id field. */
66      String GROUP_ID_COLUMN_KEY =
67          "torque.groupPeer.column.id";
68  
69  
70      /*** The default value for the column name constant for the login name field. */
71      String GROUP_NAME_COLUMN_DEFAULT =
72          "GROUP_NAME";
73  
74      /*** The default value for the column name constant for the id field. */
75      String GROUP_ID_COLUMN_DEFAULT =
76          "GROUP_ID";
77  
78  
79      /*** The property name of the bean property for the login name field. */
80      String GROUP_NAME_PROPERTY_KEY =
81          "torque.group.property.name";
82  
83      /*** The property name of the bean property for the id field. */
84      String GROUP_ID_PROPERTY_KEY =
85          "torque.group.property.id";
86  
87  
88      /*** The default value of the bean property for the login name field. */
89      String GROUP_NAME_PROPERTY_DEFAULT =
90          "Name";
91  
92      /*** The default value of the bean property for the id field. */
93      String GROUP_ID_PROPERTY_DEFAULT =
94          "GroupId";
95  }