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 org.apache.turbine.services.security.torque.om.TurbineRolePeer;
023    
024    /**
025     * Constants for configuring the various columns and bean properties
026     * for the used peer.
027     *
028     * <pre>
029     * Default is:
030     *
031     * security.torque.rolePeer.class = org.apache.turbine.services.security.torque.om.TurbineRolePeer
032     * security.torque.rolePeer.column.name       = ROLE_NAME
033     * security.torque.rolePeer.column.id         = ROLE_ID
034     *
035     * security.torque.role.class = org.apache.turbine.services.security.torque.om.TurbineRole
036     * security.torque.role.property.name       = Name
037     * security.torque.role.property.id         = RoleId
038     *
039     * </pre>
040     * If security.torque.role.class is unset, then the value of the constant CLASSNAME_DEFAULT
041     * from the configured Peer is used.
042     *
043     * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
044     * @version $Id: RolePeerManagerConstants.java 534527 2007-05-02 16:10:59Z tv $
045     */
046    
047    public interface RolePeerManagerConstants
048    {
049        /** The key within the security service properties for the role class implementation */
050        String ROLE_CLASS_KEY =
051            "torque.role.class";
052    
053        /** The key within the security service properties for the role peer class implementation */
054        String ROLE_PEER_CLASS_KEY =
055            "torque.rolePeer.class";
056    
057        /** Role peer default class */
058        String ROLE_PEER_CLASS_DEFAULT =
059                TurbineRolePeer.class.getName();
060    
061        /** The column name for the login name field. */
062        String ROLE_NAME_COLUMN_KEY =
063            "torque.rolePeer.column.name";
064    
065        /** The column name for the id field. */
066        String ROLE_ID_COLUMN_KEY =
067            "torque.rolePeer.column.id";
068    
069    
070        /** The default value for the column name constant for the login name field. */
071        String ROLE_NAME_COLUMN_DEFAULT =
072            "ROLE_NAME";
073    
074        /** The default value for the column name constant for the id field. */
075        String ROLE_ID_COLUMN_DEFAULT =
076            "ROLE_ID";
077    
078    
079        /** The property name of the bean property for the login name field. */
080        String ROLE_NAME_PROPERTY_KEY =
081            "torque.role.property.name";
082    
083        /** The property name of the bean property for the id field. */
084        String ROLE_ID_PROPERTY_KEY =
085            "torque.role.property.id";
086    
087    
088        /** The default value of the bean property for the login name field. */
089        String ROLE_NAME_PROPERTY_DEFAULT =
090            "Name";
091    
092        /** The default value of the bean property for the id field. */
093        String ROLE_ID_PROPERTY_DEFAULT =
094            "RoleId";
095    
096    }