org.eclipse.stardust.engine.core.spi.security
Class ExternalUserConfiguration

java.lang.Object
  org.eclipse.stardust.engine.core.spi.security.ExternalUserConfiguration

public abstract class ExternalUserConfiguration
extends java.lang.Object

Nested Class Summary

static class

ExternalUserConfiguration.GrantInfo

Constructor Summary

ExternalUserConfiguration()

Method Summary

abstract java.lang.String	getDescription() Gets the description of the external user.
abstract java.lang.String	getEMail() Gets the email address of the external user.
abstract java.lang.String	getFirstName() Gets the first name of the external user.
java.util.Collection	getGrantedModelParticipants() Deprecated. use getModelParticipantsGrants() instead which is able to cope with scoped grants
abstract java.lang.String	getLastName() Gets the last name of the external user.
java.util.Set<ExternalUserConfiguration.GrantInfo>	getModelParticipantsGrants() Gets the set of participants the external user has grants for.
abstract java.util.Map	getProperties() Gets custom properties of the external user.
java.util.Collection	getUserGroupMemberships() Gets the list of user groups the external user is member of.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalUserConfiguration

public ExternalUserConfiguration()

Method Detail

getFirstName

public abstract java.lang.String getFirstName()

Gets the first name of the external user.

Returns:

The first name.

getLastName

public abstract java.lang.String getLastName()

Gets the last name of the external user.

Returns:

The last name.

getEMail

public abstract java.lang.String getEMail()

Gets the email address of the external user.

Returns:

The email address.

getDescription

public abstract java.lang.String getDescription()

Gets the description of the external user.

Returns:

The description.

getProperties

public abstract java.util.Map getProperties()

Gets custom properties of the external user.

Returns:

The set of property (name, value) pairs.

getGrantedModelParticipants

@Deprecated
public java.util.Collection getGrantedModelParticipants()

Deprecated. use getModelParticipantsGrants() instead which is able to cope with scoped grants

Gets the list of participants the external user has grants for.

Returns:

A collection with IDs of the granted model participants.

getUserGroupMemberships

public java.util.Collection getUserGroupMemberships()

Gets the list of user groups the external user is member of.

The default implementation returns an empty list.

Returns:

A collection with IDs of the user groups the user is member of.

getModelParticipantsGrants

public java.util.Set<ExternalUserConfiguration.GrantInfo> getModelParticipantsGrants()

Gets the set of participants the external user has grants for.

Returns:

A set with IDs of the granted model participants.