com.appiancorp.services

Class AbstractServiceContext

java.lang.Object

com.appiancorp.services.AbstractServiceContext

All Implemented Interfaces:

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

Direct Known Subclasses:

UserServiceContext, WebServiceContext

public abstract class AbstractServiceContext
extends java.lang.Object
implements KougarServiceContext, com.appiancorp.security.auth.SecurityContext, com.appiancorp.services.AuthorizationInterceptorProvider

Represents a service context for use with the service framework. This class defines the common methods that all service contexts would otherwise have to implement, but that don't vary much from service context to service context.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractServiceContext()
protected	AbstractServiceContext(ServiceContext sc, java.lang.String grantorUsername)
protected	AbstractServiceContext(java.lang.String username, java.lang.String grantorUsername)

Method Summary

Modifier and Type	Method and Description
void	addService(java.lang.String serviceName, java.lang.Object service) Adds the specified Service to the service cache under the serviceName_ key specified.
com.appiancorp.security.auth.AppianLoginContext	getAppianLoginContext()
com.appiancorp.core.expr.portable.common.Session	getAppianSession()
java.lang.Object	getAttribute(java.lang.String key) Gets the attribute at the specified key.
org.aopalliance.intercept.MethodInterceptor	getAuthorizationInterceptor(java.lang.String actionTargetName, java.lang.Class<?> targetInterface)
com.appiancorp.security.authz.AuthorizationProvider	getAuthorizationProvider()
java.lang.String	getCalendarID() Gets the calendar ID, which is used to calculate date in that calendar.
com.appian.komodo.api.EngineCredentials	getEngineCredentials(com.appiancorp.kougar.services.ServiceConnection svcConn) Returns the credentials to be used for calls with the specified KougarConnection.
java.lang.String	getGrantorName()
java.util.Set<java.lang.String>	getGrantorRoles()
java.util.Locale	getLocale() Gets the locale, which affects which language the database will return for multilingual strings.
java.util.Set<com.appiancorp.type.refs.GroupRef>	getMemberGroupRefs()
java.util.Set<java.lang.String>	getMemberGroupUuids()
java.lang.String	getName() Returns the username of the user represented by this context.
java.util.Locale	getOverrideLocale() Necessary since this class implements SecurityContext.
java.util.Set<java.lang.String>	getRoles()
java.lang.Object	getService(java.lang.String serviceName) Retrieves Service specified by the given service name from cache.
java.util.TimeZone	getTimeZone() Gets the timezone, which the database uses for time conversions to and from GMT.
com.appiancorp.type.refs.UserRef	getUserRef()
java.lang.String	getUserUuid()
boolean	isAdsSuperUser()
boolean	isAuthenticatedByAppianInternalProvider()
boolean	isLoggedInThroughSaml()
boolean	isRtl()
boolean	isSysAdmin()
boolean	isUserRefNull()
java.lang.Object	removeAttribute(java.lang.String key) Removes the attribute at the specified key from the attribute map.
void	removeService(java.lang.String serviceName) Removes the specified service from the service cache.
void	setAttribute(java.lang.String key, java.lang.Object o) Sets the attribute at the specified key to the specified value.
void	setAuthorizationProvider(com.appiancorp.security.authz.AuthorizationProvider authzProvider)
void	setCalendarID(java.lang.String calendarID) Sets the ID of the calendar, which is used to calculate date in that calendar.
void	setLocale(java.util.Locale locale) Sets the locale, which affects which language the database will return for multilingual strings.
void	setTimeZone(java.util.TimeZone timeZone) Sets the timezone, which the database uses for time conversions to and from GMT.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.appiancorp.services.ServiceContext

getIdentity, isDesignatedForMigration

Methods inherited from interface java.security.Principal

equals, hashCode, implies

Constructor Detail

AbstractServiceContext

protected AbstractServiceContext()

AbstractServiceContext

protected AbstractServiceContext(java.lang.String username,
                                 java.lang.String grantorUsername)

AbstractServiceContext

protected AbstractServiceContext(ServiceContext sc,
                                 java.lang.String grantorUsername)

Method Detail

getAuthorizationProvider

public com.appiancorp.security.authz.AuthorizationProvider getAuthorizationProvider()

setAuthorizationProvider

public void setAuthorizationProvider(com.appiancorp.security.authz.AuthorizationProvider authzProvider)

getAuthorizationInterceptor

public org.aopalliance.intercept.MethodInterceptor getAuthorizationInterceptor(java.lang.String actionTargetName,
                                                                               java.lang.Class<?> targetInterface)

Specified by:

getAuthorizationInterceptor in interface com.appiancorp.services.AuthorizationInterceptorProvider

getName

public java.lang.String getName()

Description copied from interface: ServiceContext

Returns the username of the user represented by this context.

Specified by:

getName in interface java.security.Principal

Returns:

the username for this context

getUserRef

public com.appiancorp.type.refs.UserRef getUserRef()

Specified by:

getUserRef in interface com.appiancorp.security.auth.SecurityContext

isUserRefNull

public boolean isUserRefNull()

Specified by:

isUserRefNull in interface com.appiancorp.security.auth.SecurityContext

getUserUuid

public java.lang.String getUserUuid()

Specified by:

getUserUuid in interface com.appiancorp.security.auth.SecurityContext

getMemberGroupUuids

public java.util.Set<java.lang.String> getMemberGroupUuids()

Specified by:

getMemberGroupUuids in interface com.appiancorp.security.auth.SecurityContext

getMemberGroupRefs

public java.util.Set<com.appiancorp.type.refs.GroupRef> getMemberGroupRefs()

Specified by:

