Try OpenEdge Now
skip to main content
Administration
REST Administration : REST Web Application Administration : Managing Web server deployed REST Web applications using the REST Management Agent
 

Managing Web server deployed REST Web applications using the REST Management Agent

Typically, REST Management Agent (oerm.war) manages applications deployed using the REST clients: RESTMAN utility, OpenEdge Management, or OpenEdge Explorer. Whenever the REST clients successfully deploy the REST Web application, all the REST Web application details are entered in the oermDeployedAppList.xml file of the REST Management Agent.
When the REST Management Agent is deployed for the first time (refer to Installing and Configuring REST Management Agent), the oermDeployedAppList.xml file is created in $CATALINA_HOME/webapp/oerm/WEB-INF/oerm.data/, and all the REST Web applications that are deployed using the REST Management Agent are listed in it.
For example, if you have deployed an application, RESTApp, using the REST Management Agent (oerm.war), the oermDeployedAppList.xml file gets populated with the RESTApp application details as follows:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Applications>
  <Application Name="RESTApp">
    <Description>This is sample description about RESTApp</Description>
    <Status>DISABLED</Status>
    <URI>http://localhost:8080/oerm/applications/RESTApp</URI>
    <PropertiesURI>
      http://localhost:8080/oerm/applications/RESTApp/properties
    </PropertiesURI>
    <StatisticsURI>
      http://localhost:8080/oerm/applications/RESTApp/statistics
    </StatisticsURI>
    <PropFileLoc>
      F:\Softwares\Apache-Tomcat\apache-tomcat-7.0.21\webapps\oerm\..\
        RESTApp\WEB-INF/adapters\runtime.props
    </PropFileLoc>
    <adapterDirLoc>
      F:\Softwares\Apache-Tomcat\apache-tomcat-7.0.21\webapps\oerm\..\
        RESTApp\WEB-INF/adapters
    </adapterDirLoc>
  </Application>
</Applications>
The following table lists the deployed application details:
Table 80. Deployed REST Web application details
Application detail
Description
Value
Application Name
Name of the application.
String
Description
Small description about the application.
String
Status1
Current state of the application.
Disabled or Enabled
URI
URI at which information about the application can be accessed.
Hyperlink
PropertiesURI
URI at which information about the application properties can be accessed.
Hyperlink
StatisticsURI
URI at which information about the application statistics can be accessed.
Hyperlink
PropFileLoc
Fully qualified path of the REST Web application runtime properties file, runtime.props.
Path
adapterDirLoc
Fully qualified path of the REST Web application adapters directory.
Path
1 This is the only application detail that is dynamically updated whenever a REST client enables or disables the application.

If you want to manage a Web server deployed REST Web application using the REST Management Agent, you must enter the application details in the oermDeployedAppList.xml file of the REST Management Agent (oerm.war) for it to recognize the application as one of the REST Management Agent managed application.
For example, if you want to manage a Web server deployed REST Web application, RRESTApp1, using the REST Management Agent, open the oermDeployedAppList.xml file, copy and paste the sample <application>...</application> code snippet, and then fill the, RESTApp1, application details as shown below:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Applications>
  <Application Name="RESTApp">
    <Description>This is sample description about RESTApp</Description>
    <Status>DISABLED</Status>
    <URI>http://localhost:8080/oerm/applications/RESTApp</URI>
    <PropertiesURI>
      http://localhost:8080/oerm/applications/RESTApp/properties
    </PropertiesURI>
    <StatisticsURI>
      http://localhost:8080/oerm/applications/RESTApp/statistics
    </StatisticsURI>
    <PropFileLoc>
      F:\Softwares\Apache-Tomcat\apache-tomcat-7.0.21\webapps\oerm\..\
        RESTApp\WEB-INF/adapters\runtime.props
    </PropFileLoc>
    <adapterDirLoc>
      F:\Softwares\Apache-Tomcat\apache-tomcat-7.0.21\webapps\oerm\..\
        RESTApp\WEB-INF/adapters
    </adapterDirLoc>
  </Application>

 <Application Name="RESTApp1">
    <Description>This is sample description about RESTApp1</Description>
    <Status>ENABLED</Status>
    <URI>http://localhost:8080/oerm/applications/RESTApp1</URI>
    <PropertiesURI>
      http://localhost:8080/oerm/applications/RESTApp1/properties
    </PropertiesURI>
    <StatisticsURI>
      http://localhost:8080/oerm/applications/RESTApp1/statistics
    </StatisticsURI>
    <PropFileLoc>
      F:\Softwares\Apache-Tomcat\apache-tomcat-7.0.21\webapps\oerm\..\
        RESTApp1\WEB-INF/adapters\runtime.props
    </PropFileLoc>
    <adapterDirLoc>
      F:\Softwares\Apache-Tomcat\apache-tomcat-7.0.21\webapps\oerm\..\
        RESTApp1\WEB-INF/adapters
    </adapterDirLoc>
  </Application>

</Applications>
Note: The sample RESTApp application is in the DISABLED state and the RESTApp1 application is in the ENABLED state. For an enabled REST Web application, the serviceAvailable run-time property is set to 1. For information about these REST Web application properties, see the Reference to OpenEdge Web Service Properties.
For all the REST Web applications listed in the oermDeployedAppList.xml file, you can use any of the supported REST clients (RESTMAN, OpenEdge Explorer, or OpenEdge Management) to manage your application.