1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.shiro.authc;
20
21 import org.apache.shiro.authz.AuthorizationInfo;
22
23 /**
24 * An <tt>Account</tt> is a convenience interface that extends both {@link AuthenticationInfo} and
25 * {@link AuthorizationInfo} and represents authentication and authorization for a <em>single account</em> in a
26 * <em>single Realm</em>.
27 * <p/>
28 * This interface can be useful when a Realm implementation finds it more convenient to use a single object to
29 * encapsulate both the authentication and authorization information used by both authc and authz operations.
30 * <p/>
31 * <b>Please Note</b>: Since Shiro sometimes logs account operations, please ensure your Account's <code>toString()</code>
32 * implementation does <em>not</em> print out account credentials (password, etc), as these might be viewable to
33 * someone reading your logs. This is good practice anyway, and account principals should rarely (if ever) be printed
34 * out for any reason. If you're using Shiro's default implementations of this interface, they only ever print the
35 * account {@link #getPrincipals() principals}, so you do not need to do anything additional.
36 *
37 * @see SimpleAccount
38 * @since 0.9
39 */
40 public interface Account extends AuthenticationInfo, AuthorizationInfo {
41
42 }