# 22. Virtuoso Functions Guide - http_map_table

Chapter Contents | Prev | Next
Keyword Search:
www.openlinksw.com
docs.openlinksw.com
Book Home
Contents
Preface
Virtuoso Functions Guide
Administration
Aggregate Functions
Array Manipulation
BPEL APIs
Backup
Compression
Cursor
Date & Time Manipulation
Debug
Dictionary Manipulation
Encoding & Decoding
File Manipulation
Free Text
Hashing / Cryptographic
LDAP
Locale
Mail
Miscellaneous
Number
Remote SQL Data Source
Replication
SOAP
SQL
String
Transaction
Type Mapping
UDDI
User Defined Types & The CLR
Virtuoso Java PL API
Virtuoso Server Extension Interface (VSEI)
Web Server & Internet
dav add & update fun...
dav manipulation fun...
dav search functions
dav_exp
lfs_exp
serv_queue_top
vhost_define
vhost_remove
webdav users & group...
client_attr
connection_get
connection_id
connection_is_dirty
connection_set
connection_vars
connection_vars_set
dbname
ftp_get
ftp_ls
ftp_put
get_certificate_info
get_keyword
get_keyword_ucase
http
http_acl_get
http_body_read
http_client
http_client_ip
http_debug_log
http_enable_gz
http_file
http_flush
http_get
http_header
http_header_get
http_kill
http_listen_host
http_map_get
http_map_table
http_param
http_path
http_pending_req
http_physical_path
http_proxy
http_request_get
http_request_header
http_request_status
http_rewrite
http_root
http_url
http_value
http_xslt
ses_connect
ses_disconnect
ses_read_line
ses_write
tcpip_gethostbyaddr
tcpip_gethostbyname
vsp_calculate_digest
wsdl_import_udt
XML
XPATH & XQUERY
Functions Index

## http_map_table

Update internal HTTP mapping table
http_map_table (in logical_path varchar, in physical_path varchar, in vhost varchar, in listen_host varchar, [in stored_in_dav integer], [in is_browseable integer], [in default_page varchar], [in security_restriction varchar], [in authentication varchar], [in auth_function varchar], [in postprocess_function varchar], [in execute_vsp_as varchar], [in execute_soap_as varchar], [in have_persistent_session_variables integer], [in soap_options any], [in auth_options any]);
Parameters
logical_path – The absolute path string which the user agent will pass to the server in path part of URI
physical_path – The absolute path of the real content. For directories or WebDAV collections physical_path MUST end with a slash '/' character, otherwise the point will be treated as a file (or resource).
vhost – The host name that will be sent to the user-agent in HTTP request. This MUST be valid fully-qualified host name or alias and port separated with semi-column ':' character. This parameter accept special value '*ini*' which will be replaced with hostname and port from INI file.
listen_host – The fully-qualified host name or IP address and port which will be listened on. Warning: This is only used to make an in-memory mapping, and will not start listening (for starting and stopping a listener see http_listen_host).
stored_in_dav – Determine if the physical location is a WebDAV resource or collection. Can accept zero or one (1) integer values.
is_browseable – Determine if directory browsing is allowed for this location. Accepts integer values 0 or 1, treated as false and true respectively. If true (1) enabled and a default page is not specified, a GET request of an URL pointing to this location will generate a directory listing as a response to the user-agent.
default_page – File name of default page that will be sent to the user-agent if physical_path is a directory.
security_restriction – A keyword that denotes security type controlling access to the location. Can be 'Digest', 'SSL' or NULL. This value can be used in the auth_function hook using http_map_get.
authentication – A string value that will be passed as a parameter to the auth_function hook
auth_function – Fully qualified name of a PL procedure that will perform HTTP authentication. The function must accept one input parameter of type VARCHAR and MUST return integer 0 or 1 as false or true, respectively. A zero return value from the authentication function will cause the HTTP request to be rejected.
postprocess_function – Fully qualified name of a PL procedure that will be called every time after page processing. Usual purpose is to store session variables in a session table.
execute_vsp_as – The name of DB user, as whom VSP pages will be executed. If the user is not specified (is null), execution is forbidden.
execute_soap_as – The name of DB user, as whom SOAP calls will be executed. If null, execution of SOAP calls is forbidden.
have_persistent_session_variables – Flag that determines if the location has persistent session variables. The value of this flag can be retrieved with http_map_get.
soap_options – A vector with keyword/value pairs. Currently, valid keywords are 'Namespace' and 'ServiceName'. Namespace is a string defining the namespace for the SOAP service. ServiceName is a string containing name of the SOAP service. See example.
auth_options – The value of this parameter can be used in the authentication hook. In practice an array of keyword/value pairs would be the input but a single string could be supplied. The user-specific authentication hook can retrieve the options by calling the http_map_get('auth_opts') function.
Description

This function requires dba privileges.

This function inserts an entry defining a virtual directory into the HTTP maps table.

Examples
Inserting A Map Entry

    http_map_table ('/vdir', '/admin/', 'www.foo.com', 'host.foo.com');

Create entry for a SOAP service

    http_map_table ('/soapapp', '/soapapp/', 'www.foo.com', 'host.foo.com', NULL,
                     NULL, NULL, 'SSL', 'SOAP_APP', 'mysoapapp_auth_hook', 'mysoapapp_post_processor',
                     NULL, 'mysoapapp_user', 1, vector ('NameSpace', 'http://www.openlinksw.com/soap/v11/',
                                                      'ServiceName','soapApp'));

See Also

http_map_get

http_listen_host

HTTP Authentication in main documentation

HTTP Session Management in main documentation

.