Show:

Exposes methods to GET and SET Service Descriptor information as per define in ServiceDescriptor.xml file by application.

Example:
                            
                            <service-descriptor>
                                
                                <!-- General Service Properties -->
                                    <!-- Mandatory Field -->
                                <property name="name">name_of_service</property>
                                
                                    <!-- Optional Field -->
                                <property name="description">description_of_service</property>
                                
                                    <!-- Optional Field (DEFAULT: HTTP) -->
                                <property name="protocol">HTTP|HTTPS</property>
                                
                                    <!-- Mandatory Field -->
                                <property name="instance">address_of_instance</property>
                                
                                    <!-- Optional Field -->
                                <property name="port">port_number</property>
                            
                                    <!-- Optional Field -->
                                <property name="context">context_of_service</property>
                                     
                                <!-- Requests -->
                                    <!-- Request -->
                                <request>
                                        
                                    <request>
                            
                                        <!-- General Request Properties -->
                                     
                                            <!-- Mandatory Field -->
                                        <property name="name">name_of_request</property>
                                     
                                            <!-- Mandatory Field -->
                                        <property name="type">GET|HEAD|POST|PUT|DELETE|TRACE|OPTIONS|CONNECT|PATCH</property>
                            
                                            <!-- Mandatory Field -->
                                        <property name="api">full_request_path</property>
                            
                                            <!-- Mandatory Field -->
                                        <property name="handler">handler_of_request</property>
                                        
                                            <!-- Optional Field (DEFAULT: SYNC)-->
                                        <property name="mode">SYNC|ASYNC</property>
                            
                                        
                                                    
                                        <!-- Query Parameters -->
                                            <!-- Query Parameter -->
                                        <query-parameters>
                                      
                                            <query-parameter>
                                                
                                                <!-- Mandatory Field -->
                                                <property name="name">name_of_query_parameter</property>
                                                
                                                <!-- Mandatory Field -->
                                                <property name="value">value_of_query_parameter</property>
                                                
                                            </query-parameter>
                                        
                                        </query-parameters>
                                  
                                  
                                        <!-- Header Parameters -->
                                            <!-- Header Parameter -->
                                        <header-parameters>
                                      
                                            <header-parameter>
                                                
                                                <!-- Mandatory Field -->
                                                <property name="name">name_of_header_parameter</property>
                                                
                                                <!-- Mandatory Field -->
                                                <property name="value">value_of_header_parameter</property>
                                                
                                            </header-parameter>
                                        
                                        </header-parameters>
                            
                                        
                                        <!-- Stream of Data Under Request Body -->
                                            <!-- It is Optional Property -->
                                        <data-stream>stream_of_data</data-stream>   
                                    
                                    </request>
                                </requests>
                                
                            </service-descriptor>

Methods

addProperty

(
  • name
  • value
)

Add Property in property pool.

Parameters:

  • name String

    Name of Property.

  • value String

    value of Property.

addRequest

(
  • request
)

Add request

Parameters:

containProperty

(
  • name
)
Boolean

Check whether Property exist or not.

Parameters:

  • name String

    Name of Property.

Returns:

Boolean:

true/false, TRUE if property exist, FALSE if property does not exist.

getName

() String

Get service name

Returns:

String:

Name of service

getProperties

() Array

Get all Properties defined in descriptor.

Returns:

Array:

All Property Values.

getProperty

(
  • name
)
String

Get Property based on name provided.

Parameters:

  • name String

    Name of Property.

Returns:

String:

Property value.

getRequests

()

Get all requests

Returns:

Requests

removeProperty

(
  • name
)

Remove Property from property pool.

Parameters:

  • name String

    Name of Property.

setContext

(
  • context
)

Set context

Parameters:

setDescription

(
  • description
)

Set description

Parameters:

  • description String

    Description

setDescription

() String

Get description

Returns:

String:

Description

setInstance

(
  • instance
)

Set instance

Parameters:

setName

(
  • name
)

Set service name

Parameters:

setProtocol

(
  • protocol
)

Set protocol

Parameters: