PrincipalProvider.java

/**
 * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.seedstack.seed.security.principals;

import java.io.Serializable;

/**
 * Represents a principal of a user, which is an attribute.
 * 
 * @param <T>
 *            the type of the object provided by the principal
 */
public interface PrincipalProvider<T extends Serializable> {

    /**
     * Gives the enclosed principal
     * 
     * @return the object enclosed in the principal
     */
    T getPrincipal();
}