com.viaoa.context

Class OAContext

java.lang.Object

com.viaoa.context.OAContext

public class OAContext
extends Object

Allows storing objects that are associated with a context

1: OAObject as the login user.
2: OAUserAccess Used by ObjectCallback and other code to work with OAObject permissions.

Author:

vvia

Method Summary

Modifier and Type	Method and Description
static String	getAdminPropertyPath()
static boolean	getAllowEditProcessed() Does the current thread have rights to edit processed objects.
static boolean	getAllowEditProcessed(Object context) Does the context have rights to edit processed objects.
static String	getAllowEditProcessedPropertyPath()
static Hub<? extends OAObject>	getContextHub()
static Hub<? extends OAObject>	getContextHub(Object context)
static OAObject	getContextObject() Returns the object associated with the current thread local (or null) context.
static OAObject	getContextObject(Object context)
static OAUserAccess	getContextUserAccess()
static OAUserAccess	getContextUserAccess(Object context)
static String	getSuperAdminPropertyPath()
static boolean	isAdmin() Does the context have admin rights.
static boolean	isAdmin(Object context)
static boolean	isEnabled(Object context, String pp, boolean bEqualTo)
static boolean	isEnabled(String pp, boolean bEqualTo) Check to see if context (user) property path is equal to bEqualTo.
static boolean	isSuperAdmin() Does the context have super admin rights.
static boolean	isSuperAdmin(Object context)
static void	removeContext()
static void	removeContext(Object context)
static void	removeContextHub()
static void	removeContextHub(Object context)
static void	setAdminPropertyPath(String pp) Property path used to find the user property for allowing users to have admin rights.
static void	setAllowEditProcessedPropertyPath(String pp) Property path used to find the user property for allowing users to edit objects/properties/etc that are annotatied as processed.
static void	setContext(Object context, OAObject obj)
static void	setContextHub(Object context, Hub<? extends OAObject> hub) Allows the value to be associated with a context, to be the ActiveObject in a hub.
static void	setContextObject(Object context, OAObject obj) Associated an object value with a context.
static void	setContextUserAccess(Object context, OAUserAccess ua) Associated an OAUserAccess with a context.
static void	setSuperAdminPropertyPath(String pp) Property path used to find the user property for allowing users to have super admin rights.

Methods inherited from class java.lang.Object

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

Method Detail

setAllowEditProcessedPropertyPath

public static void setAllowEditProcessedPropertyPath(String pp)

Property path used to find the user property for allowing users to edit objects/properties/etc that are annotatied as processed. Defaults to "EditProcessed"

getAllowEditProcessedPropertyPath

public static String getAllowEditProcessedPropertyPath()

getAllowEditProcessed

public static boolean getAllowEditProcessed()

Does the current thread have rights to edit processed objects.

getAllowEditProcessed

public static boolean getAllowEditProcessed(Object context)

Does the context have rights to edit processed objects.

setAdminPropertyPath

public static void setAdminPropertyPath(String pp)

Property path used to find the user property for allowing users to have admin rights. Defaults to "Admin"

getAdminPropertyPath

public static String getAdminPropertyPath()

isAdmin

public static boolean isAdmin()

Does the context have admin rights.

isAdmin

public static boolean isAdmin(Object context)

setSuperAdminPropertyPath

public static void setSuperAdminPropertyPath(String pp)

Property path used to find the user property for allowing users to have super admin rights. If true, then the user will have all ObjectCallback.allowed=true Defaults to "SuperAdmin"

getSuperAdminPropertyPath

public static String getSuperAdminPropertyPath()

isSuperAdmin

public static boolean isSuperAdmin()

Does the context have super admin rights.

isSuperAdmin

public static boolean isSuperAdmin(Object context)

isEnabled

public static boolean isEnabled(String pp,
                                boolean bEqualTo)

Check to see if context (user) property path is equal to bEqualTo.

isEnabled

public static boolean isEnabled(Object context,
                                String pp,
                                boolean bEqualTo)

setContextObject

public static void setContextObject(Object context,
                                    OAObject obj)

Associated an object value with a context.

Parameters:

context - is value used to lookup obj

obj - object that is associated with context.

See Also:

OAThreadLocalDelegate.getContext()

setContext

public static void setContext(Object context,
                              OAObject obj)

getContextObject

public static OAObject getContextObject()

Returns the object associated with the current thread local (or null) context.

getContextObject

public static OAObject getContextObject(Object context)

setContextHub

public static void setContextHub(Object context,
                                 Hub<? extends OAObject> hub)

Allows the value to be associated with a context, to be the ActiveObject in a hub.

removeContextHub

public static void removeContextHub()

removeContextHub

public static void removeContextHub(Object context)

removeContext

public static void removeContext(Object context)

removeContext

public static void removeContext()

getContextHub

public static Hub<? extends OAObject> getContextHub()

getContextHub

public static Hub<? extends OAObject> getContextHub(Object context)

setContextUserAccess

public static void setContextUserAccess(Object context,
                                        OAUserAccess ua)

Associated an OAUserAccess with a context.

See Also:

OAThreadLocalDelegate.getContext()

getContextUserAccess

public static OAUserAccess getContextUserAccess()

getContextUserAccess

public static OAUserAccess getContextUserAccess(Object context)