jb.gwt_main_modules.base_widgets.client.js_api

Class PermissionApiPublisher

java.lang.Object

jb.gwt_main_modules.base_widgets.client.js_api.PermissionApiPublisher

public final class PermissionApiPublisher
extends java.lang.Object

APi for dealing with permissions in the system. Possible to get ACL permissions or some system properties set on the system, as well as custom substitution properties.

All methods are located in a sub object at window.MBAPI.permission

(window.MBAPI.permission.getPermission(thePermission) for example)

Constructor Summary

Constructors

Constructor and Description
PermissionApiPublisher()

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<java.lang.String>	getAvailablePermissions() Get all permissions that are set
static java.util.Collection<java.lang.String>	getAvailableSystemProperties() Get all available system properties
static java.lang.String	getPermission(java.lang.String thePermission) Get a permission from the ACL
static java.lang.String	getSystemProperty(java.lang.String theSystemProperty) Get a system property
static boolean	isEnabled(java.lang.String thePermission) True or false based on if a permission is enabled or not
static boolean	isSystemPropertyEnabled(java.lang.String theSystemProperty) Is a system property enabled?
static void	setSubstitutionSearchProperty(com.google.gwt.core.client.JavaScriptObject thePropertyMap, com.google.gwt.core.client.JavaScriptObject theCallback) Sets a search substitution property.
static void	setupAPI() Initialize the permission API namespace object.
static void	setupJavascriptAPIs()

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionApiPublisher

public PermissionApiPublisher()

Method Detail

setupJavascriptAPIs

public static void setupJavascriptAPIs()

setupAPI

public static void setupAPI()

Initialize the permission API namespace object.

setSubstitutionSearchProperty

public static void setSubstitutionSearchProperty(com.google.gwt.core.client.JavaScriptObject thePropertyMap,
                                                 com.google.gwt.core.client.JavaScriptObject theCallback)

Sets a search substitution property. Used with a brand selector widget and a mandatory search to substitute values injected by directory services or a plugin driving from another external source. Only does something in the case the plugin/directory services are setup for brand selector Example login workflow to setup 3 possible brands for substitution: function main() { context.getUser().addAllToSubstitutionMap({"brands":"Get Set,Lumi,Captain's Gin"}); return JSON.stringify(aReplacementMap); } main(); Example javascript call to setup Captain's Gin as the value used to substitute in search when searching for $brands MBAPI.permission.setSubstitutionSearchProperty({'$brands':'Captain's Gin'})

Parameters:

thePropertyMap - map of substitutions to use, formatted like: {"$group":"substituted group name","$username":"new boy"}

theCallback - callback method to inform when we've set the appropriate entries both client and server side

getPermission

public static java.lang.String getPermission(java.lang.String thePermission)

Get a permission from the ACL

Parameters:

thePermission - the permission name

Returns:

value of the permission (string)

isEnabled

public static boolean isEnabled(java.lang.String thePermission)

True or false based on if a permission is enabled or not

Parameters:

thePermission - the string permission

Returns:

true if enabled

getSystemProperty

public static java.lang.String getSystemProperty(java.lang.String theSystemProperty)

Get a system property

Parameters:

theSystemProperty - the system property

isSystemPropertyEnabled

public static boolean isSystemPropertyEnabled(java.lang.String theSystemProperty)

Is a system property enabled?

Parameters:

theSystemProperty -

Returns:

true if sys prop is set (limited subset)

getAvailablePermissions

public static java.util.Collection<java.lang.String> getAvailablePermissions()

Get all permissions that are set

Returns:

array of available permission names

getAvailableSystemProperties

public static java.util.Collection<java.lang.String> getAvailableSystemProperties()

Get all available system properties

Returns:

array of available system properties