Atom Class
Properties Methods Events Configuration Settings Errors
The Atom Class is used to retrieve, parse, and update Atom content.
Syntax
class ipworks.Atom
Remarks
The Atom class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL related settings are also supported via the config method.
The Atom Class implements a standard Atom client as defined by RFC 4287 (http://www.ietf.org/rfc/rfc4287) and includes the Atom publishing capabilities as defined by the "The Atom Publishing Protocol" (http://www.ietf.org/rfc/rfc5023).
The class contains a number of properties that map directly to Atom fields. To receive a feed, call the get_feed method with the URL or file to retrieve specified in the URL parameter. You may also update the Entries properties using the put method.
The Atom Class supports all standard Atom properties and allows you to add your own through add_namespace and the get_property and set_property methods.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| accept | A list of acceptable MIME types for the request. |
| atom_data | The complete content of the Atom resource. |
| authorization | The Authorization string to be sent to the server. |
| auth_scheme | The authentication scheme to use when server authorization is required. |
| channel_author_email | This property contains the email address of the author. |
| channel_author_name | This property contains the name of the author. |
| channel_author_uri | This property contains the URI of the author. |
| channel_category_label | This property contains a textual description of the label for the category. |
| channel_category_scheme | This property identifies a categorization scheme. |
| channel_category_term | This property contains the category to which the entry or feed belongs. |
| channel_contributor_email | This property contains the email address of the contributor. |
| channel_contributor_name | This property contains the name of the contributor. |
| channel_contributor_uri | This property contains the URI of the contributor. |
| channel_generator | This property identifies the generator of the feed. |
| channel_icon | This property contains a reference to the image that represents this feed. |
| channel_id | The Id conveys a permanent, universally unique identifier for an entry or feed. |
| channel_link_href | This property contains the location of the link. |
| channel_link_href_lang | This property contains the language of the content at the link. |
| channel_link_length | This property contains the length (in bytes) of the content at the link. |
| channel_link_rel | This property indicates the relation of the linked content to the feed. |
| channel_link_title | This property contains the title of the link. |
| channel_link_type | This property contains the MIME type of the content at the link. |
| channel_logo | This property contains logo for an image that represents the feed. |
| channel_rights | This property contains information about the rights of the given feed. |
| channel_rights_text_type | Text type of the rights of the feed. |
| channel_subtitle | This contains a short description of the Atom Feed. |
| channel_subtitle_text_type | This property contains the text type of the sub-title of the feed. |
| channel_title | This property contains the title of the current Atom Feed. |
| channel_title_text_type | This property contains the text type of the title of the feed. |
| channel_updated | This property contains the date and time that the feed was updated. |
| connected | Shows whether the class is connected. |
| content_type | Content type for posts and puts. |
| cookie_count | The number of records in the Cookie arrays. |
| cookie_domain | The domain of a received cookie. |
| cookie_expiration | This property contains an expiration time for the cookie (if provided by the server). |
| cookie_name | The name of the cookie. |
| cookie_path | This property contains a path name to limit the cookie to (if provided by the server). |
| cookie_secure | This property contains the security flag of the received cookie. |
| cookie_value | This property contains the value of the cookie. |
| entry_count | The number of records in the Entry arrays. |
| entry_author_email | This property contains the email address of the author. |
| entry_author_name | This property contains the name of the author. |
| entry_author_uri | This property contains the URI of the author. |
| entry_category_label | This property contains a textual description of the label for the category. |
| entry_category_scheme | This property identifies a categorization scheme. |
| entry_category_term | This property contains the category to which the entry or feed belongs. |
| entry_content | This property contains the text contents of an Atom entry. |
| entry_content_text_type | This property contains the text type of the content of the entry. |
| entry_contributor_email | This property contains the email address of the contributor. |
| entry_contributor_name | This property contains the name of the contributor. |
| entry_contributor_uri | This property contains the URI of the contributor. |
| entry_copyright | This property is used a textual description of the copyright statement for the current ATOM feed. |
| entry_created | This property contains a Date value that indicates the time that the current entry was created. |
| entry_xml | This property contains the full XML contents of the entry. |
| entry_id | The Id conveys a permanent, universally unique identifier for an entry or feed. |
| entry_issued | This property contains a Date value that indicates the time that the current entry was issued. |
| entry_link_href | This property contains the location of the link. |
| entry_link_href_lang | This property contains the language of the content at the link. |
| entry_link_length | This property contains the length (in bytes) of the content at the link. |
| entry_link_rel | This property indicates the relation of the linked content to the feed. |
| entry_link_title | This property contains the title of the link. |
| entry_link_type | This property contains the MIME type of the content at the link. |
| entry_modified | This property contains a Date value that indicates the time in which the current entry was last modified. |
| entry_published | This property contains the date that the entry was first created. |
| entry_rights | This property contains information about the rights of the given entry. |
| entry_rights_text_type | Text type of the rights of the feed. |
| entry_source | This property is used when an entry has been copied from one feed to another feed. |
| entry_summary | This property contains a short textual description of the Atom entry. |
| entry_summary_text_type | This property contains the text type of the summary of the entry. |
| entry_title | This property contains the title of the current Atom Feed. |
| entry_title_text_type | This property contains the text type of the title of the feed. |
| entry_updated | This property contains the date and time that the feed was updated. |
| firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
| firewall_type | This property determines the type of firewall to connect through. |
| firewall_host | This property contains the name or IP address of firewall (optional). |
| firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
| firewall_port | This property contains the TCP port for the firewall Host . |
| firewall_user | This property contains a user name if authentication is to be used connecting through a firewall. |
| follow_redirects | Determines what happens when the server issues a redirect. |
| idle | The current status of the class. |
| if_modified_since | A date determining the maximum age of the desired document. |
| local_file | The path to a local file for downloading. If the file exists, it is overwritten. |
| local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| namespace_count | The number of records in the Namespace arrays. |
| namespace_prefix | The Prefix for the Namespace . |
| namespace_uri | Namespace URI associated with the corresponding Prefix . |
| other_headers | Other headers as determined by the user (optional). |
| parsed_header_count | The number of records in the ParsedHeader arrays. |
| parsed_header_field | This property contains the name of the HTTP header (same case as it is delivered). |
| parsed_header_value | This property contains the header contents. |
| password | A password if authentication is to be used. |
| proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
| proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
| proxy_password | This property contains a password if authentication is to be used for the proxy. |
| proxy_port | This property contains the TCP port for the proxy Server (default 80). |
| proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| proxy_ssl | This property determines when to use SSL for the connection to the proxy. |
| proxy_user | This property contains a user name, if authentication is to be used for the proxy. |
| referer | Referer URL/document (optional). |
| slug | A header added to the HTTP request. |
| ssl_accept_server_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_store | The name of the certificate store for the client certificate. |
| ssl_cert_store_password | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| ssl_cert_store_type | The type of certificate store for this certificate. |
| ssl_cert_subject | The subject of the certificate used for client authentication. |
| ssl_server_cert_encoded | The certificate (PEM/base64 encoded). |
| timeout | A timeout for the class. |
| transferred_data | The contents of the last response from the server. |
| transferred_data_limit | The maximum of bytes of data to be transferred. |
| transferred_headers | The full set of headers as received from the server. |
| update_entry_author_email | This property contains the email address of the author. |
| update_entry_author_name | This property contains the name of the author. |
| update_entry_author_uri | This property contains the URI of the author. |
| update_entry_category_label | This property contains a textual description of the label for the category. |
| update_entry_category_scheme | This property identifies a categorization scheme. |
| update_entry_category_term | This property contains the category to which the entry or feed belongs. |
| update_entry_content | This property contains the text contents of an Atom entry. |
| update_entry_content_text_type | This property contains the text type of the content of the entry. |
| update_entry_contributor_email | This property contains the email address of the contributor. |
| update_entry_contributor_name | This property contains the name of the contributor. |
| update_entry_contributor_uri | This property contains the URI of the contributor. |
| update_entry_copyright | This property is used a textual description of the copyright statement for the current ATOM feed. |
| update_entry_created | This property contains a Date value that indicates the time that the current entry was created. |
| update_entry_xml | This property contains the full XML contents of the entry. |
| update_entry_id | The Id conveys a permanent, universally unique identifier for an entry or feed. |
| update_entry_issued | This property contains a Date value that indicates the time that the current entry was issued. |
| update_entry_link_href | This property contains the location of the link. |
| update_entry_link_href_lang | This property contains the language of the content at the link. |
| update_entry_link_length | This property contains the length (in bytes) of the content at the link. |
| update_entry_link_rel | This property indicates the relation of the linked content to the feed. |
| update_entry_link_title | This property contains the title of the link. |
| update_entry_link_type | This property contains the MIME type of the content at the link. |
| update_entry_modified | This property contains a Date value that indicates the time in which the current entry was last modified. |
| update_entry_published | This property contains the date that the entry was first created. |
| update_entry_rights | This property contains information about the rights of the given entry. |
| update_entry_rights_text_type | Text type of the rights of the feed. |
| update_entry_source | This property is used when an entry has been copied from one feed to another feed. |
| update_entry_summary | This property contains a short textual description of the Atom entry. |
| update_entry_summary_text_type | This property contains the text type of the summary of the entry. |
| update_entry_title | This property contains the title of the current Atom Feed. |
| update_entry_title_text_type | This property contains the text type of the title of the feed. |
| update_entry_updated | This property contains the date and time that the feed was updated. |
| update_file | A resource to be updated, deleted or created. |
| user | A user name if authentication is to be used. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| add_cookie | Adds a cookie and the corresponding value to the outgoing request headers. |
| add_namespace | Adds a namespace to the Namespaces properties. |
| config | Sets or retrieves a configuration setting. |
| delete_resource | Deletes the resource at the specified URL. |
| do_events | Processes events from the internal message queue. |
| get_feed | Fetches an Atom feed. |
| get_property | Fetches the value of a specific Atom feed element or attribute. |
| get_resource | Fetches a resource. |
| interrupt | Interrupt the current method. |
| post_resource | Posts a resource to the specified URL. |
| put | Sends data to the HTTP server using the HTTP PUT method. |
| put_resource | Puts a resource to the specified URL. |
| read_file | Load an Atom file into the class. |
| reset | Reset all properties of the class. |
| set_property | Sets the value of a specific Atom feed property. |
| write_file | Write an Atom feed from the class. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_connected | Fired immediately after a connection completes (or fails). |
| on_connection_status | Fired to indicate changes in connection state. |
| on_disconnected | Fired when a connection is closed. |
| on_end_transfer | Fired when a document finishes transferring. |
| on_error | Information about errors during data delivery. |
| on_header | Fired every time a header line comes in. |
| on_log | Fires once for each log message. |
| on_redirect | Fired when a redirection is received from the server. |
| on_set_cookie | Fired for every cookie set by the server. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
| on_start_transfer | Fired when a document starts transferring (after the headers). |
| on_status | Fired when the HTTP status line is received from the server. |
| on_transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| 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. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to true the URL will be encoded by the class. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the class will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the class. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| 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. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class 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. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| 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 port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| 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). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| 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. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |