Page History

...

Category	Subtype	Action	Class
Attestation	Folders	insert / update / delete	AttestationStemSave
Attestation	Groups	insert / update / delete	AttestationGroupSave
Attribute assignment	Attribute assignment	insert / update / delete	AttributeAssignToAssignmentSave (2.5.48+)
	Folders	insert / update / delete	AttributeAssignToStemSave
	Group	insert / update / delete	AttributeAssignToGroupSave
Attribute definition		insert / update / delete	AttributeDefSave
Attribute name		insert / update / delete	AttributeDefNameSave
Attribute value		insert / update / delete	AttributeAssignValueSave
Composite		insert /update / delete	CompositeSave
Composite		finder	CompositeFinder
Email SMTP			GrouperEmail
Gc db access		gc db access	GcDbAccess
Grouper session			GrouperSession
Group		insert / update / delete	GroupSave
		finder	GroupFinder
		copy	GroupCopy
gsh		gsh template exec	GshTemplateExec
Http			GrouperHttpClient
Ldap		ldap session utils	LdapSessionUtils
Member		finder	MemberFinder
Membership		insert / update / delete	MembershipSave
Membership		finder	MembershipFinder
Password		insert / update	GrouperPasswordSave
Privilege inheritance	Attribute definitions	insert / update / delete	PrivilegeAttributeDefInheritanceSave
	Folders	insert / update / delete	PrivilegeStemInheritanceSave
	Groups	insert / update / delete	PrivilegeGroupInheritanceSave
Provisionable	Folders	finder	ProvisionableStemFinder
	Folders	insert / update / delete	ProvisionableStemSave
	Groups	finder	ProvisionableGroupFinder
	Groups	insert / update / delete	ProvisionableGroupSave
Stem		insert/update/delete	StemSave
		finder	StemFinder
		copy	StemCopy
Subject		finder	SubjectFinder
Sync data to SQL table			GcTableSyncFromData
Types	Folders	finder	GdgTypeStemFinder
	Folders	insert / update / delete	GdgTypeStemSave
	Groups	finder	GdgTypeGroupFinder
	Groups	insert / update / delete	GdgTypeGroupSave

...

Command

Description

addSubject(id, type, name)

Add local subject to registry. You need the jdbc source for this to work. The type parameter describes the type of subject (e.g. "peopleperson"), and is required non-null even though there are few useful api methods to query it.

In 2.4.0.api.41+ patch, this will also create the id, name, description, and loginid attribute (unless grouper.properties create.attributes.when.creating.registry.subjects is false)

RegistrySubject.addOrUpdate(grouperSession, id, type, name, nameAttributeValue, loginid, description, email)

In 2.4.0.api.41+ patch, add a registry subject like addSubject, but specify the attribute values of name, loginid, etc
e.g. RegistrySubject.addOrUpdate(grouperSession, "someTestSubject", "person", "Some Testsubject", "Name Some Test Subject", "stsub", "Some Testsubject - employee - also alumni", "some@test.subject");

RegistrySubject.find(id, errorOnNotFound)

In 2.4.0.api.41+ patch, get a registry subject
e.g. registrySubject = RegistrySubject.find("someTestSubject", false);

registrySubject.delete(grouperSession)

In 2.4.0.api.41+ patch, delete a registry subject
e.g. registrySubject.delete(grouperSession);

RegistrySubjectAttribute.addOrUpdate(subjectId, attributeName, attributeValue)

In 2.4.0.api.41+ patch, add or update a registry subject attribute

registrySubjectAttribute.delete()

In 2.4.0.api.41+ patch, delete an attribute value

findSubject(idOrIdentifier)

Find a subject by id or identifier

findSubject(idOrIdentifier, type)

Find a subject by id or identifier; type is a deprecated parameter that is ignored

findSubject(idOrIdentifier, type, source)

Find a subject by id or identifier for a specific subject source; type is a deprecated parameter that is ignored

getSources()

Find all Subject sources

