001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.security;
029
030import org.opencms.file.CmsObject;
031import org.opencms.workplace.I_CmsGroupNameTranslation;
032
033import java.util.Locale;
034
035/**
036 * Wrapper around CmsRole objects so they can be used as principals.
037 */
038public class CmsRoleAsPrincipal extends CmsPrincipal {
039
040    /** Serial version id. */
041    private static final long serialVersionUID = 1L;
042
043    /** The wrapped role. */
044    private CmsRole m_role;
045
046    /**
047     * Creates a new instane.
048     *
049     * @param role the wrapped role
050     */
051    public CmsRoleAsPrincipal(CmsRole role) {
052
053        m_role = role;
054        m_name = role.getRoleName();
055    }
056
057    /**
058     * @see org.opencms.security.I_CmsPrincipal#checkName(java.lang.String)
059     */
060    public void checkName(String name) {
061
062        // do nothing
063    }
064
065    /**
066     * @see org.opencms.security.I_CmsPrincipal#getDescription(java.util.Locale)
067     */
068    public String getDescription(Locale locale) {
069
070        return m_role.getDescription(locale);
071    }
072
073    /**
074     * @see org.opencms.security.CmsPrincipal#getDisplayName(org.opencms.file.CmsObject, java.util.Locale)
075     */
076    @Override
077    public String getDisplayName(CmsObject cms, Locale locale) {
078
079        return m_role.getName(locale);
080    }
081
082    /**
083     * @see org.opencms.security.CmsPrincipal#getDisplayName(org.opencms.file.CmsObject, java.util.Locale, org.opencms.workplace.I_CmsGroupNameTranslation)
084     */
085    @Override
086    public String getDisplayName(CmsObject cms, Locale locale, I_CmsGroupNameTranslation translation) {
087
088        return getDisplayName(cms, locale);
089    }
090
091    /**
092     * Gets the wrapped role.
093     *
094     * @return the wrapped role
095     */
096    public CmsRole getRole() {
097
098        return m_role;
099    }
100
101}