Package com.appiancorp.services

Class UserServiceContext

java.lang.Object

com.appiancorp.services.AbstractServiceContext

com.appiancorp.services.UserServiceContext

All Implemented Interfaces:

com.appiancorp.asl3.servicefw.connect.ServiceContext, com.appiancorp.security.auth.SecurityContext, com.appiancorp.services.AuthorizationInterceptorProvider, KougarServiceContext, ServiceContext, Principal

Direct Known Subclasses:

EscalatedServiceContext

public class UserServiceContext
extends AbstractServiceContext

UserServiceContext can be used to request services explicitly in standalone applications. Since the Appian Suite API methods are executed "subjectively" (i.e. the user who is executing the call is significant), a UserServiceContext must be created for the user who is the subject of the methods that will be invoked on the obtained service. In Web-based Appian applications, the appropriate context is provided automatically.

See Also:

• ServiceContextFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserServiceContext(ServiceContext sc, String grantorUsername)
protected	UserServiceContext(String username, String grantorUsername)

Method Summary

Modifier and Type	Method	Description
com.appiancorp.asl3.servicefw.connect.ASLIdentity	getIdentity()	Gets the Identity object that was used to initialize the UserServiceContext.
boolean	isDesignatedForMigration()	Whether this service context has been designated for migration of objects in the system.

Methods inherited from class com.appiancorp.services.AbstractServiceContext

addService, getAppianLoginContext, getAppianSession, getAttribute, getAuthorizationInterceptor, getAuthorizationProvider, getCalendarID, getEngineCredentials, getGrantorName, getGrantorRoles, getLocale, getMemberGroupRefs, getMemberGroupUuids, getName, getOverrideLocale, getRoles, getService, getTimeZone, getUserRef, getUserUuid, isAdsSuperUser, isAllowOverrideForDisabledLocale, isAuthenticatedByAppianInternalProvider, isLoggedInThroughSaml, isRtl, isSysAdmin, isUserRefNull, removeAttribute, removeService, setAttribute, setAuthorizationProvider, setCalendarID, setLocale, setTimeZone, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

equals, hashCode, implies

Constructor Details

UserServiceContext

protected UserServiceContext(String username,
 String grantorUsername)

UserServiceContext

protected UserServiceContext(ServiceContext sc,
 String grantorUsername)

Method Details

getIdentity

public com.appiancorp.asl3.servicefw.connect.ASLIdentity getIdentity()

Gets the Identity object that was used to initialize the UserServiceContext.

Returns:

the ASLIdentity

isDesignatedForMigration

public boolean isDesignatedForMigration()

Description copied from interface: ServiceContext

Whether this service context has been designated for migration of objects in the system.

Returns:

whether the service context is designated for migration