edu.internet2.middleware.grouper.subj.GrouperSubject Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of grouper Show documentation
Show all versions of grouper Show documentation
Internet2 Groups Management Toolkit
/**
* Copyright 2014 Internet2
*
* Licensed 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.
*/
/*
Copyright (C) 2004-2007 University Corporation for Advanced Internet Development, Inc.
Copyright (C) 2004-2007 The University Of Chicago
Licensed 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 edu.internet2.middleware.grouper.subj;
import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import edu.internet2.middleware.grouper.Attribute;
import edu.internet2.middleware.grouper.Group;
import edu.internet2.middleware.grouper.GrouperSourceAdapter;
import edu.internet2.middleware.grouper.SubjectFinder;
import edu.internet2.middleware.grouper.entity.EntitySubject;
import edu.internet2.middleware.grouper.group.TypeOfGroup;
import edu.internet2.middleware.grouper.cfg.GrouperConfig;
import edu.internet2.middleware.grouper.misc.E;
import edu.internet2.middleware.grouper.util.GrouperUtil;
import edu.internet2.middleware.subject.SourceUnavailableException;
import edu.internet2.middleware.subject.Subject;
import edu.internet2.middleware.subject.SubjectCaseInsensitiveMap;
import edu.internet2.middleware.subject.SubjectCaseInsensitiveMapImpl;
import edu.internet2.middleware.subject.SubjectNotFoundException;
import edu.internet2.middleware.subject.provider.SubjectImpl;
import edu.internet2.middleware.subject.provider.SubjectTypeEnum;
/**
* {@link Subject} returned by the {@link GrouperSourceAdapter}.
*
* @author blair christensen.
* @version $Id: GrouperSubject.java,v 1.12 2009-10-22 14:03:18 mchyzer Exp $
*/
@SuppressWarnings("serial")
public class GrouperSubject extends SubjectImpl {
/**
* lazy load map that doesnt do any queries until it really needs to
* @param
* @param
*/
@SuppressWarnings("serial")
private class GrouperSubjectAttributeMap implements Map, Serializable, SubjectCaseInsensitiveMap {
/** underlying datastore */
private SubjectCaseInsensitiveMapImpl attrs = new SubjectCaseInsensitiveMapImpl();
/**
* @see java.util.Map#clear()
*/
public void clear() {
this.attrs.clear();
}
/**
* @see java.util.Map#containsKey(java.lang.Object)
*/
public boolean containsKey(Object key) {
if (this.attrs.containsKey(key)) {
return true;
}
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
return this.attrs.containsKey(key);
}
/**
* @see java.util.Map#containsValue(java.lang.Object)
*/
public boolean containsValue(Object value) {
if (this.attrs.containsValue(value)) {
return true;
}
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
return this.attrs.containsValue(value);
}
/**
* @see java.util.Map#entrySet()
*/
public Set> entrySet() {
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
return this.attrs.entrySet();
}
/**
* @see java.util.Map#get(java.lang.Object)
*/
public V get(Object key) {
if (!this.attrs.containsKey(key)) {
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
}
return (V)this.attrs.get(key);
}
/**
* @see java.util.Map#isEmpty()
*/
public boolean isEmpty() {
if (this.attrs.isEmpty()) {
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
}
return this.attrs.isEmpty();
}
/**
* @see java.util.Map#keySet()
*/
public Set keySet() {
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
return (Set)this.attrs.keySet();
}
/**
* @see java.util.Map#put(java.lang.Object, java.lang.Object)
*/
public V put(K key, V value) {
return this.put(key, value, true);
}
/**
* @param key
* @param value
* @param populateAttributesBefore
* @return value
*/
public V put(K key, V value, boolean populateAttributesBefore) {
if (populateAttributesBefore) {
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
}
return this.attrs.put(key, value);
}
/**
* @see java.util.Map#putAll(java.util.Map)
*/
public void putAll(Map t) {
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
this.attrs.putAll(t);
}
/**
* @see java.util.Map#remove(java.lang.Object)
*/
public V remove(Object key) {
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
return this.attrs.remove(key);
}
/**
* @see java.util.Map#size()
*/
public int size() {
//there is a weird error if not initted since size is call on constructor...
if (!this.attrs.isInitted()) {
return 0;
}
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
return this.attrs.size();
}
/**
* @see java.util.Map#values()
*/
public Collection values() {
GrouperSubject.this._populateAttributes();
GrouperSubject.this._populateCreateModifyTime();
return this.attrs.values();
}
}
/** lazy load the map attributes of group attributes */
private boolean loadedGroupAttributes = false;
/** lazy load the modify and create subjects */
private boolean loadedModifyCreateSubjects = false;
/**
* if loaded group attributes
* @return true/false
*/
public boolean isLoadedGroupAttributes() {
return this.loadedGroupAttributes;
}
/**
* if loaded group attributes
* @return true/false
*/
public boolean isLoadedModifyCreateSubjects() {
return this.loadedModifyCreateSubjects;
}
/** keep a reference to the group */
private Group group;
/**
* @param g
* @throws SourceUnavailableException
*/
public GrouperSubject(Group g)
throws SourceUnavailableException {
super(g.getUuid(), null, null,
g.getTypeOfGroup() == TypeOfGroup.entity ? SubjectTypeEnum.APPLICATION.getName() : SubjectTypeEnum.GROUP.getName(),
g.getTypeOfGroup() == TypeOfGroup.entity ? SubjectFinder.internal_getEntitySourceAdapter(true).getId() : SubjectFinder.internal_getGSA().getId(),
null, "name", null);
this.group = g;
/** attributes (refresh if not found) */
GrouperSubjectAttributeMap> attrs
= new GrouperSubjectAttributeMap>();
attrs.put( "name", GrouperUtil.toSet(g.getName()), false);
attrs.put( "displayName", GrouperUtil.toSet(g.getDisplayName()), false);
attrs.put( "alternateName", g.getAlternateNames(), false);
attrs.put( "extension", GrouperUtil.toSet(g.getExtension()), false);
attrs.put( "displayExtension", GrouperUtil.toSet(g.getDisplayExtension()), false );
attrs.put( "description", GrouperUtil.toSet(g.getDescription()), false);
attrs.put( "modifyTime", GrouperUtil.toSet(g.getModifyTime().toString()), false );
attrs.put( "createTime", GrouperUtil.toSet(g.getCreateTime().toString()), false );
if (g.getTypeOfGroup() == TypeOfGroup.entity) {
String entityAttributeId = EntitySubject.entityIdAttributeValue(g.getUuid());
attrs.put( "entityIdAttribute", GrouperUtil.toSet(entityAttributeId), false );
String entityName = StringUtils.isBlank(entityAttributeId) ? g.getName() : entityAttributeId;
attrs.put( "entityId", GrouperUtil.toSet(entityName), false );
//get the stem
String stem = GrouperUtil.parentStemNameFromName(g.getName());
//subtract
String extension = entityName.substring(stem.length()+1);
attrs.put( "entityExtension", GrouperUtil.toSet(extension), false );
}
super.setAttributes(attrs);
}
/**
*
* @see edu.internet2.middleware.subject.Subject#getAttributeValue(java.lang.String)
*/
public String getAttributeValue(String name) {
return StringUtils.defaultString(super.getAttributeValue(name));
}
/**
*
* @see edu.internet2.middleware.subject.Subject#getDescription()
*/
public String getDescription() {
return this.getAttributeValue("description");
}
/**
*
*/
private void _populateCreateModifyTime() {
if (this.loadedModifyCreateSubjects) {
return;
}
if (GrouperConfig.retrieveConfig().propertyValueBoolean("subjects.group.useCreatorAndModifierAsSubjectAttributes", true)) {
try {
// Don't bother with any of the create* attrs unless we can find
// the creating subject
Subject creator = group.getCreateSubject();
((GrouperSubjectAttributeMap)this.getAttributes(false)).put( "createSubjectId", GrouperUtil.toSet(creator.getId()), false);
((GrouperSubjectAttributeMap)this.getAttributes(false)).put( "createSubjectType", GrouperUtil.toSet(creator.getType().getName()), false);
}
catch (SubjectNotFoundException eSNF0) {
LOG.info(E.GSUBJ_NOCREATOR + eSNF0.getMessage() + ", groupId: " + (this.group == null ? null : this.group.getId() )
+ ", creatorMemberId: " + (this.group == null ? null : this.group.getCreatorUuid() ));
}
try {
// Don't bother with any of the modify* attrs unless we can find
// the modifying subject
Subject modifier = group.getModifySubject();
((GrouperSubjectAttributeMap)this.getAttributes(false)).put( "modifySubjectId",
GrouperUtil.toSet(modifier.getId()), false);
((GrouperSubjectAttributeMap)this.getAttributes(false)).put( "modifySubjectType",
GrouperUtil.toSet(modifier.getType().getName()), false);
}
catch (SubjectNotFoundException eSNF1) {
// No modifier
}
}
this.loadedModifyCreateSubjects = true;
}
/**
* get the group inside
* @return the group
*/
public Group internal_getGroup() {
return this.group;
}
/**
*
*/
private void _populateAttributes() {
if (this.loadedGroupAttributes) {
return;
}
Map.Entry kv;
Iterator> it = group.getAttributesMap(true).entrySet().iterator();
int count=0;
while (it.hasNext()) {
kv = it.next();
((GrouperSubjectAttributeMap)this.getAttributes(false)).put( kv.getKey(), GrouperUtil.toSet(kv.getValue().getValue()), false );
count++;
}
this.loadedGroupAttributes = true;
if (LOG.isDebugEnabled()) {
GrouperSubjectAttributeMap grouperSubjectAttributeMap = (GrouperSubjectAttributeMap)GrouperUtil.nonNull(this.getAttributes(false));
int attrSize = grouperSubjectAttributeMap == null ? 0 : grouperSubjectAttributeMap.attrs.size();
LOG.debug("[" + this.getName() + "] attached " + count + " new attributes: "
+ attrSize );
}
}
/** logger */
private static final Log LOG = GrouperUtil.getLog(GrouperSubject.class);
}