com.netegrity.llsdk6.imsapi.utility
Interface TSContext

All Superinterfaces:

java.io.Serializable

public interface TSContext
extends java.io.Serializable

Contains information about the current task, such as the subject of the task, security information, and an instance of the task.

You retrieve the current TSContext object from the getTSContext() method inherited by ...Context objects (such as BLTHContext).

TSContext is passed into methods of provider objects such as UserProvider. Provider objects are retrieved through ProviderAccessor.

Since:

IdentityMinder 6.0

Method Summary

boolean	checkSecurityAgainstTSContext() Determines whether security checks will be made against the subject's attributes and group memberships as stored in the data store, or against the current information in TSContext.
User	getAdministrator() Retrieves the administrator who is executing the current task.
java.util.Vector	getGroupsToAddSubjectTo() Retrieves the groups to which the subject is being added.
java.util.Vector	getGroupsToRemoveSubjectFrom() Retrieves the groups from which the subject is being removed.
ProposedChangesCollection	getProposedChangesCollection() Get proposed changes.
ManagedObject	getSubject() Retrieves the subject of the current task -- for example, a User object in a Create User task.
AdminTask	getTask() Retrieves the admin task being executed.
void	setSubject(ManagedObject obj) Internal use only.
void	setTask(AdminTask task) Internal use only.

Method Detail

getAdministrator

User getAdministrator()
                      throws java.lang.Exception

Retrieves the administrator who is executing the current task.

Returns:

The administrator executing the task.

Throws:

java.lang.Exception

getSubject

ManagedObject getSubject()

Retrieves the subject of the current task -- for example, a User object in a Create User task.

Returns:

The subject of the task. Returns null if there is no subject or a subject has not been set.

getTask

AdminTask getTask()

Retrieves the admin task being executed.

Returns:

The current admin task.

Throws:

java.lang.Exception

setSubject

void setSubject(ManagedObject obj)
                throws java.lang.Exception

Internal use only.

Throws:

java.lang.Exception

setTask

void setTask(AdminTask task)
             throws NotAuthorizedException,
                    java.lang.Exception

Internal use only.

Throws:

NotAuthorizedException

java.lang.Exception

getGroupsToAddSubjectTo

java.util.Vector getGroupsToAddSubjectTo()

Retrieves the groups to which the subject is being added.

Returns:

A Vector of group objects, or one of the following:

• null if the subject is not a GroupableObject.
• An empty Vector if the subject is a GroupableObject, but is not being added to any groups.

getGroupsToRemoveSubjectFrom

java.util.Vector getGroupsToRemoveSubjectFrom()

Retrieves the groups from which the subject is being removed.

Returns:

A Vector of group objects, or one of the following:

• null if the subject is not a GroupableObject.
• An empty Vector if the subject is a GroupableObject, but is not being removed from any groups.

checkSecurityAgainstTSContext

boolean checkSecurityAgainstTSContext()

Determines whether security checks will be made against the subject's attributes and group memberships as stored in the data store, or against the current information in TSContext.

Returns:

true to make security checks against the current information in TSContext, or false to make security checks against the information stored in the data store for this object.

getProposedChangesCollection

ProposedChangesCollection getProposedChangesCollection()

Get proposed changes. ProposedChangesCollection contains the relationship changes (assigned and revoked) like group and role memberships

Returns:

Proposed changes collection class