ptolemy.actor.lib.js

Class JavaScript.PtolemyJavaScript

java.lang.Object

org.mozilla.javascript.ScriptableObject

ptolemy.actor.lib.js.JavaScript.PtolemyJavaScript

All Implemented Interfaces:

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

Enclosing class:

JavaScript

public class JavaScript.PtolemyJavaScript
extends org.mozilla.javascript.ScriptableObject

Container class for built-in methods.

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

Method Summary

Modifier and Type	Method and Description
void	alert(java.lang.String message) Alert the user with a message.
void	clearTimeout(java.lang.Integer handle) Clear the timeout with the specified handle, if it has not already executed.
void	error(java.lang.String message) Throw an IllegalActionException with the specified message.
java.lang.Object	get(org.mozilla.javascript.NativeJavaObject portWrapper, java.lang.Double channel) Get buffered inputs for a given input port.
java.lang.String	getClassName()
java.lang.String	httpRequest(java.lang.String url, java.lang.String method, org.mozilla.javascript.NativeObject properties, java.lang.String body, java.lang.Integer timeout) Make the specified HTTP request.
java.lang.String	localHostAddress() Return the local host IP address as a string.
java.lang.String	openBrowser(java.lang.String url) Open a new tab in the default system browser.
void	print(java.lang.String message) Print a message to standard out.
java.lang.String	readProtectedURL(java.lang.String url, java.lang.String accessToken) Open a URL of web service that is protected by OAuth 2.0.
java.lang.String	readURL(java.lang.String url) Read the specified URL and return its contents.
java.lang.String	requestAccess(java.lang.String providerName, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUrl, java.lang.String authCode) Uses an Authorization code to retrieve an Access code.
java.lang.String	requestAuth(java.lang.String providerName, java.lang.String clientId, java.lang.String redirectUrl, java.lang.Boolean openBrowser) Request an OAuth 2.0 authorization token.
void	send(java.lang.Object data, org.mozilla.javascript.NativeJavaObject portWrapper, java.lang.Double channel) Send outputs via an output port.
java.lang.Integer	setTimeout(org.mozilla.javascript.Function function, java.lang.Integer time) After the specified amount of time (in milliseconds), invoke the specified function.
void	socketX(java.lang.String url, org.mozilla.javascript.NativeObject query, org.mozilla.javascript.NativeJavaObject portWrapper) Deprecated. Pending a better design.
java.lang.Object	valueOf(org.mozilla.javascript.NativeJavaObject paramWrapper) Get parameter values.

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, equivalentValues, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

PtolemyJavaScript

public PtolemyJavaScript()

Method Detail

alert

public void alert(java.lang.String message)

Alert the user with a message.

Parameters:

message - The message

clearTimeout

public void clearTimeout(java.lang.Integer handle)

Clear the timeout with the specified handle, if it has not already executed.

Parameters:

handle - The timeout handle.

See Also:

setTimeout(Function, Integer)

error

public void error(java.lang.String message)
           throws IllegalActionException

Throw an IllegalActionException with the specified message.

Parameters:

message - The specified message.

Throws:

IllegalActionException - Always thrown.

get

public java.lang.Object get(org.mozilla.javascript.NativeJavaObject portWrapper,
                            java.lang.Double channel)

Get buffered inputs for a given input port.

Parameters:

portWrapper - A JavaScript wrapper for a Port.

channel - A channel number, or NaN to use the default (0).

Returns:

The buffered inputs.

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Specified by:

getClassName in class org.mozilla.javascript.ScriptableObject

httpRequest

public java.lang.String httpRequest(java.lang.String url,
                                    java.lang.String method,
                                    org.mozilla.javascript.NativeObject properties,
                                    java.lang.String body,
                                    java.lang.Integer timeout)
                             throws java.io.IOException

Make the specified HTTP request. For example, to perform the equivalent of readURL, you can do:

    httpRequest("http://ptolemy.org", "GET", null, "", 1000);
  

which specifies a URL to read, the method for the read, no properties, no text to send, and a timeout of one second.

Parameters:

url - The URL to which to make the request.

method - One of OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, or CONNECT.

properties - The HTTP property to set for the connection, or null to not give any. For example: ['Content-Type':'application/x-www-form-urlencoded']

body - The body of the request, or null if none.

timeout - The timeout for a connection or a read, in milliseconds, or 0 to have no timeout.

Returns:

The response to the request.

Throws:

java.io.IOException - If the request fails.

localHostAddress

public java.lang.String localHostAddress()
                                  throws java.net.UnknownHostException,
                                         java.lang.SecurityException

Return the local host IP address as a string.

Returns:

A string representation of the local host address.

Throws:

java.net.UnknownHostException - If the local host is not known.

java.lang.SecurityException - If this actor is in restricted mode.

socketX

