lucee.Componentrelax.APIService
Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- The DSL Service
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
struct
|
APIDefinitions
Storage for API Definitions.
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
any
|
moduleService
|
true
|
false
|
|
boolean
|
sessionsEnabled
Flag that tell us if the underlying application leverages session scope.
|
true
|
false
|
|
struct
|
settings
The relax module's settings.
|
true
|
false
|
|
any
|
templateCache
|
true
|
false
|
|
any
|
wirebox
|
true
|
false
|
Constructor Summary | |
---|---|
init(any settings)
Constructor. |
Method Summary | |
---|---|
APIService
|
clearUserData()
Clears user data. |
any
|
getAPI(any name)
Get an API definition. |
string
|
getAPIDefinitions()
|
string
|
getDefaultAPIName()
Get the name of the default API. |
any
|
getLoadedAPI()
Get the loaded API representation. |
string
|
getLoadedAPIName()
Get the loaded API name. |
string
|
getLog()
|
string
|
getModuleService()
|
string
|
getSessionsEnabled()
|
string
|
getSettings()
|
string
|
getTemplateCache()
|
string
|
getWirebox()
|
private any
|
injectMixin(any name, any UDF)
Injection method. |
private boolean
|
isLegacyAPI(any dataCFC)
Verifies if we have a legacy API or swagger. |
boolean
|
isLoadedAPI()
Checks if an API is loaded or not, usually by checking the user's data. |
query
|
listAPIs()
Get a listing of all the APIs in the resources folder. |
any
|
loadAPI(any name)
Load an API into the service and get its representation. |
private any
|
loadDSLAPI(any dataCFC)
Run Defaults and processing setup on a legacy DSL. |
private any
|
loadOpenAPI(string definitionFile)
Load an open api definition file via the Swagger SDK Parser object. |
private any
|
newResponse()
New response struct for importers. |
struct
|
processAPIImport(struct collection)
Import a relax API. |
APIService
|
processConfiguration(any dataCFC)
Process a relax configure method by injecting our Document. |
any
|
setAPIDefinitions(struct APIDefinitions)
|
any
|
setLog(any log)
|
any
|
setModuleService(any moduleService)
|
any
|
setSessionsEnabled(boolean sessionsEnabled)
|
any
|
setSettings(struct settings)
|
any
|
setTemplateCache(any templateCache)
|
any
|
setWirebox(any wirebox)
|
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
settings
- The relax module settings neededProperty Detail |
---|
Storage for API Definitions
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- logbox:logger:{this}serializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:moduleServiceserializable
- trueFlag that tell us if the underlying application leverages session scope
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe relax module's settings
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- cachebox:templateserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- wireboxserializable
- trueMethod Detail |
---|
Clears user data
Get an API definition
name
- The name of the API to get.Get the name of the default API
Get the loaded API representation
Get the loaded API name
Injection method
name
- Name of functionUDF
- The UDF to injectVerifies if we have a legacy API or swagger
dataCFC
- The CFC instanceChecks if an API is loaded or not, usually by checking the user's data
Get a listing of all the APIs in the resources folder
Load an API into the service and get its representation. This can be a Relax.cfc or a Relax.json representation.
name
- The API to loadRun Defaults and processing setup on a legacy DSL
dataCFC
- The legacy DSLLoad an open api definition file via the Swagger SDK Parser object
definitionFile
- The definition file to loadNew response struct for importers
Import a relax API
collection
- The collection which includes the API name and JSON representationProcess a relax configure method by injecting our Document.cfc methods first
dataCFC
- The data CFC to processAPIDefinitions
log
moduleService
sessionsEnabled
settings
templateCache
wirebox