blob: e3c678686f2ef41e50612b8e3756f802890c5fe5 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.apache.ki.authc;
import org.apache.ki.authz.AuthorizationInfo;
/**
* An <tt>Account</tt> is a convenience interface that extends both {@link AuthenticationInfo} and
* {@link org.apache.ki.authz.AuthorizationInfo} and represents authentication and authorization for a <em>single account</em> in a
* <em>single Realm</em>.
* <p/>
* This interface can be useful when an Realm implementation finds it more convenient to use a single object to
* encapsulate both the authentication and authorization information used by both authc and authz operations.
* <p/>
* <b>Please Note</b>: Since Ki sometimes logs account operations, please ensure your Account's <code>toString()</code>
* implementation does <em>not</em> print out account credentials (password, etc), as these might be viewable to
* someone reading your logs. This is good practice anyway, and account principals should rarely (if ever) be printed
* out for any reason. If you're using Ki's default implementations of this interface, they only ever print the
* account {@link #getPrincipals() principals}, so you do not need to do anything additional.
*
* @author Jeremy Haile
* @author Les Hazlewood
* @see SimpleAccount
* @since 0.9
*/
public interface Account extends AuthenticationInfo, AuthorizationInfo {
}