Package | Description |
---|---|
com.sas.hls.messaging.subscription |
Service for creating and retrieving subscriptions.
|
com.sas.hls.security.group |
Service and class definitions for manipulating and creating groups.
|
com.sas.hls.security.group.exception |
Exceptions that can be thrown while manipulating a group or using the groupService.
|
com.sas.hls.security.membership |
Service and class definitions for manipulating the membership of a context.
|
com.sas.hls.security.membership.exception |
Exceptions that can be thrown while manipulating a membership list or using the membershipService.
|
com.sas.hls.security.principal.exception |
Exceptions that can be thrown while manipulating or accessing principals in the system.
|
com.sas.hls.security.role |
Service and class definitions for manipulating and creating roles, their
availability in contexts, and their membership lists.
|
com.sas.hls.security.role.exception |
Exceptions that can be thrown while manipulating roles or using the roleDefinitionService or roleAssignmentService.
|
com.sas.hls.security.user |
Service and class definitions for manipulating and creating Users.
|
com.sas.hls.work.processflow |
Service and class definitions for getting process flow information.
|
Modifier and Type | Method and Description |
---|---|
Principal |
Subscription.getPrincipal()
Get the principal for the subscription
|
Modifier and Type | Method and Description |
---|---|
Subscription |
SubscriptionService.createSubscription(String path,
SubscribableEvent event,
Principal principal,
boolean cascade)
Create a subscription to the specified event on the object represented by the specified path, for the given
principal.
|
Set<Subscription> |
SubscriptionService.getSubscriptionsByPrincipal(Principal principal)
Get the subscriptions for the specified principal.
|
void |
Subscription.setPrincipal(Principal principal)
Set the principal for the subscription
|
Modifier and Type | Method and Description |
---|---|
Set<Subscription> |
SubscriptionService.createSubscriptions(String path,
SubscribableEvent event,
Set<Principal> principals,
boolean cascade)
Create a subscription to the specified event on the object represented by the specified path, for the given
principals.
|
Constructor and Description |
---|
Subscription(String path,
Principal principal,
SubscribableEvent event,
boolean cascade)
Constructor
|
Modifier and Type | Class and Description |
---|---|
class |
Group
Group is a collection of principals (users or other groups) and may be identified by a name and context.
|
class |
GroupDescriptor
A light-weight client representation of a group.
|
Modifier and Type | Method and Description |
---|---|
Set<Principal> |
Group.getMembers()
Get the members of this group.
|
Modifier and Type | Method and Description |
---|---|
Set<GroupDescriptor> |
GroupService.getAllGroupsByMember(Principal member)
Get all groups that have the specified principal as a member.
|
Set<GroupDescriptor> |
GroupService.getAllReachableGroupsByMember(Principal member)
Returns a set of all reachable groups.
|
Set<GroupDescriptor> |
GroupService.getGroupsByMember(GroupContext groupContext,
Principal member)
Get all groups in a given context that have the specified principal as a member.
|
Set<GroupDescriptor> |
GroupService.getReachableGroupsByMember(GroupContext groupContext,
Principal member)
Returns a set of all reachable groups in the specified context.
|
boolean |
GroupService.isMember(String identifier,
Principal member)
Deprecated.
As of Java API 1.8. Replaced with
GroupService.isMember(String, Principal, boolean) . |
boolean |
GroupService.isMember(String identifier,
Principal member,
boolean includeImplicit)
Test to see if a given principal is member of the group, using the group identifier specified.
|
void |
GroupService.removeFromGroups(Principal member)
Remove the specified member from all groups.
|
Modifier and Type | Method and Description |
---|---|
Group |
GroupService.createGroup(GroupContext groupContext,
String groupName,
String groupDescription,
Set<Principal> members)
Create a new group.
|
void |
GroupService.removeFromGroupContextGroups(GroupContext groupContext,
Set<Principal> members)
Remove the specified members from all groups in a specific context.
|
void |
Group.setMembers(Set<Principal> members)
Set the members of this group.
|
Constructor and Description |
---|
Group(ObjectIdentity groupContext,
String name,
String identifier,
String principalId,
String principalName,
String description,
Set<Principal> members)
Constructor
|
Group(ObjectIdentity groupContext,
String name,
String identifier,
String principalId,
String principalName,
String description,
Set<Principal> members,
long revision)
Constructor
|
Modifier and Type | Method and Description |
---|---|
Set<Principal> |
InvalidGroupMemberException.getInvalidMembers()
Returns the set of members which are invalid additions to the group.
|
Constructor and Description |
---|
InvalidGroupMemberException(Set<Principal> invalidMembers,
String message)
Constructor for GroupIdentifierNotFoundException.
|
Modifier and Type | Method and Description |
---|---|
Set<Principal> |
MembershipService.getAssignedMembers(MembershipContext context) |
Set<Principal> |
Membership.getMembers()
Get the members of this membership.
|
Set<Principal> |
MembershipService.getMembersAvailableForAssignment(MembershipContext context)
Get the set of all principals which can be added to the current membership of the specified context (this list
will not include principals already in the current membership).
|
Set<Principal> |
MembershipService.getPotentialMembers(MembershipContext context)
Get the set of all principals which could be included in the membership of the specified context (including
current members of that membership).
|
Modifier and Type | Method and Description |
---|---|
void |
MembershipService.addMember(MembershipContext context,
Principal member)
Add the specified principal to the membership list of a membership context.
|
Set<MembershipDescriptor> |
MembershipService.getMemberships(Principal member)
Get the set of membership lists where the specified principal is a member.
|
boolean |
MembershipService.isMember(MembershipContext context,
Principal member)
Test to see if a given principal is an explicit member of a specified membership context.
|
void |
MembershipService.removeMember(MembershipContext context,
Principal member)
Remove the specified principal from the membership list of the specified context.
|
Modifier and Type | Method and Description |
---|---|
void |
MembershipService.addMembers(MembershipContext context,
Set<Principal> members)
Add the specified principal to the membership list of a membership context.
|
void |
MembershipService.removeMembers(MembershipContext context,
Set<Principal> members) |
void |
Membership.setMembers(Set<Principal> members)
Set the members of this membership.
|
Constructor and Description |
---|
Membership(ObjectIdentity context,
Principal... members)
Membership constructor given the context it is for and the list of Principals to be in the membership.
|
Constructor and Description |
---|
Membership(ObjectIdentity context,
Set<Principal> members)
Membership constructor given the context it is for and the list of Principals to be in the membership.
|
Modifier and Type | Method and Description |
---|---|
Set<Principal> |
MemberExistsException.getExistingMembers()
Get the set of principals which are already members of this context.
|
Set<Principal> |
InvalidMemberException.getInvalidMembers()
Get the set of invalid principals referenced by this exception.
|
Set<Principal> |
MemberNotFoundException.getNonMembers()
Get the set of principals which are not members of this context.
|
Constructor and Description |
---|
InvalidMemberException(Set<Principal> invalidMembers,
String message)
Constructor taking the set of invalid principals and a detailed message about the exception.
|
MemberExistsException(Set<Principal> existingMembers,
String message)
Constructs a MembershipExistsException with the specified message and list of principals.
|
MemberNotFoundException(Set<Principal> nonMembers,
String message)
Constructs a MemberNotFoundException with the specified message and list of principals.
|
Modifier and Type | Method and Description |
---|---|
Set<Principal> |
PrincipalNotFoundException.getNotFound()
Get the set of principals which could not be found.
|
Constructor and Description |
---|
PrincipalNotFoundException(String message,
Set<Principal> notFound)
Construct a PrincipalNotFoundException with the specified message and list of principals which could not be found
in the system.
|
Modifier and Type | Method and Description |
---|---|
Set<Principal> |
RoleAssignment.getMembers()
Get the membership of this roleAssignment.
|
Modifier and Type | Method and Description |
---|---|
Set<AssignedRole> |
RoleAssignmentService.getAssignedRolesByPrincipal(RoleContext roleContext,
Principal principal)
Get all assignedRoles in a given context which have the specified principal as a member.
|
Set<RoleAssignment> |
RoleAssignmentService.getRoleAssignmentsByRoleContextAndPrincipal(RoleContext roleContext,
Principal member)
Get all the roleAssignments for a context which include the specified principal as a member.
|
boolean |
RoleAssignmentService.hasPrivilegeAtContext(Privilege privilege,
RoleContext roleContext,
Principal member)
Check if the principal has the privilege at the given context.
|
boolean |
RoleAssignmentService.isPrincipalInRole(AssignedRole assignedRole,
Principal principal)
Is the principal a member of the specified role?
|
void |
RoleAssignmentService.removeFromRoleAssignmentsOfRoleContext(RoleContext roleContext,
Principal member)
Remove the specified principal from all roleAssignments in the specified context.
|
Modifier and Type | Method and Description |
---|---|
void |
RoleAssignmentService.removeMembersFromRoleAssignmentsOfRoleContext(RoleContext roleContext,
Set<Principal> members)
Remove the specified principals from all roleAssignments in the specified context.
|
void |
RoleAssignment.setMembers(Set<Principal> members)
Set the membership of this roleAssignment.
|
Constructor and Description |
---|
RoleAssignment(long revision,
AssignedRole assignedRole,
Set<Principal> members)
Constructor when you have a membership list defined.
|
Modifier and Type | Method and Description |
---|---|
Set<Principal> |
InvalidRoleMemberException.getInvalidMembers()
Returns the set of members which are invalid additions to the role assignment.
|
Constructor and Description |
---|
InvalidRoleMemberException(Set<Principal> invalidMembers,
String message)
Constructs an
InvalidRoleMemberException with the invalid members and specified message. |
Modifier and Type | Class and Description |
---|---|
class |
User
A client representation of a user defined in the system.
|
class |
UserDescriptor
Light weight representation of a user defined in the system.
|
Modifier and Type | Method and Description |
---|---|
Principal |
UserTaskAssignment.getAssignee() |
Modifier and Type | Method and Description |
---|---|
Set<Principal> |
UserTaskDefinition.getCandidates()
Gets the candidates for this user task
|
Set<Principal> |
NotificationTask.getRecipients() |
Set<Principal> |
NotificationTaskDefinition.getRecipients()
Sets the recipients for this notification task
|
Modifier and Type | Method and Description |
---|---|
void |
UserTaskDefinition.setCandidates(Set<Principal> candidates)
Sets the candidates for this user task
|
void |
NotificationTaskDefinition.setRecipients(Set<Principal> recipients)
Sets the recipients for this notification task
|
Constructor and Description |
---|
UserTaskAssignment(Date dateStarted,
Date dateAssigned,
Principal assignee,
float actualHours)
Initializing constructor which sets the values of all variables.
|
Constructor and Description |
---|
CompletedNotificationTask(String identifier,
String elementId,
String name,
String description,
Element.ElementType activityType,
ProcessFlowDescriptor.FlowStatus flowStatus,
ProcessFlowDescriptor processFlow,
Date created,
Date started,
Task.TaskStatus taskStatus,
List<Attribute> attributes,
UserDescriptor completedBy,
Date completed,
String completedStatus,
CompletedTask.TaskCompletedState completedState,
Set<Principal> recipients,
String subject,
NotificationTaskDefinition.MessagePriority priority,
String message)
Initializing constructor which sets the values of all variables.
|
NotificationTask(String identifier,
String elementId,
String name,
String description,
Element.ElementType activityType,
ProcessFlowDescriptor.FlowStatus status,
ProcessFlowDescriptor processFlow,
Date created,
Date started,
Task.TaskStatus taskStatus,
List<Attribute> attributes,
Set<Principal> recipients,
String subject,
NotificationTaskDefinition.MessagePriority priority,
String message)
Initializing constructor which sets the values of all variables.
|
Copyright (c) 2017, SAS Institute Inc., Cary, NC, USA