001 package org.apache.turbine.services.security.torque;
002
003 /*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements. See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership. The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License. You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied. See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022 import java.io.Serializable;
023
024 import org.apache.turbine.services.security.torque.om.TurbineUserPeer;
025
026 /**
027 * Constants for configuring the various columns and bean properties
028 * for the used peer.
029 *
030 * <pre>
031 * Default is:
032 *
033 * security.torque.userPeer.class = org.apache.turbine.services.security.torque.om.TurbineUserPeer
034 * security.torque.userPeer.column.name = LOGIN_NAME
035 * security.torque.userPeer.column.id = USER_ID
036 * security.torque.userPeer.column.password = PASSWORD_VALUE
037 * security.torque.userPeer.column.firstname = FIRST_NAME
038 * security.torque.userPeer.column.lastname = LAST_NAME
039 * security.torque.userPeer.column.email = EMAIL
040 * security.torque.userPeer.column.confirm = CONFIRM_VALUE
041 * security.torque.userPeer.column.createdate = CREATED
042 * security.torque.userPeer.column.lastlogin = LAST_LOGIN
043 * security.torque.userPeer.column.objectdata = OBJECTDATA
044 *
045 * security.torque.user.class = org.apache.turbine.services.security.torque.om.TurbineUser
046 * security.torque.user.property.name = UserName
047 * security.torque.user.property.id = UserId
048 * security.torque.user.property.password = Password
049 * security.torque.user.property.firstname = FirstName
050 * security.torque.user.property.lastname = LastName
051 * security.torque.user.property.email = Email
052 * security.torque.user.property.confirm = Confirmed
053 * security.torque.user.property.createdate = CreateDate
054 * security.torque.user.property.lastlogin = LastLogin
055 * security.torque.user.property.objectdata = Objectdata
056 *
057 * </pre>
058 * If security.torque.user.class is unset, then the value of the constant CLASSNAME_DEFAULT
059 * from the configured Peer is used.
060 *
061 * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
062 * @version $Id: UserPeerManagerConstants.java 1096130 2011-04-23 10:37:19Z ludwig $
063 */
064
065 public interface UserPeerManagerConstants
066 extends Serializable
067 {
068 /** The key within the security service properties for the user class implementation */
069 String USER_CLASS_KEY =
070 "torque.user.class";
071
072 /** The key within the security service properties for the user peer class implementation */
073 String USER_PEER_CLASS_KEY =
074 "torque.userPeer.class";
075
076 /** User peer default class */
077 String USER_PEER_CLASS_DEFAULT =
078 TurbineUserPeer.class.getName();
079
080 /** The column name for the login name field. */
081 String USER_NAME_COLUMN_KEY =
082 "torque.userPeer.column.name";
083
084 /** The column name for the id field. */
085 String USER_ID_COLUMN_KEY =
086 "torque.userPeer.column.id";
087
088 /** The column name for the password field. */
089 String USER_PASSWORD_COLUMN_KEY =
090 "torque.userPeer.column.password";
091
092 /** The column name for the first name field. */
093 String USER_FIRST_NAME_COLUMN_KEY =
094 "torque.userPeer.column.firstname";
095
096 /** The column name for the last name field. */
097 String USER_LAST_NAME_COLUMN_KEY =
098 "torque.userPeer.column.lastname";
099
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