grouperSession = GrouperSession.startRootSession();
SubjectFinder.findAll(searchString, source);

Find all subjects in a source by search string

grouperSession = GrouperSession.startRootSession();
SubjectFinder.findByIdAndSource(id, source, exceptionIfNull);
SubjectFinder.findByIdAndSource("12345", "jdbc", true);

Find a subject by id in a certain source

grouperSession = GrouperSession.startRootSession();
SubjectFinder.findByIdentifierAndSource(identifier, source, exceptionIfNull);
SubjectFinder.findByIdentifierAndSource("jsmith", "jdbc", true);

Find a subject by identifier in a certain source

grouperSession = GrouperSession.startRootSession();
SubjectFinder.findByIdOrIdentifierAndSource(idOrIdentifier, source, exceptionIfNull);
SubjectFinder.findByIdOrIdentifierAndSource("jsmith", "jdbc", true);

Find a subject by id or identifier in a certain source

add test subjects to registry (e.g. test.subject.0 through 9)

grouperSession = GrouperSession.startRootSession();
new RegistryReset()._addSubjects();

Edit subject (in this case name)

RegistrySubject registrySubject = GrouperDAOFactory.getFactory().getRegistrySubject().find("user1a", "person", true);
registrySubject.setName("New name");
HibernateSession.byObjectStatic().update(registrySubject);

add a subject application principal with attributes (GSH)

Code Block

String principal = "someApp";
String email = null;

GrouperSession grouperSession = GrouperSession.startRootSession();


addSubject(principal, "application", principal);
HibernateSession.bySqlStatic().executeSql("insert into subjectattribute (subjectId, name, value, searchValue) values (?, ?, ?, ?)", GrouperUtil.toListObject(new Object[]{principal, "description", principal, principal.toLowerCase()}));
if (email != null){ HibernateSession.bySqlStatic().executeSql("insert into subjectattribute (subjectId, name, value, searchValue) values (?, ?, ?, ?)", GrouperUtil.toListObject(new Object[]{principal, "email", email, email.toLowerCase()}));}
HibernateSession.bySqlStatic().executeSql("insert into subjectattribute (subjectId, name, value, searchValue) values (?, ?, ?, ?)", GrouperUtil.toListObject(new Object[]{principal, "loginid", principal, principal}));
HibernateSession.bySqlStatic().executeSql("insert into subjectattribute (subjectId, name, value, searchValue) values (?, ?, ?, ?)", GrouperUtil.toListObject(new Object[]{principal, "name", principal, principal}));

remove a subject with attributes (GSH)

Code Block

String principal = "someApp";
String email = null;

GrouperSession grouperSession = GrouperSession.startRootSession();

HibernateSession.bySqlStatic().executeSql("delete from subjectattribute where subjectId = ?", GrouperUtil.toListObject(new Object[]{principal}));
HibernateSession.bySqlStatic().executeSql("delete from subject where subjectId = ?", GrouperUtil.toListObject(new Object[]{principal}));

subject api diagnostics

grouper.properties (temporarily)

Code Block
gsh.exitOnSubjectCheckConfigProblem = false

gsh

Code Block

GrouperSession.startRootSession();
new edu.internet2.middleware.grouper.grouperUi.serviceLogic.SubjectSourceDiagnostics().assignSourceId("SMUPerson_DEV").assignSubjectId("empl1").assignSubjectIdentifier("netid@school.edu").assignSearchString("em").subjectSourceDiagnosticsFromGsh()
===>
SUCCESS: Found subject by id in 37ms: 'empl1'
         with SubjectFinder.findByIdAndSource("empl1", "SMUPerson_DEV", false)
SUCCESS: Subject id in returned subject matches the subject id searched for: 'empl1'
WARNING: No subject found by identifier in 14ms: 'netid@school.edu'
         with SubjectFinder.findByIdentifierAndSource("netid@school.edu", "SMUPerson_DEV", false)

...

Page tree

Versions Compared

Old Version 141

New Version 142

Key