Nav
You are viewing an older version of this section. Click here to navigate to the latest version.

HTTP Static Resource Handler

Use the HTTP Static Resource Handler to specify any HTTP static resource as an output. 

Configuration

Insert the HTTP Static Resource Handler into your flow and configure it per the following table.

Field Description Default Value Sample XML

Display Name

Name of the component as it appears in the flow.

HTTP Static Resource Handler

doc:name="HTTP Static Resource Handler"

Resource Base

Required. The resource folder where the html document(s) are stored.

N/A

resourceBase="/myApp"

Default File

Required. The default main file to serve when the directory is specified. If no file is specified, index.html is used.

index.html

defaultFile="index.html"


    
            
         
1
<http:static-resource-handler resourceBase="/myApp" doc:name="HTTP Static Resource Handler" defaultFile="index.html"/>
Element Description

http:static-resource-handler

Specify any HTTP static resource to be the output produced by this component. 

Attribute Name Description

resourceBase

Required. The resource folder where documents are stored.

Type: string
Default: none
Example:

resourceBase="/myApp"

defaultFile

Required. The default main file to serve when the directory is specified.

Type: string
Default: index.html
Example:

defaultFile="index.html"

doc:name

Customize to display a unique name for the logger in your application.

Note: An attribute is not required in a Mule Standalone configuration.

Type: string
Default: none
Example:

doc:name="HTTP Static Resource Handler"

Example Implementation

  1. Drag an HTTP Connector into a new flow, followed by an HTTP Static Resource Handler.

    image

  2. Leave the HTTP connector with its default settings, pointing to 0.0.0.0:8081.

  3. Create a new folder on your local hard drive, and place a static HTML file in it. Any HTML file works, such as:

    
           
                   
                
    1
    2
    3
    4
    5
    
    <html>
    <body>
    <h2>Hello Mules!</h2>
    </body>
    </html>
  4. Configure the HTTP Static Resource Handler to reference the folder and file. In this example, the path is /Users/me/ and the file name is mulesoft.html.

    image

  5. Save, then run your project. Right-click your project name in the Package Explorer and click Run As > Mule Application. You can also run your application from the Run menu.

  6. Open any browser window, and type 0.0.0.0:8081 in the address bar. 

  7. Your HTML file loads, and if you have a display item like in the example, the text displays:

    hello-mules

    The payload produced by this component is the HTTP content of the mulesoft.html file. The folder specified in the Resource Base may also contain other files such as .css stylesheets or .js scripts that the main .html file can reference.

  1. Create a new flow and add an HTTP inbound endpoint. Set the host to 0.0.0.0 and the port to 8081.

    
           
                   
                
    1
    2
    3
    
    <flow name="Flow1" doc:name="Flow1">
        <http:inbound-endpoint exchange-pattern="request-response" host="0.0.0.0" port="8081" doc:name="HTTP"/>
    </flow>
  2. Create a new folder on your local hard drive, then place any static HTML file in that folder, for example: , such as:

    
           
                   
                
    1
    2
    3
    4
    5
    
    <html>
    <body>
    <h2>Hello Mules!</h2>
    </body>
    </html>

    In this example, the path is /Users/me/ and the file name is mulesoft.html.

  3. Add a HTTP Static Resource Handler and configure it to reference this file.

    
           
                   
                
    1
    2
    3
    4
    
    <flow name="Flow1" doc:name="Flow1">
            <http:inbound-endpoint exchange-pattern="request-response" host="0.0.0.0" port="8081" doc:name="HTTP"/>
            <http:static-resource-handler resourceBase="/Users/me" doc:name="HTTP Static Resource Handler" defaultFile="mulesoft.html"/>
    </flow>
  4. Save, then run your project.

  5. Open any browser window, then type 0.0.0.0:8081 in the address bar:

    hello-mules

    The payload produced by this component is the HTTP content of the mulesoft.html file. The folder specified in the Resource Base may also contain other files such as .css stylesheets or .js scripts that the main .html file can reference.

Complete Example Code


         
      
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:spring="http://www.springframework.org/schema/beans"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-current.xsd
 
http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
 
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd">
 
    <flow name="http_static_resource_handler_testFlow1" doc:name="http_static_resource_handler_testFlow1">
 
        <http:inbound-endpoint exchange-pattern="request-response" host="0.0.0.0" port="8081" doc:name="HTTP"/>
 
        <http:static-resource-handler resourceBase="${app.home}/web" defaultFile="index.html" doc:name="HTTP Static Resource Handler"/>
    </flow>
 
</mule>
In this example, the resource handler deals with documents in the project folder src/main/app/web, referenced dynamically through the expression ${app.home}/web. For maven projects, please use "${app.home}/classes/web" for resourceBase parameter.

See Also