Send-Bulk-Stream
Description
Retrieves a file from the file system that is local to the adapter and streams it back to the browser.
Syntax
<ie:webject name="Send-Bulk-Stream" type="ACT">
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="DBUSER" data="dbuser_name"/>
<ie:param name="FILENAME" data="file_name"/>
<ie:param name="INSTANCE" data="instance_name"/>
<ie:param name="MIMETYPE" data="mimetype"/>
<ie:param name="OBJECT" data="object_context_name"/>
<ie:param name="PASSWD" data="dbpassword"/>
</ie:webject>
Parameters
|
Required
|
Optional
|
|
FILENAME
|
CONNECTION_ATTEMPTS
|
|
INSTANCE
|
CONNECTION_ATTEMPT_INTERVAL
|
|
MIMETYPE
|
DBUSER
|
|
OBJECT
|
|
PASSWD
|
CONNECTION_ATTEMPTS
Defines the maximum number of times to attempt establishing a connection to an adapter before returning an error. The default value is 1. This parameter is optional.
If multiple INSTANCE parameter values are specified, the value of CONNECTION_ATTEMPTS defines the maximum number of times to iterate through the list of adapter instances.
CONNECTION_ATTEMPT_INTERVAL
Defines the amount of time, in seconds, to delay between connection attempts. The default value is 60 seconds. This parameter is optional.
If multiple INSTANCE parameter values are specified, the value of CONNECTION_ATTEMPT_INTERVAL defines the number of seconds to wait between the attempts to iterate through the entire list of adapter instances.
DBUSER
Specifies the name to use when logging in to the data repository. If this parameter is specified in this webject, the webject value takes precedence over any value specified in the credentials mapping settings or in the adapter LDAP entry. If this parameter is not specified here, it must be specified in the credentials mapping settings or in the adapter LDAP entry. For more information about credentials mapping, see the section
Credentials Mapping.
FILENAME
Describes the name of the attribute that contains the filepath. If the OBJECT parameter is specified, then the value specifies a distinguished name to an LDAP entry which contains the filepath. This is a required parameter.
INSTANCE
Specifies the name of the adapter that executes the webject. Adapter names are defined when the adapter is configured for use in your Info*Engine environment. This parameter is required.
To connect to other adapters if a specific adapter is not available, this parameter can be multi-valued. Info*Engine attempts to connect to the adapters in the order given. If the first adapter specified in not available, the next adapter listed is tried, and so on, until a connection is made. If a connection cannot be established with any listed adapter, an error is returned.
In conjunction with this parameter, you can include two other parameters, CONNECTION_ATTEMPTS and CONNECTION_ATTEMPT_INTERVAL.
MIMETYPE
Describes the name of the attribute that has a mimetype. If placed in single quotes, the string typed here is used as the exact mimetype for the data.
If no quotes are used, the string represents the attribute which contains the mimetype. This is a required parameter.
OBJECT
Specifies the context name of the entry. One object may be specified. If more than one is specified, the first will be used and the remainder ignored. This is an optional parameter.
PASSWD
Specifies the password to use when logging in to the data repository. If this parameter is specified in this webject, the webject value takes precedence over any value specified in the credentials mapping settings or in the adapter LDAP entry. If this parameter is not specified here, it must be specified in the credentials mapping settings or in the adapter LDAP entry. For more information about credentials mapping, see the section
Credentials Mapping.
Example
The Send-Bulk-Stream webject shown in this example instructs Info*Engine to connect to the appropriate adapter instance. Once connected, Info*Engine returns a stream of data representing the file /usr/file.gif. The GIF image can be displayed in the browser.
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Send-Bulk-Stream" type="ACT">
<ie:param name="INSTANCE" data="jndiAdapter"/>
<ie:param name="FILENAME" data="'/usr/file.gif'"/>
<ie:param name="MIMETYPE" data="'image/gif'"/>
</ie:webject>