View Javadoc

1   package org.apache.turbine.services.security.torque;
2   
3   /*
4    * Copyright 2001-2005 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License")
7    * you may not use this file except in compliance with the License.
8    * 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, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  import java.io.Serializable;
20  
21  import org.apache.turbine.services.security.torque.om.TurbineUserPeer;
22  
23  /***
24   * Constants for configuring the various columns and bean properties
25   * for the used peer.
26   *
27   * <pre>
28   * Default is:
29   *
30   * security.torque.userPeer.class = org.apache.turbine.services.security.torque.om.TurbineUserPeer
31   * security.torque.userPeer.column.name       = LOGIN_NAME
32   * security.torque.userPeer.column.id         = USER_ID
33   * security.torque.userPeer.column.password   = PASSWORD_VALUE
34   * security.torque.userPeer.column.firstname  = FIRST_NAME
35   * security.torque.userPeer.column.lastname   = LAST_NAME
36   * security.torque.userPeer.column.email      = EMAIL
37   * security.torque.userPeer.column.confirm    = CONFIRM_VALUE
38   * security.torque.userPeer.column.createdate = CREATED
39   * security.torque.userPeer.column.lastlogin  = LAST_LOGIN
40   * security.torque.userPeer.column.objectdata = OBJECTDATA
41   *
42   * security.torque.user.class = org.apache.turbine.services.security.torque.om.TurbineUser
43   * security.torque.user.property.name       = UserName
44   * security.torque.user.property.id         = UserId
45   * security.torque.user.property.password   = Password
46   * security.torque.user.property.firstname  = FirstName
47   * security.torque.user.property.lastname   = LastName
48   * security.torque.user.property.email      = Email
49   * security.torque.user.property.confirm    = Confirmed
50   * security.torque.user.property.createdate = CreateDate
51   * security.torque.user.property.lastlogin  = LastLogin
52   * security.torque.user.property.objectdata = Objectdata
53   *
54   * </pre>
55   * If security.torque.user.class is unset, then the value of the constant CLASSNAME_DEFAULT
56   * from the configured Peer is used.
57   *
58   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
59   * @version $Id: UserPeerManagerConstants.java 264152 2005-08-29 14:50:22Z henning $
60   */
61  
62  public interface UserPeerManagerConstants
63      extends Serializable
64  {
65      /*** The key within the security service properties for the user class implementation */
66      String USER_CLASS_KEY =
67          "torque.user.class";
68  
69      /*** The key within the security service properties for the user peer class implementation */
70      String USER_PEER_CLASS_KEY =
71          "torque.userPeer.class";
72  
73      /*** User peer default class */
74      String USER_PEER_CLASS_DEFAULT =
75          TurbineUserPeer.class.getName();
76  
77      /*** The column name for the login name field. */
78      String USER_NAME_COLUMN_KEY =
79          "torque.userPeer.column.name";
80  
81      /*** The column name for the id field. */
82      String USER_ID_COLUMN_KEY =
83          "torque.userPeer.column.id";
84  
85      /*** The column name for the password field. */
86      String USER_PASSWORD_COLUMN_KEY =
87          "torque.userPeer.column.password";
88  
89      /*** The column name for the first name field. */
90      String USER_FIRST_NAME_COLUMN_KEY =
91          "torque.userPeer.column.firstname";
92  
93      /*** The column name for the last name field. */
94      String USER_LAST_NAME_COLUMN_KEY =
95          "torque.userPeer.column.lastname";
96  
97      /*** The column name for the email field. */
98      String USER_EMAIL_COLUMN_KEY =
99          "torque.userPeer.column.email";
100 
101     /*** The column name for the confirm field. */
102     String USER_CONFIRM_COLUMN_KEY =
103         "torque.userPeer.column.confirm";
104 
105     /*** The column name for the create date field. */
106     String USER_CREATE_COLUMN_KEY =
107         "torque.userPeer.column.createdate";
108 
109     /*** The column name for the last login field. */
110     String USER_LAST_LOGIN_COLUMN_KEY =
111         "torque.userPeer.column.lastlogin";
112 
113     /*** The column name for the objectdata field. */
114     String USER_OBJECTDATA_COLUMN_KEY =
115         "torque.userPeer.column.objectdata";
116 
117 
118     /*** The default value for the column name constant for the login name field. */
119     String USER_NAME_COLUMN_DEFAULT =
120         "LOGIN_NAME";
121 
122     /*** The default value for the column name constant for the id field. */
123     String USER_ID_COLUMN_DEFAULT =
124         "USER_ID";
125 
126     /*** The default value for the column name constant for the password field. */
127     String USER_PASSWORD_COLUMN_DEFAULT =
128         "PASSWORD_VALUE";
129 
130     /*** The default value for the column name constant for the first name field. */
131     String USER_FIRST_NAME_COLUMN_DEFAULT =
132         "FIRST_NAME";
133 
134     /*** The default value for the column name constant for the last name field. */
135     String USER_LAST_NAME_COLUMN_DEFAULT =
136         "LAST_NAME";
137 
138     /*** The default value for the column name constant for the email field. */
139     String USER_EMAIL_COLUMN_DEFAULT =
140         "EMAIL";
141 
142     /*** The default value for the column name constant for the confirm field. */
143     String USER_CONFIRM_COLUMN_DEFAULT =
144         "CONFIRM_VALUE";
145 
146     /*** The default value for the column name constant for the create date field. */
147     String USER_CREATE_COLUMN_DEFAULT =
148         "CREATED";
149 
150     /*** The default value for the column name constant for the last login field. */
151     String USER_LAST_LOGIN_COLUMN_DEFAULT =
152         "LAST_LOGIN";
153 
154     /*** The default value for the column name constant for the objectdata field. */
155     String USER_OBJECTDATA_COLUMN_DEFAULT =
156         "OBJECTDATA";
157 
158     /*** The property name of the bean property for the login name field. */
159     String USER_NAME_PROPERTY_KEY =
160         "torque.user.property.name";
161 
162     /*** The property name of the bean property for the id field. */
163     String USER_ID_PROPERTY_KEY =
164         "torque.user.property.id";
165 
166     /*** The property name of the bean property for the password field. */
167     String USER_PASSWORD_PROPERTY_KEY =
168         "torque.user.property.password";
169 
170     /*** The property name of the bean property for the first name field. */
171     String USER_FIRST_NAME_PROPERTY_KEY =
172         "torque.user.property.firstname";
173 
174     /*** The property name of the bean property for the last name field. */
175     String USER_LAST_NAME_PROPERTY_KEY =
176         "torque.user.property.lastname";
177 
178     /*** The property name of the bean property for the email field. */
179     String USER_EMAIL_PROPERTY_KEY =
180         "torque.user.property.email";
181 
182     /*** The property name of the bean property for the confirm field. */
183     String USER_CONFIRM_PROPERTY_KEY =
184         "torque.user.property.confirm";
185 
186     /*** The property name of the bean property for the create date field. */
187     String USER_CREATE_PROPERTY_KEY =
188         "torque.user.property.createdate";
189 
190     /*** The property name of the bean property for the last login field. */
191     String USER_LAST_LOGIN_PROPERTY_KEY =
192         "torque.user.property.lastlogin";
193 
194     /*** The property name of the bean property for the last login field. */
195     String USER_OBJECTDATA_PROPERTY_KEY =
196         "torque.user.property.objectdata";
197 
198     /*** The default value of the bean property for the login name field. */
199     String USER_NAME_PROPERTY_DEFAULT =
200         "UserName";
201 
202     /*** The default value of the bean property for the id field. */
203     String USER_ID_PROPERTY_DEFAULT =
204         "UserId";
205 
206     /*** The default value of the bean property for the password field. */
207     String USER_PASSWORD_PROPERTY_DEFAULT =
208         "Password";
209 
210     /*** The default value of the bean property for the first name field. */
211     String USER_FIRST_NAME_PROPERTY_DEFAULT =
212         "FirstName";
213 
214     /*** The default value of the bean property for the last name field. */
215     String USER_LAST_NAME_PROPERTY_DEFAULT =
216         "LastName";
217 
218     /*** The default value of the bean property for the email field. */
219     String USER_EMAIL_PROPERTY_DEFAULT =
220         "Email";
221 
222     /*** The default value of the bean property for the confirm field. */
223     String USER_CONFIRM_PROPERTY_DEFAULT =
224         "Confirmed";
225 
226     /*** The default value of the bean property for the create date field. */
227     String USER_CREATE_PROPERTY_DEFAULT =
228         "CreateDate";
229 
230     /*** The default value of the bean property for the last login field. */
231     String USER_LAST_LOGIN_PROPERTY_DEFAULT =
232         "LastLogin";
233 
234     /*** The default value of the bean property for the objectdata field. */
235     String USER_OBJECTDATA_PROPERTY_DEFAULT =
236         "Objectdata";
237 };
238 
239