@Deprecated
public void socketX(java.lang.String url,
                                org.mozilla.javascript.NativeObject query,
                                org.mozilla.javascript.NativeJavaObject portWrapper)
                         throws java.net.MalformedURLException

Deprecated. Pending a better design.

Open a WebSocket connection. This method uses Enno Boland's Java implementation of a Socket.IO client, found at https://github.com/Gottox/socket.io-java-client.

NOTE: This is a temporary placeholder method! This will go away. Please do not use it.

Parameters:

url - The URL of the WebSocket connection

query - The query

portWrapper - The port wrapper

Throws:

java.net.MalformedURLException - If the URL is malformed.

print

public void print(java.lang.String message)

Print a message to standard out.

Parameters:

message - The message to be printed

readURL

public java.lang.String readURL(java.lang.String url)
                         throws java.io.IOException

Read the specified URL and return its contents.

Parameters:

url - The URL to read.

Returns:

The content of the URL.

Throws:

java.io.IOException - If the specified URL can't be read (that is, a response code was received that is not in the range 100 to 399.

send

public void send(java.lang.Object data,
                 org.mozilla.javascript.NativeJavaObject portWrapper,
                 java.lang.Double channel)

Send outputs via an output port. If this is called outside the invocation of a fire() method, then this method records the outputs to be produced and calls fireAtCurrentTime() on the director.

Parameters:

data - The data to send via the port.

portWrapper - A JavaScript wrapper for a Port.

channel - A channel number, or NaN to use the default (0).

setTimeout

public java.lang.Integer setTimeout(org.mozilla.javascript.Function function,
                                    java.lang.Integer time)
                             throws IllegalActionException

After the specified amount of time (in milliseconds), invoke the specified function. The function is invoked during a firing of this JavaScript actor, so the function can read inputs, produce outputs, and do anything else that might be done in the JavaScript fire() method. The specified function will be invoked after the fire() JavaScript method, if one is defined in the script, and also after any input handlers created by setInputHandler().

If the model stops executing before the timeout period elapses, then the specified function will not be invoked.

Parameters:

function - The function to invoke.

time - The time in milliseconds.

Returns:

A handle to the delayed function, to be used by clearTimeout() to cancel the function invocation if it hasn't occurred yet.

Throws:

IllegalActionException - If the director cannot respect the time request.

valueOf

public java.lang.Object valueOf(org.mozilla.javascript.NativeJavaObject paramWrapper)

Get parameter values.

Parameters:

paramWrapper - A JavaScript wrapper for a Variable.

Returns:

A wrapped token that contains the parameter.

requestAuth

public java.lang.String requestAuth(java.lang.String providerName,
                                    java.lang.String clientId,
                                    java.lang.String redirectUrl,
                                    java.lang.Boolean openBrowser)
                             throws IllegalActionException

Request an OAuth 2.0 authorization token. This method requires interaction with an Authorization server which is usually implemented as a web service.

Parameters:

providerName - References an internally stored end point URL for popular OAuth providers like Google, Twitter, Facebook, etc.

clientId - This identifies the application that accesses a resource. Usually, client ids are issued after registering an application via a developer console at a resource provider.

redirectUrl - After completion of the authorization request this URL is used to redirect the browser.

openBrowser - Indicates, if the method should invoke the system's default browser to enable the user to login to the server in order to grant access, or if the script handles this on its own.

Returns:

returns The authorization code, if the authentication at the Authorization Server was successful.

Throws:

IllegalActionException

requestAccess

public java.lang.String requestAccess(java.lang.String providerName,
                                      java.lang.String clientId,
                                      java.lang.String clientSecret,
                                      java.lang.String redirectUrl,
                                      java.lang.String authCode)
                               throws IllegalActionException

Uses an Authorization code to retrieve an Access code.

Parameters:

providerName - The name of the provider, for example "google".

clientId - The clientID.

clientSecret - The client password

redirectUrl - The URL to which to redirect.

authCode - The authorization code issued by the Authorization server.

Returns:

The Access code token. This can be used to access the Resource server.

Throws:

IllegalActionException

readProtectedURL

public java.lang.String readProtectedURL(java.lang.String url,
                                         java.lang.String accessToken)
                                  throws IllegalActionException

Open a URL of web service that is protected by OAuth 2.0.

Parameters:

url - The protected URL on a Resource server. Usually this is some kind of RESTful API.

accessToken - The code used to prove access authorization to the Resource server.

Returns:

The OAuth Client resource response.

Throws:

IllegalActionException

openBrowser

public java.lang.String openBrowser(java.lang.String url)
                             throws IllegalActionException

Open a new tab in the default system browser. See also http://www.mkyong.com/java/open-browser-in-java-windows-or-linux/>.

Parameters:

url - The URL that the browser shall retrieve.

Returns:

The empty string.

Throws:

IllegalActionException - If the browser is not found