View Javadoc

1   package org.apache.turbine.om.security.peer;
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  /***
23   * Peer classes for an User object need to implement this interface.
24   *
25   * The purpose of this class is to decouple DBSecurityService from
26   * the default User implementation and it's related Peer class.
27   *
28   * @author <a href="mailto:leandro@ibnetwork.com.br">Leandro Rodrigo Saad Cruz</a>
29   *
30   * @deprecated Use {@link org.apache.turbine.services.security.torque.TorqueSecurityService}
31   * instead.
32   *
33   * @version $Id: UserPeer.java 534527 2007-05-02 16:10:59Z tv $
34   */
35  public interface UserPeer
36  {
37      /*** The key name for the visitor id field. */
38      String USERNAME = "LOGIN_NAME";
39  
40      /*** The key name for the username field. */
41      String USER_ID = "USER_ID";
42  
43      /***
44       * Returns the full name of a column.
45       *
46       * @param name name of a column
47       * @return A String with the full name of the column.
48       */
49      String getFullColumnName(String name);
50  }