001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.authc;
020
021import org.apache.shiro.authz.AuthorizationInfo;
022
023/**
024 * An <tt>Account</tt> is a convenience interface that extends both {@link AuthenticationInfo} and
025 * {@link AuthorizationInfo} and represents authentication and authorization for a <em>single account</em> in a
026 * <em>single Realm</em>.
027 * <p/>
028 * This interface can be useful when a Realm implementation finds it more convenient to use a single object to
029 * encapsulate both the authentication and authorization information used by both authc and authz operations.
030 * <p/>
031 * <b>Please Note</b>:  Since Shiro sometimes logs account operations, please ensure your Account's <code>toString()</code>
032 * implementation does <em>not</em> print out account credentials (password, etc), as these might be viewable to
033 * someone reading your logs.  This is good practice anyway, and account principals should rarely (if ever) be printed
034 * out for any reason.  If you're using Shiro's default implementations of this interface, they only ever print the
035 * account {@link #getPrincipals() principals}, so you do not need to do anything additional.
036 *
037 * @see SimpleAccount
038 * @since 0.9
039 */
040public interface Account extends AuthenticationInfo, AuthorizationInfo {
041
042}