org.efaps.jaas.xml.AbstractXMLPrincipal Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2003 - 2012 The eFaps Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Revision:        $Rev: 7483 $
 * Last Changed:    $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
 * Last Changed By: $Author: [email protected] $
 */

package org.efaps.jaas.xml;

import java.security.Principal;

import org.apache.commons.lang.builder.ToStringBuilder;

/**
 * The abstract class is used to implement the person, role and group principal
 * instances used by class {@link XMLUserLoginModule}.
 *
 * @author The eFaps Team
 * @version $Id: AbstractXMLPrincipal.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public abstract class AbstractXMLPrincipal
    implements Principal
{
    /**
     * The instance variable stores the name of the principal.
     *
     * @see #getName
     * @see #setName
     */
    private String name = null;

    /**
     * Returns the name of this principal stored in instance variable
     * {@link #name}.
     *
     * @return name of this principal
     * @see #name
     * @see #setName
     */
    public String getName()
    {
        return this.name;
    }

    /**
     * Sets the name of this principal stored in instance variable
     * {@link #name}. The method must be public, because it is set from the XML
     * to bean converter in {@link XMLUserLoginModule}.
     *
     * @param _name new name to set for this principal
     * @see #name
     * @see #getName
     */
    public void setName(final String _name)
    {
        this.name = _name;
    }

    /**
     * Returns a string representation of this principal.
     *
     * @return string representation of this principal
     */
    @Override
    public String toString()
    {
        return new ToStringBuilder(this)
            .append("name", getName())
            .toString();
    }
}