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

java.lang.Object
  org.eclipse.stardust.engine.extensions.dms.data.DmsPrincipal

All Implemented Interfaces:

java.io.Serializable, java.security.Principal

public class DmsPrincipal
extends java.lang.Object
implements java.io.Serializable, java.security.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 java.lang.String	IPP_PARTICIPANT
static java.lang.String	IPP_USER
static java.lang.String	IPP_USERGROUP

Constructor Summary

DmsPrincipal(ModelParticipantInfo modelParticipantInfo, java.lang.String modelId)
Created a DmsPrincipal which identifies a ModelParticipant.

DmsPrincipal(java.lang.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, java.lang.String realmId)
Created a DmsPrincipal which identifies a User.

Method Summary

static java.lang.String	getModelParticipantPrincipalName(java.lang.String participantId, java.lang.String departmentId, java.lang.String modelId) Builds a unique principal name for a ModelParticipant.
java.lang.String	getName()
static java.lang.String	getUserGroupPrincipalName(java.lang.String userGroupId) Builds a unique principal name for a UserGroup.
static java.lang.String	getUserPrincipalName(java.lang.String userId, java.lang.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 java.lang.String IPP_USERGROUP

See Also:

Constant Field Values

IPP_USER

public static final java.lang.String IPP_USER

See Also:

Constant Field Values

IPP_PARTICIPANT

public static final java.lang.String IPP_PARTICIPANT

See Also:

Constant Field Values

Constructor Detail

DmsPrincipal

public DmsPrincipal(java.lang.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,
                    java.lang.String modelId)

Created a DmsPrincipal which identifies a ModelParticipant.

Parameters:

modelParticipantInfo -

modelId -

DmsPrincipal

public DmsPrincipal(UserInfo userInfo,
                    java.lang.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

getModelParticipantPrincipalName

public static java.lang.String getModelParticipantPrincipalName(java.lang.String participantId,
                                                                java.lang.String departmentId,
                                                                java.lang.String modelId)

Builds a unique principal name for a ModelParticipant.

Parameters:

participantId -

departmentId -

modelId -

Returns:

The unique name.

getUserPrincipalName

public static java.lang.String getUserPrincipalName(java.lang.String userId,
                                                    java.lang.String realmId)

Builds a unique principal name for a User.

Parameters:

userId -

realmId -

Returns:

The unique name.

getUserGroupPrincipalName

public static java.lang.String getUserGroupPrincipalName(java.lang.String userGroupId)

Builds a unique principal name for a UserGroup.

Parameters:

userGroupId -

Returns:

The unique name.

getName

public java.lang.String getName()

Specified by:

getName in interface java.security.Principal