REST Binding Component User's Guide

Configuring the REST Binding Component Runtime Properties

The REST Binding Component's runtime properties apply to all instances of the binding component in a domain, including all provider and consumer endpoints. The properties can be configured from the NetBeans IDE, GlassFish Admin Console, or from a command prompt during a command line installation. This section describes how to configure the properties in NetBeans.

ProcedureTo Configure REST BC Runtime Properties

  1. From the Services window of the NetBeans IDE, expand the Servers node.

  2. If the application server is not already started, right-click the server and then select Start.

  3. Under the application server, expand JBI and expand Binding Components.

  4. If the REST BC is not started, right-click sun-rest-binding and select Properties.

    The Properties Editor appears.

    Figure shows the REST BC Runtime Properties Editor.
  5. Modify any of the properties listed in REST Binding Component Runtime Property Descriptions.


    Note –

    General, identification, and statistic properties are automatically updated by the REST BC. You do not need to modify these properties.


  6. To apply the changes, stop and restart the REST BC.

REST Binding Component Runtime Property Descriptions

The REST Binding Component properties specify clustering and security settings, and reference descriptive information for the Binding Component. The following tables list and describe each REST Binding Component runtime property.

Table 5 REST BC General Runtime Properties

Property 

Description 

Description 

A general description of the JBI component. 

Name 

A unique name for the REST BC in the JBI environment. If you install more than one REST Binding Component in a JBI environment, make sure that each has a unique name. When the service unit deploys the component, it is matched with target component name defined in its descriptor file, jbi.xml, which can be modified as needed.

State 

The current state of the JBI component. This value can be either Started, Stopped, or Shutdown. 

Type 

The type of JBI component (service-engine or binding-component). 

Table 6 REST BC Identification Runtime Properties

Property 

Description 

Version 

The version number of the installed binding component. 

Build Number 

The build number of the installed binding component. 

Table 7 REST BC Configuration Runtime Properties

Property 

Description 

NMR Core Thread Pool Size 

The number of core threads used concurrently for processing NMR messages. 

The default value is 16. 

NMR Max Thread Pool Size 

The maximum number of threads used concurrently for processing NMR messages. 

The default value is 64. 

Default HTTP Listener Port 

The default HTTP port number for the REST Binding Component. This property is required for clustering and allows the REST Binding Components in the cluster instances to be differentiated by a unique default port number.  

A default port number is calculated and preassigned when the binding component is initially installed in the application server instance. A file containing the persisted configuration is stored for each component. This is used to assign a unique default port number for each REST Binding Component instance on a computer.  

The default value is 9696. 

Default HTTP Listener Threads 

The maximum number of threads to process RESTful services concurrently using HTTP. 

The default value is 32. 

Default HTTPS Listener Port 

The default HTTP secure port number for the REST Binding Component. This property is required for clustering and allows the REST Binding Components in the cluster instances to be differentiated by unique default port numbers.  

A default port number is calculated and preassigned when the binding component is initially installed in the application server instance. A file containing the persisted configuration is stored for each component. This is used to assign a unique default port number for each REST Binding Component instance on a computer.  

The default value is 9697. 

Default HTTPS Listener Threads 

The maximum number of threads to process RESTful services concurrently using HTTPS. 

The default value is 32. 

Truststore Password 

The default truststore password, which is used for CA certificate management when establishing SSL connections. 

Keystore Password 

The default keystore password, which is used to access the keystore used for key/certificate management when establishing SSL connections. 

Application Configuration 

A list of values for a Composite Application's endpoint connectivity parameters, which are normally defined in the WSDL service extensibility elements. The values are applied to a user-named endpoint Config Extension Property. The values defined in an application configuration override the values defined in the WSDL document. 

For more information, see Creating Application Configurations for Connectivity Parameters (URLs).

Application Variables 

A list of name and value pairs for a given type. The application variable name can be used as a token for a WSDL extensibility element attribute in a corresponding binding.  

For more information, see Using Application Variables.

Table 8 REST BC Runtime Statistics

Property 

Description 

Activated Endpoints 

The number of activated endpoints. 

Active Exchanges 

The number of active exchanges. 

Avg. Component Time 

The average message exchange component time in milliseconds. 

Avg. D.C. Time 

The average message exchange delivery channel time in milliseconds. 

Avg. Msg. Service Time 

The average message exchange message service time in milliseconds. 

Avg. Response Time 

The average message exchange response time in milliseconds. 

Completed Exchanges 

The total number of completed exchanges. 

Error Exchanges 

The total number of error exchanges. 

Received Dones 

The total number of received dones. 

Received Errors 

The total number of received errors. 

Received Faults 

The total number of received faults. 

Received Replies 

The total number of received replies. 

Received Requests 

The total number of received requests. 

Sent Dones 

The total number of sent dones. 

Sent Errors 

The total number of sent errors. 

Sent Faults 

The total number of sent faults. 

Sent Replies 

The total number of sent replies. 

Sent Requests 

The total number of sent requests. 

Up Time 

The up time of this component in milliseconds. 

The Loggers properties specify the level of logging for each event. You can set the logging level for each logger to any of the following levels:

By default, these are all set to the INFO level.

Table 9 REST BC Logger Runtime Properties

Property 

WLM Component 

sun-rest-binding 

com.sun.jbi.restbc 

RestBC ClientWrapper 

com.sun.jbi.restbc.jbiadapter.JerseyClientWrapper 

RestBC Message Processor 

com.sun.jbi.restbc.jbiadapter.MessageProcessor 

RestBC Receiver 

com.sun.jbi.restbc.jbiadapter.Receiver 

RestBC Bootstrap 

com.sun.jbi.restbc.jbiadapter.RestBootstrap 

RestBC Component 

com.sun.jbi.restbc.jbiadapter.RestComponent 

RestBC ServiceUnitManager 

com.sun.jbi.restbc.jbiadapter.RestSUManager 

RestBC ServiceUnit 

com.sun.jbi.restbc.jbiadapter.ServiceUnit 

RestBC InboundDelegator 

com.sun.jbi.restbc.jbiadapter.inbound.InboundDelegator 

RestBC RootResource 

com.sun.jbi.restbc.jbiadapter.inbound.JerseyRootResource 

RuntimeConfig 

com.sun.jbi.restbc.jbiadapter.mbeans.RuntimeConfig