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.subject; 020 021import java.util.Collection; 022 023 024/** 025 * A {@link PrincipalCollection} that allows modification. 026 * 027 * @since 0.9 028 */ 029public interface MutablePrincipalCollection extends PrincipalCollection { 030 031 /** 032 * Adds the given principal to this collection. 033 * 034 * @param principal the principal to be added. 035 * @param realmName the realm this principal came from. 036 */ 037 void add(Object principal, String realmName); 038 039 /** 040 * Adds all of the principals in the given collection to this collection. 041 * 042 * @param principals the principals to be added. 043 * @param realmName the realm these principals came from. 044 */ 045 void addAll(Collection principals, String realmName); 046 047 /** 048 * Adds all of the principals from the given principal collection to this collection. 049 * 050 * @param principals the principals to add. 051 */ 052 void addAll(PrincipalCollection principals); 053 054 /** 055 * Removes all Principals in this collection. 056 */ 057 void clear(); 058}