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