getMemberGroupRefs in interface com.appiancorp.security.auth.SecurityContext

getRoles

public java.util.Set<java.lang.String> getRoles()

Specified by:

getRoles in interface com.appiancorp.security.auth.SecurityContext

isAuthenticatedByAppianInternalProvider

public boolean isAuthenticatedByAppianInternalProvider()

Specified by:

isAuthenticatedByAppianInternalProvider in interface com.appiancorp.security.auth.SecurityContext

isLoggedInThroughSaml

public boolean isLoggedInThroughSaml()

Specified by:

isLoggedInThroughSaml in interface com.appiancorp.security.auth.SecurityContext

getAppianLoginContext

public com.appiancorp.security.auth.AppianLoginContext getAppianLoginContext()

Specified by:

getAppianLoginContext in interface com.appiancorp.security.auth.SecurityContext

isSysAdmin

public boolean isSysAdmin()

Specified by:

isSysAdmin in interface com.appiancorp.security.auth.SecurityContext

getGrantorName

public java.lang.String getGrantorName()

Specified by:

getGrantorName in interface com.appiancorp.security.auth.SecurityContext

getGrantorRoles

public java.util.Set<java.lang.String> getGrantorRoles()

Specified by:

getGrantorRoles in interface com.appiancorp.security.auth.SecurityContext

addService

public void addService(java.lang.String serviceName,
                       java.lang.Object service)

Description copied from interface: ServiceContext

Adds the specified Service to the service cache under the serviceName_ key specified. If the key already exists, then it is overwritten with the new value.

Specified by:

addService in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Parameters:

serviceName - the name of the service

service - the service

See Also:

ServiceContext.getService(String), ServiceContext.removeService(String)

getService

public java.lang.Object getService(java.lang.String serviceName)

Description copied from interface: ServiceContext

Retrieves Service specified by the given service name from cache.

Specified by:

getService in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Parameters:

serviceName - the service name

Returns:

the service

See Also:

ServiceContext.addService(String, Object), ServiceContext.removeService(String)

removeService

public void removeService(java.lang.String serviceName)

Description copied from interface: ServiceContext

Removes the specified service from the service cache.

Specified by:

removeService in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Parameters:

serviceName - the name of the service

See Also:

ServiceContext.getService(String), ServiceContext.addService(String, Object)

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object o)

Description copied from interface: ServiceContext

Sets the attribute at the specified key to the specified value.

Specified by:

setAttribute in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Parameters:

key - the key

o - the value

See Also:

ServiceContext.getAttribute(String)

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Description copied from interface: ServiceContext

Gets the attribute at the specified key.

Specified by:

getAttribute in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Parameters:

key - the key

Returns:

the attribute value

See Also:

ServiceContext.setAttribute(String, Object)

removeAttribute

public java.lang.Object removeAttribute(java.lang.String key)

Description copied from interface: ServiceContext

Removes the attribute at the specified key from the attribute map.

Specified by:

removeAttribute in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Parameters:

key - the key

Returns:

the attribute value before it was removed

See Also:

ServiceContext.setAttribute(String, Object), ServiceContext.getAttribute(String)

getLocale

public java.util.Locale getLocale()

Description copied from interface: ServiceContext

Gets the locale, which affects which language the database will return for multilingual strings.

Specified by:

getLocale in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Returns:

the locale

See Also:

ServiceContext.setLocale(Locale)

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: ServiceContext

Sets the locale, which affects which language the database will return for multilingual strings.

Specified by:

setLocale in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Parameters:

locale - the locale

See Also:

ServiceContext.getLocale()

isRtl

public boolean isRtl()

getOverrideLocale

public java.util.Locale getOverrideLocale()

Necessary since this class implements SecurityContext. In this case, since this is derived from the original SecurityContext, just return the same locale as getLocale()

Specified by:

getOverrideLocale in interface com.appiancorp.security.auth.SecurityContext

Returns:

the locale already stored in this class derived from the original SecurityContext

isAdsSuperUser

public boolean isAdsSuperUser()

Specified by:

isAdsSuperUser in interface com.appiancorp.security.auth.SecurityContext

getTimeZone

public java.util.TimeZone getTimeZone()

Description copied from interface: ServiceContext

Gets the timezone, which the database uses for time conversions to and from GMT.

Specified by:

getTimeZone in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Returns:

the timezone

See Also:

ServiceContext.setTimeZone(TimeZone)

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

Description copied from interface: ServiceContext

Sets the timezone, which the database uses for time conversions to and from GMT.

Specified by:

setTimeZone in interface com.appiancorp.asl3.servicefw.connect.ServiceContext

Parameters:

timeZone - the timezone

See Also:

ServiceContext.getTimeZone()

getCalendarID

public java.lang.String getCalendarID()

Description copied from interface: ServiceContext

Gets the calendar ID, which is used to calculate date in that calendar.

Returns:

the Calendar ID

See Also:

#setCalendar(String)

setCalendarID

public void setCalendarID(java.lang.String calendarID)

Description copied from interface: ServiceContext

Sets the ID of the calendar, which is used to calculate date in that calendar.

See Also:

#getCalendar()

getEngineCredentials

public com.appian.komodo.api.EngineCredentials getEngineCredentials(com.appiancorp.kougar.services.ServiceConnection svcConn)

Returns the credentials to be used for calls with the specified KougarConnection. The connection may be configured to pass full credentials, or not.

Specified by:

getEngineCredentials in interface KougarServiceContext

Parameters:

svcConn - the connection for which we need the credentials

Returns:

an Object representing the credentials.

getAppianSession

public com.appiancorp.core.expr.portable.common.Session getAppianSession()

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object