com.brightech.mb.workflow.js

Class JSApiKeyManager

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.JSApiKeyManager

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class JSApiKeyManager
extends JSBaseScriptableObject

User: Nate Solas Manage API Keys from workflows: create, update, delete Is available in workflow context pre-initialized as "apiKeyManager"

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSApiKeyManager()

Method Summary

Modifier and Type	Method and Description
void	(JavaScript Function) deleteApiKey(java.lang.String theApiKey) Deletes a specific API key
java.lang.String	(JavaScript Function) getKey(java.lang.String theUserName, java.lang.String theName) Gets a key from the apikey table with theName for theUser
java.lang.String[]	(JavaScript Function) getKeysByName(java.lang.String theName) Returns an array of api key that have the given api key name
java.lang.String	(JavaScript Function) getOrCreateApiKey(java.lang.String theName, java.lang.String theUserName) This method gets or creates a permanent API key for the calling user
java.lang.String	(JavaScript Function) getOrCreateExpiringApiKey(java.lang.String theUserName, java.lang.String theExpirationTimeInMs, java.lang.String theKeyName) This method gets or creates an expiring API key for the calling user
java.lang.String	(JavaScript Function) getOrCreateWorkflowApiKey(java.lang.String theWorkflowName, java.lang.String theUserName) This gets or creates an API key that can only be used to run the specified workflow
java.lang.String	(JavaScript Function) setKey(java.lang.String theUserName, java.lang.String theName, java.lang.String theKey) Sets a key in the apikey table for the user with the name

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

JSApiKeyManager

public JSApiKeyManager()

Method Detail

(JavaScript Function) getOrCreateWorkflowApiKey

public java.lang.String (JavaScript Function) getOrCreateWorkflowApiKey(java.lang.String theWorkflowName,
                                                             java.lang.String theUserName)

This gets or creates an API key that can only be used to run the specified workflow

Parameters:

theWorkflowName - The name of the workflow this API key runs

theUserName - Optional username (current user if omitted)

Returns:

an API key

(JavaScript Function) getOrCreateApiKey

public java.lang.String (JavaScript Function) getOrCreateApiKey(java.lang.String theName,
                                                     java.lang.String theUserName)

This method gets or creates a permanent API key for the calling user

Parameters:

theName - optional key name, may be empty

theUserName - Optional username (current user if omitted)

Returns:

an API key

(JavaScript Function) getOrCreateExpiringApiKey

public java.lang.String (JavaScript Function) getOrCreateExpiringApiKey(java.lang.String theUserName,
                                                             java.lang.String theExpirationTimeInMs,
                                                             java.lang.String theKeyName)

This method gets or creates an expiring API key for the calling user

Parameters:

theUserName - (optional) username (current user if omitted)

theExpirationTimeInMs - (optional) time in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC)

theKeyName - (optional) name given given to the apikey. ex. M4sterplan, REST API

Returns:

an API key

(JavaScript Function) deleteApiKey

public void (JavaScript Function) deleteApiKey(java.lang.String theApiKey)

Deletes a specific API key

Parameters:

theApiKey - the key to delete

(JavaScript Function) getKey

public java.lang.String (JavaScript Function) getKey(java.lang.String theUserName,
                                          java.lang.String theName)

Gets a key from the apikey table with theName for theUser

Parameters:

theName - the name of the key

theUserName - the user to get the key for

Returns:

the key or null if a key wasn't found

(JavaScript Function) setKey

public java.lang.String (JavaScript Function) setKey(java.lang.String theUserName,
                                          java.lang.String theName,
                                          java.lang.String theKey)

Sets a key in the apikey table for the user with the name

Parameters:

theName - name of the key

theUserName - the user name

theKey - the apikey value

Returns:

(JavaScript Function) getKeysByName

public java.lang.String[] (JavaScript Function) getKeysByName(java.lang.String theName)

Returns an array of api key that have the given api key name

Parameters:

theName -

Returns: