View Javadoc

1   package org.apache.turbine.services.security.db;
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 org.apache.turbine.om.security.peer.UserPeer;
23  import org.apache.turbine.services.security.torque.TorqueSecurityService;
24  import org.apache.turbine.util.security.UnknownEntityException;
25  
26  /***
27   * An implementation of SecurityService that uses a database as backend.
28   *
29   * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
30   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
31   * @author <a href="mailto:marco@intermeta.de">Marco Kn&uuml;ttel</a>
32   * @deprecated Use {@link org.apache.turbine.services.security.torque.TorqueSecurityService}
33   * instead.
34   * @version $Id: DBSecurityService.java 571795 2007-09-01 13:09:35Z tv $
35   */
36  public class DBSecurityService
37          extends TorqueSecurityService
38  {
39      /***
40       * The key within services's properties for user implementation
41       * classname (user.class)  - Leandro
42       */
43      public static final String USER_PEER_CLASS_KEY = "userPeer.class";
44  
45      /***
46       * The default implementation of User interface
47       * (org.apache.turbine.om.security.DBUser)
48       */
49      public static final String USER_PEER_CLASS_DEFAULT =
50              "org.apache.turbine.om.security.peer.TurbineUserPeer";
51  
52      /* Service specific implementation methods */
53  
54      /***
55       * Returns the Class object for the implementation of UserPeer interface
56       * used by the system (defined in TR.properties)
57       *
58       * @return the implementation of UserPeer interface used by the system.
59       * @throws UnknownEntityException if the system's implementation of UserPeer
60       *         interface could not be determined.
61       * @deprecated No replacement. Use 
62       * {@link org.apache.turbine.services.security.torque.TorqueSecurityService}
63       * instead.
64       */
65      public Class getUserPeerClass() throws UnknownEntityException
66      {
67          String userPeerClassName = getConfiguration().getString(
68                  USER_PEER_CLASS_KEY, USER_PEER_CLASS_DEFAULT);
69          try
70          {
71              return Class.forName(userPeerClassName);
72          }
73          catch (Exception e)
74          {
75              throw new UnknownEntityException(
76                      "Failed create a Class object for UserPeer implementation", e);
77          }
78      }
79  
80      /***
81       * Construct a UserPeer object.
82       *
83       * This method calls getUserPeerClass, and then creates a new object using
84       * the default constructor.
85       *
86       * @return an object implementing UserPeer interface.
87       * @throws UnknownEntityException if the object could not be instantiated.
88       * @deprecated No replacement. Use 
89       * {@link org.apache.turbine.services.security.torque.TorqueSecurityService}
90       * instead.
91       */
92      public UserPeer getUserPeerInstance() throws UnknownEntityException
93      {
94          UserPeer up;
95          try
96          {
97              up = (UserPeer) getUserPeerClass().newInstance();
98          }
99          catch (Exception e)
100         {
101             throw new UnknownEntityException(
102                     "Failed instantiate an UserPeer implementation object", e);
103         }
104         return up;
105     }
106 }