com.brightech.mb.workflow.js

Class JSExternalSharingManager

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.JSExternalSharingManager

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 JSExternalSharingManager
extends JSBaseScriptableObject

Manager responsible for creating links to assets which are accessible outside of a valid MediaBeacon session. Possible to get a direct link, or a link to a page where the user is presented with configurable text and a button to agree to licensing terms

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
JSExternalSharingManager()

Method Summary

Modifier and Type	Method and Description
java.lang.String	(JavaScript Function) createExternalShare(java.lang.String theResolverString, java.lang.String theExpirationDate, java.lang.String theShareInformation, java.lang.String theBody, int theDownloadCount) Create an entry for sharing some selection external of having an account in MediaBeacon
java.lang.String	(JavaScript Function) getDirectDownloadLink(java.lang.String theResolverString, java.lang.String theExpirationDate, java.lang.String theShareInformation, java.lang.String theBody, int theDownloadCount) Return link for the external download.
java.lang.String	(JavaScript Function) getLicensingPageLink(java.lang.String theResolverString, java.lang.String theExpirationDate, java.lang.String theShareInformation, java.lang.String theBody, int theDownloadCount) Return the content relative path for showing the licensing page which leads to the external download.
void	(JavaScript Function) removeExternalShare(java.lang.String theKey) Remove sharing entries for the passed key

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

JSExternalSharingManager

public JSExternalSharingManager()

Method Detail

(JavaScript Function) createExternalShare

public java.lang.String (JavaScript Function) createExternalShare(java.lang.String theResolverString,
                                                       java.lang.String theExpirationDate,
                                                       java.lang.String theShareInformation,
                                                       java.lang.String theBody,
                                                       int theDownloadCount)

Create an entry for sharing some selection external of having an account in MediaBeacon

Parameters:

theResolverString - resolver url used to define the grouping of assets. ex. asset://200364668, directory://32459

theExpirationDate - expiration date (time since epoch) ex. 1469171189281

theShareInformation - any extraneous information to be associated with the generated link

theBody - the content to display in the licensing dialogs body

theDownloadCount - total download count allowed. -1 is unlimited

Returns:

key used to download the asset

(JavaScript Function) getLicensingPageLink

public java.lang.String (JavaScript Function) getLicensingPageLink(java.lang.String theResolverString,
                                                        java.lang.String theExpirationDate,
                                                        java.lang.String theShareInformation,
                                                        java.lang.String theBody,
                                                        int theDownloadCount)

Return the content relative path for showing the licensing page which leads to the external download. Workflow is responsible for pre-pending the url/port of the MediaBeacon server (or proxy) the user will access through

Parameters:

theResolverString - resolver url used to define the grouping of assets. ex. asset://200364668, directory://32459

theExpirationDate - expiration date (time since epoch) ex. 1469171189281

theShareInformation - any extraneous information to be associated with the generated link

theBody - the content to display in the licensing dialogs body

theDownloadCount - total download count allowed. -1 is unlimited

Returns:

content relative path to the licensing page, available w/o valid MB session

(JavaScript Function) getDirectDownloadLink

public java.lang.String (JavaScript Function) getDirectDownloadLink(java.lang.String theResolverString,
                                                         java.lang.String theExpirationDate,
                                                         java.lang.String theShareInformation,
                                                         java.lang.String theBody,
                                                         int theDownloadCount)

Return link for the external download. Workflow is responsible for pre-pending the url/port of the MediaBeacon server (or proxy) the user will access through

Parameters:

theResolverString - resolver url used to define the grouping of assets. ex. asset://200364668, directory://32459

theExpirationDate - expiration date (time since epoch) ex. 1469171189281

theShareInformation - any extraneous information to be associated with the generated link

theBody - the content to display in the licensing dialogs body

theDownloadCount - total download count allowed. -1 is unlimited

Returns:

link to download (directly) the referenced content

(JavaScript Function) removeExternalShare

public void (JavaScript Function) removeExternalShare(java.lang.String theKey)

Remove sharing entries for the passed key

Parameters:

theKey - key for the download