View Javadoc

1   package org.apache.turbine.om.security.peer;
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  /***
20   * Peer classes for an User object need to implement this interface.
21   *
22   * The purpose of this class is to decouple DBSecurityService from
23   * the default User implementation and it's related Peer class.
24   *
25   * @author <a href="mailto:leandro@ibnetwork.com.br">Leandro Rodrigo Saad Cruz</a>
26   * @version $Id: UserPeer.java 264152 2005-08-29 14:50:22Z henning $
27   */
28  public interface UserPeer
29  {
30      /*** The key name for the visitor id field. */
31      String USERNAME = "LOGIN_NAME";
32  
33      /*** The key name for the username field. */
34      String USER_ID = "USER_ID";
35  
36      /***
37       * Returns the full name of a column.
38       *
39       * @param name name of a column
40       * @return A String with the full name of the column.
41       */
42      String getFullColumnName(String name);
43  }