org.eclipse.stardust.engine.extensions.dms.data
Class DmsPrincipal

java.lang.Object
  extended by org.eclipse.stardust.engine.extensions.dms.data.DmsPrincipal
All Implemented Interfaces:
Serializable, Principal

public class DmsPrincipal
extends Object
implements Serializable, Principal

A DmsPrincipal represents an identifiable IPP entity; either User, UserGroup or ModelParticipant. It is used to identify the IPP entity as a unique Principal when assigning access control policies for documents or folders.

Author:
roland.stamm
See Also:
Serialized Form

Field Summary
static String IPP_PARTICIPANT
           
static String IPP_USER
           
static String IPP_USERGROUP
           
 
Constructor Summary
DmsPrincipal(ModelParticipantInfo modelParticipantInfo, Department department, String modelId)
          Created a DmsPrincipal which identifies a ModelParticipant.
DmsPrincipal(ModelParticipantInfo modelParticipantInfo, org.eclipse.stardust.engine.core.runtime.beans.IDepartment department, String modelId)
          Created a DmsPrincipal which identifies a ModelParticipant.
DmsPrincipal(ModelParticipantInfo modelParticipantInfo, String modelId)
          Created a DmsPrincipal which identifies a ModelParticipant.
DmsPrincipal(String name)
          Deprecated. please use the other constructors which ensure an unique name based on an IPP entity.
DmsPrincipal(UserGroupInfo userGroupInfo)
          Created a DmsPrincipal which identifies a UserGroup.
DmsPrincipal(UserInfo userInfo, String realmId)
          Created a DmsPrincipal which identifies a User.
 
Method Summary
static String getFullDepartmentScopedId(Department department)
           
static String getFullDepartmentScopedId(org.eclipse.stardust.engine.core.runtime.beans.IDepartment department)
           
static String getModelParticipantPrincipalName(String participantId, String departmentId, String modelId)
          Builds a unique principal name for a ModelParticipant.
 String getName()
           
static String getUserGroupPrincipalName(String userGroupId)
          Builds a unique principal name for a UserGroup.
static String getUserPrincipalName(String userId, String realmId)
          Builds a unique principal name for a User.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.security.Principal
equals, hashCode, toString
 

Field Detail

IPP_USERGROUP

public static final String IPP_USERGROUP
See Also:
Constant Field Values

IPP_USER

public static final String IPP_USER
See Also:
Constant Field Values

IPP_PARTICIPANT

public static final String IPP_PARTICIPANT
See Also:
Constant Field Values
Constructor Detail

DmsPrincipal

public DmsPrincipal(String name)
Deprecated. please use the other constructors which ensure an unique name based on an IPP entity.

Parameters:
name - principal name (will not be prefixed)

DmsPrincipal

public DmsPrincipal(ModelParticipantInfo modelParticipantInfo,
                    String modelId)
Created a DmsPrincipal which identifies a ModelParticipant. Use for unscoped participants.

Parameters:
modelParticipantInfo -
modelId -

DmsPrincipal

public DmsPrincipal(ModelParticipantInfo modelParticipantInfo,
                    Department department,
                    String modelId)
Created a DmsPrincipal which identifies a ModelParticipant. Use to scope participant with department.

Parameters:
modelParticipantInfo -
department -
modelId -

DmsPrincipal

public DmsPrincipal(ModelParticipantInfo modelParticipantInfo,
                    org.eclipse.stardust.engine.core.runtime.beans.IDepartment department,
                    String modelId)
Created a DmsPrincipal which identifies a ModelParticipant. Use to scope participant with department.

Parameters:
modelParticipantInfo -
department -
modelId -

DmsPrincipal

public DmsPrincipal(UserInfo userInfo,
                    String realmId)
Created a DmsPrincipal which identifies a User.

Parameters:
userInfo -
realmId -

DmsPrincipal

public DmsPrincipal(UserGroupInfo userGroupInfo)
Created a DmsPrincipal which identifies a UserGroup.

Parameters:
userGroupInfo -
Method Detail

getFullDepartmentScopedId

public static String getFullDepartmentScopedId(Department department)

getFullDepartmentScopedId

public static String getFullDepartmentScopedId(org.eclipse.stardust.engine.core.runtime.beans.IDepartment department)

getModelParticipantPrincipalName

public static String getModelParticipantPrincipalName(String participantId,
                                                      String departmentId,
                                                      String modelId)
Builds a unique principal name for a ModelParticipant.

Parameters:
participantId -
departmentId - departmentId must be fully scoped. e.g. "d2.d1.root"
modelId -
Returns:
The unique name.

getUserPrincipalName

public static String getUserPrincipalName(String userId,
                                          String realmId)
Builds a unique principal name for a User.

Parameters:
userId -
realmId -
Returns:
The unique name.

getUserGroupPrincipalName

public static String getUserGroupPrincipalName(String userGroupId)
Builds a unique principal name for a UserGroup.

Parameters:
userGroupId -
Returns:
The unique name.

getName

public String getName()
Specified by:
getName in interface Principal


Copyright © 2017 Eclipse Stardust. All Rights Reserved.