|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.internet2.middleware.grouper.GrouperAPI
edu.internet2.middleware.grouper.RegistrySubject
public class RegistrySubject
A Subject local to the Groups Registry.
NOTE: THIS CLASS IS NOT CONSIDERED STABLE AND MAY CHANGE IN FUTURE RELEASES.
| Field Summary |
|---|
| Fields inherited from class edu.internet2.middleware.grouper.GrouperAPI |
|---|
COLUMN_HIBERNATE_VERSION_NUMBER, FIELD_DB_VERSION, FIELD_HIBERNATE_VERSION_NUMBER, INITIAL_VERSION_NUMBER |
| Fields inherited from interface org.hibernate.classic.Lifecycle |
|---|
NO_VETO, VETO |
| Constructor Summary | |
|---|---|
RegistrySubject()
|
|
| Method Summary | |
|---|---|
static RegistrySubject |
add(GrouperSession s,
java.lang.String id,
java.lang.String type,
java.lang.String name)
Add a Subject to a Source within the Groups Registry. |
RegistrySubject |
clone()
deep clone the fields in this object |
void |
delete(GrouperSession s)
Delete existing RegistrySubject. |
boolean |
equals(java.lang.Object obj)
|
java.util.Map<java.lang.String,java.util.Set<java.lang.String>> |
getAttributes()
|
java.util.Map<java.lang.String,java.util.Set<java.lang.String>> |
getAttributes(boolean excludeInternalAttributes)
|
java.lang.String |
getAttributeValue(java.lang.String name)
Return the value of the specified attribute. |
java.lang.String |
getAttributeValue(java.lang.String attributeName,
boolean excludeInternalAttributes)
|
java.lang.String |
getAttributeValueOrCommaSeparated(java.lang.String attributeName)
|
java.lang.String |
getAttributeValueOrCommaSeparated(java.lang.String attributeName,
boolean excludeInternalAttributes)
|
java.util.Set<java.lang.String> |
getAttributeValues(java.lang.String name)
Return the values for the specified attribute. |
java.util.Set<java.lang.String> |
getAttributeValues(java.lang.String attributeName,
boolean excludeInternalAttributes)
|
java.lang.String |
getAttributeValueSingleValued(java.lang.String attributeName)
|
java.lang.String |
getAttributeValueSingleValued(java.lang.String attributeName,
boolean excludeInternalAttributes)
|
java.lang.String |
getDescription()
Return this subject's description. |
java.lang.String |
getId()
Return the subject id. |
java.lang.String |
getName()
Return the subject's name. |
edu.internet2.middleware.subject.Source |
getSource()
Return the source. |
java.lang.String |
getSourceId()
|
edu.internet2.middleware.subject.SubjectType |
getType()
Return this subject's SubjectType. |
java.lang.String |
getTypeName()
|
java.lang.String |
getTypeString()
|
int |
hashCode()
|
void |
setId(java.lang.String id)
|
void |
setName(java.lang.String name)
|
void |
setTypeString(java.lang.String type)
|
java.lang.String |
toString()
|
| Methods inherited from class edu.internet2.middleware.grouper.GrouperAPI |
|---|
dbVersion, dbVersionClear, dbVersionDifferentFields, dbVersionIsDifferent, dbVersionReset, fieldValue, getHibernateVersionNumber, onDelete, onLoad, onPostDelete, onPostSave, onPostUpdate, onPreDelete, onPreSave, onPreUpdate, onSave, onUpdate, setHibernateVersionNumber |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public RegistrySubject()
| Method Detail |
|---|
public RegistrySubject clone()
GrouperAPI
clone in interface GrouperCloneableclone in class GrouperAPIGrouperAPI.clone()
public static RegistrySubject add(GrouperSession s,
java.lang.String id,
java.lang.String type,
java.lang.String name)
throws GrouperException,
InsufficientPrivilegeException
Subject to a Source within the Groups Registry.
Subjects may only be added within a root-like session.
try {
RegistrySubject subj = RegistrySubject.add(s, "subject id", "person", "name");
}
catch (GrouperException eG) {
// unable to add subject
}
catch (InsufficientPrivilegeException eIP) {
// not privileged to add subject
}
s - Create subject within this session context.id - The subject id to assign to the subject.type - The subject type to assign to the subject.name - The name to assign to the subject.
RegistrySubject.
GrouperException
InsufficientPrivilegeException
public void delete(GrouperSession s)
throws GrouperException,
java.lang.IllegalStateException,
InsufficientPrivilegeException
RegistrySubject.
try {
rSubj.delete(s);
}
catch (GrouperException eG) {
// failed to delete this RegistrySubject
}
catch (InsufficientPrivilegeException eIP) {
// not privileged to delete this RegistrySubject
}
s - Delete RegistrySubject within this GrouperSession context.
GrouperException - if RegistrySubject cannot be deleted.
java.lang.IllegalStateException - if GrouperSession is null.
InsufficientPrivilegeException - if not privileged to delete RegistrySubjects.public java.lang.String getAttributeValue(java.lang.String name)
getAttributeValue in interface edu.internet2.middleware.subject.Subjectname -
public java.util.Set<java.lang.String> getAttributeValues(java.lang.String name)
getAttributeValues in interface edu.internet2.middleware.subject.Subjectname -
public java.lang.String getDescription()
getDescription in interface edu.internet2.middleware.subject.Subjectpublic java.lang.String getId()
getId in interface edu.internet2.middleware.subject.Subjectpublic java.lang.String getName()
getName in interface edu.internet2.middleware.subject.Subject
public edu.internet2.middleware.subject.Source getSource()
throws java.lang.IllegalStateException
NOTE: The current implementation is very crude and inefficient. It attempts to query for the subject to identify the source.
getSource in interface edu.internet2.middleware.subject.Subjectjava.lang.IllegalStateException - if source cannot be returned.public edu.internet2.middleware.subject.SubjectType getType()
SubjectType.
getType in interface edu.internet2.middleware.subject.Subjectpublic java.lang.String getTypeString()
public boolean equals(java.lang.Object obj)
equals in class java.lang.ObjectObject.equals(java.lang.Object)public int hashCode()
hashCode in class java.lang.ObjectObject.hashCode()public void setId(java.lang.String id)
id - public void setName(java.lang.String name)
name - public void setTypeString(java.lang.String type)
type - public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public java.lang.String getAttributeValueOrCommaSeparated(java.lang.String attributeName)
getAttributeValueOrCommaSeparated in interface edu.internet2.middleware.subject.SubjectSubject.getAttributeValueOrCommaSeparated(java.lang.String)public java.lang.String getAttributeValueSingleValued(java.lang.String attributeName)
getAttributeValueSingleValued in interface edu.internet2.middleware.subject.SubjectSubject.getAttributeValueSingleValued(java.lang.String)public java.lang.String getSourceId()
getSourceId in interface edu.internet2.middleware.subject.SubjectSubject.getSourceId()public java.lang.String getTypeName()
getTypeName in interface edu.internet2.middleware.subject.SubjectSubject.getTypeName()public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getAttributes()
getAttributes in interface edu.internet2.middleware.subject.SubjectSubject.getAttributes()
public java.lang.String getAttributeValue(java.lang.String attributeName,
boolean excludeInternalAttributes)
getAttributeValue in interface edu.internet2.middleware.subject.SubjectSubject.getAttributeValue(java.lang.String, boolean)
public java.lang.String getAttributeValueOrCommaSeparated(java.lang.String attributeName,
boolean excludeInternalAttributes)
getAttributeValueOrCommaSeparated in interface edu.internet2.middleware.subject.SubjectSubject.getAttributeValueOrCommaSeparated(java.lang.String, boolean)
public java.lang.String getAttributeValueSingleValued(java.lang.String attributeName,
boolean excludeInternalAttributes)
getAttributeValueSingleValued in interface edu.internet2.middleware.subject.SubjectSubject.getAttributeValueSingleValued(java.lang.String, boolean)
public java.util.Set<java.lang.String> getAttributeValues(java.lang.String attributeName,
boolean excludeInternalAttributes)
getAttributeValues in interface edu.internet2.middleware.subject.SubjectSubject.getAttributeValues(java.lang.String, boolean)public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getAttributes(boolean excludeInternalAttributes)
getAttributes in interface edu.internet2.middleware.subject.SubjectSubject.getAttributes(boolean)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||