1.07
anywheresoftware.b4j.object.WebSocketModule
process
anywheresoftware.b4j.object.WebSocketModule.Adapter.ThreadHandler
process
run
void
anywheresoftware.b4j.object.WebSocket
WebSocket
process
RunFunction
Runs a JavaScript function. Pass null to Args if it is not needed.
void
Function
java.lang.String
Args
anywheresoftware.b4a.objects.collections.List
GetElementById
Creates a JQueryElement object mapped to the given id.
This is equivalent to GetElementBySelector("#" & id.ToLowerCase).
anywheresoftware.b4j.object.WebSocket.JQueryElement
Id
java.lang.String
Flush
Flushes the output stream. Flush is called automatically when client events complete.
You need to explicitly call it at the end of server events.
void
Alert
Calls JavaScript Alert method (shows a dialog).
void
Message
java.lang.String
Close
Closes the WebSocket connection.
void
GetElementBySelector
Creates a JQueryElement object mapped to the given selector.
anywheresoftware.b4j.object.WebSocket.JQueryElement
Selector
java.lang.String
RunFunctionWithResult
Similar to RunFunction. Returns the result of the function.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
Function
java.lang.String
Args
anywheresoftware.b4a.objects.collections.List
Eval
Creates a new JavaScript function with the Script parameter as the body and runs it. Args is an optional list of arguments to pass to this function.
void
Script
java.lang.String
Args
anywheresoftware.b4a.objects.collections.List
EvalWithResult
Similar to Eval. Returns the result of this function. Make sure to return a value from the script.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
Script
java.lang.String
Args
anywheresoftware.b4a.objects.collections.List
UpgradeRequest
anywheresoftware.b4j.object.JServlet.ServletRequestWrapper
Gets the upgrade request object. This is the request that started the WebSocket connection.
Secure
boolean
Returns true if the request was made with a secure channel (SSL).
Open
boolean
Returns true if the connection is open.
Session
anywheresoftware.b4j.object.HttpSessionWrapper
Returns the http session object which is tied to the current user.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
Future
Holds a reference to a value. The value may not be currently available.
In that case the thread will wait for it to be available when you call Value.
process
Value
java.lang.Object
If the value is already available then it is immediately returned. Otherwise the thread will wait for it to be available.
anywheresoftware.b4j.object.WebSocket.JQueryElement
JQueryElement
process
Change (Params As Map)
Click (Params As Map)
DblClick (Params As Map)
Focus (Params As Map)
FocusIn (Params As Map)
FocusOut (Params As Map)
KeyUp (Params As Map)
MouseDown (Params As Map)
MouseEnter (Params As Map)
MouseLeave (Params As Map)
MouseMove (Params As Map)
MouseUp (Params As Map)
SetWidth
Calls jQuery width method with the given value.
void
Value
java.lang.String
GetCSS
Returns the result of jQuery CSS method.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
Property
java.lang.String
RunMethod
Runs the given jQuery method.
Params - List or array of values to pass to the method. Set to Null if not needed.
void
Method
java.lang.String
Params
anywheresoftware.b4a.objects.collections.List
RunMethodWithResult
Similar to RunMethod. The result of the method is returned as a Future object.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
Method
java.lang.String
params
anywheresoftware.b4a.objects.collections.List
SetProp
Calls jQuery prop method with the given value.
void
Property
java.lang.String
Value
java.lang.Object
GetProp
Returns the result of jQuery prop method.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
Property
java.lang.String
GetVal
Returns the result of jQuery val method.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
SetText
Calls jQuery text method with the given value.
void
Value
java.lang.String
GetWidth
Returns the result of jQuery width method.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
SetCSS
Calls jQuery css method with the given property and value.
void
Property
java.lang.String
Value
java.lang.String
SetHtml
void
Value
java.lang.String
SetVal
Calls jQuery val method with the given value.
void
Value
java.lang.Object
GetHtml
Returns the result of jQuery html method.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
GetHeight
Returns the result of jQuery height method.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
GetText
Returns the result of jQuery text method.
anywheresoftware.b4j.object.WebSocket.SimpleFuture
SetHeight
Calls jQuery height method with the given value.
void
Value
java.lang.String
Id
java.lang.String
anywheresoftware.b4j.object.ServerWrapper
Server
process
AddHandler
Maps a handler class.
Path - The handler will be mapped to the following path. You can use wildcards in the path.
Class - The class name (string).
SingleThreadHandler - Whether this handler should always run in the main thread.
void
Path
java.lang.String
Class
java.lang.String
SingleThreadHandler
boolean
SetCustomErrorPages
This method allows you to set custom error pages.
The PagesMap maps between status codes (such as 404 and 500) and the handlers or pages that will be called for each error.
This method should be called before the server is started.
Example:<code>
Dim err As Map
err.Initialize
err.Put(404, "/404.html") 'map to a custom page
srvr.SetCustomErrorPages(err)</code>
void
PagesMap
anywheresoftware.b4a.objects.collections.Map
CreateThreadSafeMap
Returns an initialized Map that can safely be accessed by multiple threads (based on Java ConcurrentHashMap).
Unlike the standard Map the order of items is not preserved.
Note that this Map does not support the following methods: GetKeyAt and GetValueAt.
anywheresoftware.b4a.objects.collections.Map
Start
Starts the server. The handlers and the configuration settings should be set before the server is started.
void
AddBackgroundWorker
Adds a background worker. An instance of the specified class will be created and initialized from a background thread.
Class - The class name. The class should be a standard class (not server handler).
You can call StartMessageLoop in the Initialize sub to keep the class instance running for as long as needed.
Note that in debug mode the code will be executed by the main thread.
void
Class
java.lang.String
SetStaticFilesOptions
A Map with configuration parameters that affect the way the server serves static files.
See this link for more information: <link>http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/servlet/DefaultServlet.html|http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/servlet/DefaultServlet.html</link>.
void
Options
anywheresoftware.b4a.objects.collections.Map
AddFilter
Maps a filter class.
Path - The filter will be mapped to the following path. You can use wildcards in the path.
Class - The class name (string).
SingleThreadHandler - Whether this handler should always run in the main thread.
void
Path
java.lang.String
Class
java.lang.String
SingleThreadHandler
boolean
AddDoSFilter
Adds a filter that protects against intentional or unintentional denial of service attacks.
It restricts the number of requests sent from the same connection.
Path - The filter will be mapped to the given path. You can use wildcards in the path.
Settings - An optional map with various settings. See this link: <link>DoS Filter Documentation|http://www.eclipse.org/jetty/documentation/9.4.x/dos-filter.html</link>
Example:<code>srvr.AddDoSFilter("/*", Null)</code>
void
Path
java.lang.String
Settings
anywheresoftware.b4a.objects.collections.Map
Initialize
Initializes the server.
EventName is currently not used.
void
ba
anywheresoftware.b4a.BA
EventName
java.lang.String
AddWebSocket
Maps a WebSocket class.
Path - The WebSocket will be mapped to this path.
Class - WebSocket class (string).
void
Path
java.lang.String
Class
java.lang.String
SetSslConfiguration
Configures the SSL connector and sets the port used for https connections.
void
Config
anywheresoftware.b4j.object.ServerWrapper.SslContextFactoryWrapper
Port
int
LogsFileFolder
java.lang.String
s
java.lang.String
Gets or sets the logs files folder.
Http2Enabled
boolean
b
boolean
Gets or sets whether Http/2.0 is enabled. Note that it requires some configuration (see the tutorial for more information).
Port
int
p
int
Gets or sets the server port.
SslPort
int
Returns the port used for SSL (https) connections.
LogsRetainDays
int
p
int
Gets or sets the number of days the rotated logs will be kept.
StaticFilesFolder
java.lang.String
s
java.lang.String
Gets or sets the static files folder.
GzipEnabled
b
boolean
Calling this method will cause the server to compress the responses if the client supports GZIP responses and the resource mime type is not of a known compressed type.
In most cases it should be enabled.
DebugNetworkLatency
i
int
Sets the emulated network latency in debug mode, measured in milliseconds.
Default value is 100.
You should only call this method before the server is started.
The emulated latency only affects server -> client -> server round-trips.
CurrentThreadIndex
int
Each thread is mapped to a specific index. This property returns the current thread index.
Note that the main thread index is always 0.
LogWaitingMessages
Sets whether "waiting for value" messages are logged.
These messages can help you to optimize the code and reduce the network latency effects.
boolean
anywheresoftware.b4j.object.ServerWrapper.SslContextFactoryWrapper
SslConfiguration
Holds the key store configuration.
org.eclipse.jetty.util.ssl.SslContextFactory
process
SetKeyStorePath
Sets the path to the keystore file.
void
Dir
java.lang.String
FileName
java.lang.String
EnableConscryptProvider
Sets the SSL provider to Conscrypt. This requires also adding:
<code>
#AdditionalJar: conscrypt-openjdk-uber-1.1.2</code>
void
IsInitialized
boolean
Initialize
void
KeyStorePassword
p
java.lang.String
Sets the keystore password.
KeyManagerPassword
p
java.lang.String
Sets the key password.
anywheresoftware.b4j.object.JServlet.ServletRequestWrapper
ServletRequest
javax.servlet.http.HttpServletRequest
process
GetParameter
Returns the parameter value or an empty string if the parameter does not exist.
java.lang.String
Name
java.lang.String
IsInitialized
boolean
GetParameterValues
java.lang.String[]
Name
java.lang.String
GetSession
Gets the user session. A new session will be created if this is the first request from this user.
anywheresoftware.b4j.object.HttpSessionWrapper
GetHeaders
Returns a list with all the headers values mapped to the specified header.
anywheresoftware.b4a.objects.collections.List
Name
java.lang.String
GetCookies
Returns an array with the request cookies.
anywheresoftware.b4j.object.CookieWrapper[]
GetHeader
Returns the header value or an empty string if the header does not exist.
java.lang.String
Name
java.lang.String
GetMultipartData
Parses a multipart request and returns a Map with the parsed Parts as values and the parts names as keys.
Folder - The files will be saved in this folder.
MaxSize - The request maximum size.
anywheresoftware.b4a.objects.collections.Map
Folder
java.lang.String
MaxSize
long
FullRequestURI
java.lang.String
Returns the full request URL including the scheme, host and parameters.
RemoteAddress
java.lang.String
Returns the client IP address.
ContentType
java.lang.String
Returns the request content type header or an empty string if the content type is not available.
InputStream
anywheresoftware.b4a.objects.streams.File.InputStreamWrapper
Returns an InputStream that allows you to read directly from the request body.
Secure
boolean
Returns true if the request was made with a secure channel (SSL).
CharacterEncoding
java.lang.String
Returns the request character encoding or an empty string if the encoding is not available.
RequestURI
java.lang.String
Returns the request URL without the host and any parameters.
ParameterMap
anywheresoftware.b4a.objects.collections.Map
Returns a Map with all the parameter. The keys are the parameters names (strings) and the values are the parameters values (arrays of strings).
ContentLength
int
Returns the request content length.
Method
java.lang.String
Returns the HTTP method (GET or POST).
anywheresoftware.b4j.object.JServlet.PartWrapper
Part
org.eclipse.jetty.util.MultiPartInputStreamParser.MultiPart
process
IsInitialized
boolean
GetValue
Returns the string value of this part. This should only be used with non-files parts.
java.lang.String
CharacterEncoding
java.lang.String
IsFile
boolean
<b>This method should not be used. Call TempFile instead to get the file.</b>
TempFile
java.lang.String
Returns the path to the temporary file.
SubmittedFilename
java.lang.String
Returns the submitted file name.
anywheresoftware.b4j.object.JServlet.ServletResponseWrapper
ServletResponse
javax.servlet.http.HttpServletResponse
process
Write
Writes the text to the response stream.
anywheresoftware.b4j.object.JServlet.ServletResponseWrapper
Text
java.lang.String
IsInitialized
boolean
AddCookie
Adds a cookie to the response.
void
Cookie
anywheresoftware.b4j.object.CookieWrapper
SendRedirect
Sends a redirect response with the status code 302.
Location - The new address.
void
Location
java.lang.String
SendError
Sends an error message.
StatusCode - Usually 500.
Message - The error message.
void
StatusCode
int
Message
java.lang.String
SetHeader
Sets the request header.
void
Name
java.lang.String
Value
java.lang.String
Status
int
s
int
Gets or sets the response status code.
Note that you should use SendError to send error statuses. Otherwise the custom error pages will be skipped.
ContentType
java.lang.String
s
java.lang.String
Gets or sets the response content type.
OutputStream
anywheresoftware.b4a.objects.streams.File.OutputStreamWrapper
Returns an OutputStream that can be used to write bytes directly to the response stream.
CharacterEncoding
java.lang.String
s
java.lang.String
Gets or sets the response character encoding.
ErrorReason
java.lang.String
Returns the error string that is tied to this response. This is useful with handlers that act as custom error pages.
ContentLength
i
int
Sets the response content length header.
anywheresoftware.b4j.object.HttpSessionWrapper
HttpSession
HttpSessions allows you to identify a user across multiple requests and to store data specific to this user.
The session id is stored as a cookie in the user browser, or as a URL parameter if cookies are disabled.
The data is stored in the server memory.
Getting and creating sessions is done with ServletRequest.GetSession.
javax.servlet.http.HttpSession
process
GetAttribute2
Returns the value tied to the attribute with the specified name.
Returns the DefaultValue if no value exists.
java.lang.Object
Name
java.lang.String
DefaultValue
java.lang.Object
GetAttribute
Returns the value tied to the attribute with the specified name.
java.lang.Object
Name
java.lang.String
IsInitialized
boolean
SetAttribute
Adds an attribute to the session. If there is an existing value with the same name then it will be replaced.
void
Name
java.lang.String
Value
java.lang.Object
RemoveAttribute
Removes the attribute with the given name.
void
Name
java.lang.String
GetAttributesNames
Returns a List with all the session names.
anywheresoftware.b4a.objects.collections.List
HasAttribute
Tests whether there is a value tied to the given name.
boolean
Name
java.lang.String
Invalidate
Invalidates the session. This causes the session to be deleted.
void
CreationTime
long
Returns the session creation time.
Id
java.lang.String
Returns the session unique id.
LastAccessedTime
long
Returns the last time the user sent a request associated with this session.
IsNew
boolean
Returns true if the session was created in this request.
MaxInactiveInterval
int
i
int
Gets or sets the maximum inactive interval, in seconds. The session will be invalidated if there was not any activity for a period larger than this value.
The default value is -1 which means that there is no maximum interval.
anywheresoftware.b4j.object.CookieWrapper
Cookie
Represents a HTTP cookie. You can add cookies to the response with ServletResponse.AddCookie.
These cookies will then be sent in the following browser requests.
You can fetch the cookies with ServletRequest.GetCookies.
javax.servlet.http.Cookie
process
IsInitialized
boolean
Initialize
Creates a new cookie with the given name and value.
void
Name
java.lang.String
Value
java.lang.String
MaxAge
int
i
int
Gets or sets the cookie maximum age in seconds.
A negative value means that the cookie will be deleted when the Web browser exists.
A zero value causes the cookie to be deleted.
Value
java.lang.String
s
java.lang.String
Gets or sets the cookie value.
HttpOnly
boolean
b
boolean
Gets or sets whether the cookie is a http only cookie (a cookie that cannot be read by client-side scripts).
Name
java.lang.String
Gets the cookie name.
anywheresoftware.b4j.object.ConnectionPool
ConnectionPool
Maintains a pool of database connections.
com.mchange.v2.c3p0.ComboPooledDataSource
process
ConnectionReady (Success As Boolean, SQL As SQL)
GetConnection
Retrieves a connection from the pool. Make sure to close the connection when you are done with it.
anywheresoftware.b4j.objects.SQL
GetConnectionAsync
Asynchronously gets a SQL connection. This method is useful in UI applications as it prevents the main thread from freezing until the connection is available.
The ConnectionReady event will be raised when the connection is ready.
void
ba
anywheresoftware.b4a.BA
EventName
java.lang.String
ClosePool
void
IsInitialized
boolean
Initialize
Initializes the pool.
DriverClass - The JDBC driver class.
JdbcUrl - JDBC connection url.
User / Password - Connection credentials.
void
DriverClass
java.lang.String
JdbcUrl
java.lang.String
User
java.lang.String
Password
java.lang.String
anywheresoftware.b4j.object.BackgroundWorkersManager
process
startWorker
void
className
java.lang.Class
3.01
jetty_b4j
jserver/c3p0-0.13.0
jserver/c3p0-oracle-thin-extras-0.9.5
jserver/mchange-commons-java-0.5.0
json
name:Server Handler, filenamewithoutextension:server_handler
name:Server Filter, filenamewithoutextension:server_filter
name:Server WebSocket, filenamewithoutextension:server_websocket