|
Options |
Name |
Purpose |
|
|
|
AddDefaultOperations (character)
|
/* Add default operations for a service (if not yet
@param character The service for which to add default operations */
|
|
|
|
HANDLE CreateTempTable (character, JsonObject)
|
|
|
|
|
DeregisterService (character)
|
/* Removes a service registration.
@param character The name of the service to remove from the registry */
|
|
|
|
FindOperationRecord (character, character, MethodEnum, buffer)
|
/* Helper method to find and position the Operation buffer to a given service/method. Caller must check
availablity themselves.
@param character The service name
@param character The service URI
@param MethodEnum the http method
@param buffer The Operation record to find. */
|
|
|
|
FindSchemaRecord (character, character, buffer)
|
/* Helper method to find and position the Service buffer to a given service. Caller must check
availablity themselves.
@param character The service name
@param buffer The Service record to find. */
|
|
|
|
FindServiceRecord (character, buffer)
|
/* Helper method to find and position the Service buffer to a given service. Caller must check
availablity themselves.
@param character The service name
@param buffer The Service record to find. */
|
|
|
|
OpenEdge.Web.DataObject.MappedOperation GetOperation (character, character, MethodEnum)
|
/* Returns details about the operation
@param character The serviceName
@param character The relative URI
@param MethodEnum The HTTP method
@return MappedOperation The operation map for this Method/URI */
|
|
|
|
HANDLE GetSchema (character, character)
|
/* Returns a schema for a given service oepration.
@param character The service name
@param character The schema name
@return handle An empty data structure (TT or PDS) */
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetServiceCatalog (character)
|
/* Returns a catalog for a named service
@param character The service name.
@return JsonObject A JSDO catalog. If no exist or none can be found, return null.
@throws AssertionFailedError If the name is empty or null
@throws AppError If the requested service does not exist in the registry */
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetServiceOptions (character)
|
/* Returns the service options for a named service
@param character The service name.
@return JsonObject A JSDO object containing options. If no exist or none can be
found, return an empty JSON object.
@throws AssertionFailedError If the name is empty or null */
|
|
|
|
INTEGER GetServices (character[])
|
/* Returns all registered service names
@return character extent An array of registered services. indeterminate if none. */
|
|
|
|
LOGICAL HasOperation (character, character, MethodEnum)
|
/* Indicates whether a mapped operation exists
@param character the service name
@param character The relative URI (to the service)
@param MethodEnum The HTTP method
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL HasService (character)
|
/* Indicates whether a named service is available in the registry.
@param character The name of the mapped service
@return logical TRUE if the service exists */
|
|
|
|
LOGICAL LoadFromFile (character, handle)
|
/* Loads a named service from a file
@param character The service name to load
@param handle The FILE-INFO handle for the file
@return logical TRUE if the named service was found */
|
|
|
|
LoadFromFile (handle)
|
/* Loads all services from the file
@param handle The FILE-INFO handle for the file. */
|
|
|
|
LoadOperations (character, JsonObject)
|
/* Converts a JSON map into internal structures
@param character The service name
@param JsonObject The operation map */
|
|
|
|
LoadSchemas (character, JsonObject)
|
/* Converts a JSON map into internal structures
@param character The service name
@param JsonObject The set of schema */
|
|
|
|
PutOperation (character, MappedOperation)
|
/* Adds a new operation map for a service.
@param MethodEnum The HTTP method
@param character The relative URI
@param MappedOperation The operation map for this Method/URI */
|
|
|
|
PutSchema (character, character, handle)
|
/* Saves a schema for a given service
@param character The service name
@param character The schema name
@param handle An empty data structure (TT or PDS) */
|
|
|
|
PutServiceCatalog (character, JsonObject)
|
/* Sets a catalog for a named service
@param character The service name.
@param JsonObject A JSDO catalog. If no exist or none can be found, return null.
@throws AssertionFailedError If the name is empty or null
@throws AppError If the requested service does not exist in the registry */
|
|
|
|
PutServiceOptions (character, JsonObject)
|
/* Sets the service options for a named service
@param character The service name.
@param JsonObject A JSON object containing options.
@throws AssertionFailedError If the name is empty or null
@throws AppError If the requested service does not exist in the registry */
|
|
|
|
RegisterAllFromFolder (character)
|
/* Registers all services found in a given folder. Can be used at agent startup
@param character An extant folder */
|
|
|
|
RegisterFromFile (character)
|
/* Registers all services found in a given file. Can be used at agent startup
@param character An extant file */
|
|
|
|
RegisterFromFile (character, character)
|
/* Registers a named service found in a given file. Can be used at agent startup
@param character A service name
@param character An extant file */
|
|
|
|
RegisterService (character, character, JsonObject, JsonObject, JsonObject)
|
/* Register a service in this handler.
@param character (mandatory) The service name.
@param JsonObject (recommended) An operation map for the service.
@param JsonObject (optional) A catalog for the service. Optional since it may exist on disk */
|
|
|
|
RemoveOperation (character, character, MethodEnum)
|
/* Removes an operation mapping from the collection operation maps.
No-op if none exists.
@param character the service name
@param character The relative URI
@param MethodEnum The HTTP method */
|
|
|
|
RemoveSchema (character, character)
|
/* Removes an operation schema from service
No-op if none exists.
@param character the service name
@param character The schema name */
|
|
|
|
LOGICAL TryFindService (character, character)
|
/* Indicates whether a named service is available. Will attempt to
locate a service map if it is not yet registered, and will register
it if one can be found. The search path for finding the service mapping
files is
1. Look in the webapp's WEB-INF/openedge folder first
2. Look in the instance's /openedge folder next
3. Look in the rest of PROPATH
@param character The name of the mapped service
@param character The name of the webapp currently executed
@return logical TRUE if the service exists */
|