DelegatingUserPrincipal (Cyclos 4.16.19 Scripting API Documentation)

All Superinterfaces:

UserPrincipal

All Known Subinterfaces:

DelegatingMutableUserPrincipal, SessionData

All Known Implementing Classes:

AbstractSessionData, AccessClientSessionData, CustomWizardExecution, DirectUserSessionData, ExternalRedirectExecution, GuestSessionData, LocateUserResult, OidcAuthorization, OidcSessionData, Pin, ScriptSessionData, Session, StatefulUserSessionData, StatelessUserSessionData, SystemSessionData, UserIdentityProvider, UserSessionData
```
public interface DelegatingUserPrincipal
extends UserPrincipal
```
A DelegatingUserPrincipal behaves like a UserPrincipal, but is neither represented by a PrincipalType nor have a specific getXxx in the UserPrincipal interface. Also, a DelegatingUserPrincipal doesn't have a principal value by itself, but delegates it as well.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default UserPrincipal`	`getDelegate()`	Returns a delegate user principal.
`default String`	`getPrincipal()`	Should return a value that can be used to identify the user.

Methods inherited from interface org.cyclos.entities.users.UserPrincipal
getAccessClient, getAccountType, getBasicUser, getCustomFieldValue, getMobilePhone, getPrincipalType, getToken, getTrustedDevice

- Method Detail
  - getDelegate
```
default UserPrincipal getDelegate()
```
    Returns a delegate user principal. Implementations that are "pure" principals (there's a principal type representing it) will return themselves. Other implementations, such as session, PIN, etc, will return a delegate according to the principal type.
  - getPrincipal
```
default String getPrincipal()
```
    Description copied from interface: UserPrincipal
    
    Should return a value that can be used to identify the user. In case the value should be hidden, implementors should return null.
    
    Specified by:
    
    getPrincipal in interface UserPrincipal