GoogleRequest Bean
Properties Methods Events Configuration Settings Errors
The GoogleRequest component extends the existing functionality.
Syntax
InGoogle.Googlerequest
Remarks
The GoogleRequest component may be used to form and parse JSON based requests and response to extend the existing functionality of the toolkit.
When making requests the PostData property should be set to the body of the request. Call the Post method to post the data to the server.
When the response is returned the XPath properties such as XPath, XText, XElement, etc may be used to navigate the response.
This service supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth bean or
a separate process. Once complete you should have an authorization string which looks like:
Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQAssign this value to the Authorization property before attempting any operations. Consult the Google documentation for this particular service for more information about supported scope values and more details on OAuth authentication.
Property List
The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.
Accept | A list of acceptable MIME types for the request. |
Authorization | The Authorization string to be sent to the server. |
AuthScheme | The authentication scheme to use when server authorization is required. |
BuildDOM | When True, an internal object model of the JSON document is created. |
Connected | Shows whether the component is connected. |
ContentType | Content type for posts and puts. |
Cookies | Collection of cookies. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | Determines what happens when the server issues a redirect. |
From | The email address of the HTTP agent (optional). |
HTTPMethod | The HTTP method used for the request. |
Idle | The current status of the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
LocalFile | The path to a local file for downloading. If the file exists, it is overwritten. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
OtherHeaders | Other headers as determined by the user (optional). |
ParsedHeaders | Collection of headers returned from the last request. |
Password | A password if authentication is to be used. |
PostData | The data to post with the URL if the POST method is used. |
Proxy | A set of properties related to proxy access. |
Referer | Referer URL/document (optional). |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
StatusLine | The first line of the last server response. |
Timeout | A timeout for the component. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum of bytes of data to be transferred. |
TransferredHeaders | The full set of headers as received from the server. |
URL | The URL to post information to. |
User | A user name if authentication is to be used. |
XChildren | Collection of child elements of the current element. |
XElement | The name of the current element. |
XErrorPath | An XPath to check the server response for errors. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
Method List
The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.
addCookie | Adds a cookie and the corresponding value to the outgoing request headers. |
config | Sets or retrieves a configuration setting . |
delete | Deletes an object on the server. |
doEvents | Processes events from the internal message queue. |
get | Fetches the document. |
hasXPath | Determines whether a specific element exists in the document. |
input | Provides input to the parser. |
interrupt | Interrupt the current method. |
parseFile | Loads a JSON file into the component. |
post | Posts data to the HTTP server using the HTTP POST method. |
put | Sends data to the HTTP server using the HTTP PUT method. |
reset | Resets the component. |
Event List
The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.
Characters | Fired for plain text segments of the input stream. |
Connected | Fired immediately after a connection completes (or fails). |
ConnectionStatus | Fired to indicate changes in connection state. |
Disconnected | Fired when a connection is closed. |
EndElement | Fired when an end-element tag is encountered. |
Error | Information about errors during data delivery. |
Header | Fired every time a header line comes in. |
IgnorableWhitespace | Fired when a section of ignorable whitespace is encountered. |
Redirect | Fired when a redirection is received from the server. |
SetCookie | Fired for every cookie set by the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartElement | Fired when a new element is encountered in the document. |
Status | Fired when the HTTP status line is received from the server. |
Configuration Settings
The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.
CacheContent | If true, the original JSON is stored internally in a buffer. |
RequireJSONContentType | Controls whether the component checks for a JSON Content-Type value in the response. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |